Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

XSKY auth API

AuthController Manage authentication and authorization

XSKY auth API is one of 124 APIs that XSKY publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include auth. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 6 operations across 5 paths, and defines 19 schemas. It is described by OpenAPI 2.0, at version SDS_4.2.000.0.200302.

Requests are made against the base URL https://{xms-controller}/v1.

6 operations 5 paths 19 schemas 1 GET1 PATCH4 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 2.0
API Version
SDS_4.2.000.0.200302
Base URL
https://{xms-controller}/v1
Authentication
API Key, API Key
License
Commercial
Resource Areas
1

Authentication & Security 2

XSKY auth API declares 2 security schemes for authenticating requests. An API key is passed in the header as Xms-Auth-Token (tokenInHeader). An API key is passed in the query as token (tokenInQuery).

  • tokenInHeader — auth by token
  • tokenInQuery — auth by token

Paths & Operations 6

Across 5 paths, the API surfaces 6 operations — 1 GET, 1 PATCH, 4 POST. Each is listed below with its method, path, parameters, and response codes.

auth 6

AuthController Manage authentication and authorization

POST
/auth/rsa-keys
Create RSA key
CreateRSAKey → 200400401500
GET
/auth/security-policy
setup auth security policy
GetAuthSecurityPolicy → 200400500
PATCH
/auth/security-policy
update auth security policy
UpdateAuthSecurityPolicy 1 param → 200400500
POST
/auth/tokens
creates temporary token for credentials
CreateToken 1 param → 201400401500
POST
/auth/tokens:login
logs in
Login 1 param → 201400401500
POST
/auth/tokens:logout
logs out
Logout → 204400401404500

Schemas 19

The contract defines 19 schemas that model the data the API accepts and returns. The most detailed are User (9 properties), AuthLoginReq_Auth (8 properties), AuthSecurityPolicyUpdateReq_AuthSecurityPolicy (5 properties), AuthSecurityPolicy (5 properties). Each schema is shown below with its type and property counts.

AuthLoginReq_Auth
object
8 properties
User
object
9 properties
AuthPasswordReq
object
1 property 1 required
AuthSecurityPolicyResp
object
1 property
IdentityPlatform_Nestview
object
2 properties
Token
object
An access token contains the security information for a logon session. The system creates an access token when a user logs on, and every process executed on be…
5 properties
AuthTokenReq
object
1 property 1 required
AuthRSAKeyResp
object
1 property
TokenCreateReq
object
1 property 1 required
AuthLoginReq
object
1 property 1 required
TokenRecord
TokenRecord defines token record for api response
AuthRSAKey
object
3 properties
AuthPasswordReq_User
object
4 properties 1 required
AuthSecurityPolicy
object
AuthSecurityPolicy defines auth security policy
5 properties
AuthSecurityPolicyUpdateReq
object
1 property
TokenCreateReq_Auth
object
1 property 1 required
TokenCreateReq_Auth_Identity
object
2 properties
AuthSecurityPolicyUpdateReq_AuthSecurityPolicy
object
5 properties
TokenResp
object
1 property 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

xsky-auth-api-openapi.yml Raw ↑

Other APIs XSKY publishes across the network.

XSKY access-paths API
XSKY access-tokens API
XSKY action-logs API
XSKY alert-groups API
XSKY alert-rules API
XSKY alerts API
XSKY block-snapshots API
XSKY block-volume-group-snapshots API
XSKY block-volume-groups API
XSKY block-volume-migration-jobs API
XSKY block-volumes API
XSKY chunks API