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 users API

UserController Manage users

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

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

This API exposes 8 operations across 4 paths, and defines 14 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.

8 operations 4 paths 14 schemas 1 DELETE3 GET2 PATCH1 POST1 PUT

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 users 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 8

Across 4 paths, the API surfaces 8 operations — 1 DELETE, 3 GET, 2 PATCH, 1 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

users 8

UserController Manage users

GET
/users/
List users
ListUsers 5 params → 200500
POST
/users/
create user
CreateUser 1 param → 201400500
GET
/users/{user_id}
get a user
GetUser 1 param → 200404500
DELETE
/users/{user_id}
delete user
DeleteUser 1 param → 204404500
PATCH
/users/{user_id}
update user info
UpdateUser 2 params → 200400404500
PUT
/users/{user_id}/password
change user password
ChangePassword 2 params → 204400500
GET
/users/{user_id}/settings
update user info
GetUserSettings 1 param → 200400403404500
PATCH
/users/{user_id}/settings
update user info
UpdateUserSettings 2 params → 200400403404500

Schemas 14

The contract defines 14 schemas that model the data the API accepts and returns. The most detailed are User (9 properties), ChangePasswordReq_Req (5 properties), UserCreateReq_User (5 properties), UserUpdateReq_User (4 properties). Each schema is shown below with its type and property counts.

UserCreateReq_User
object
5 properties 4 required
UserSettings
object
1 property 1 required
ChangePasswordReq_Req
object
5 properties 2 required
UserSettings_User_Settings
object
1 property
User
object
9 properties
UserResp
object
1 property 1 required
UserUpdateReq
object
1 property 1 required
UserSettings_User
object
1 property 1 required
UsersResp
object
1 property 1 required
UserUpdateReq_User
object
4 properties 3 required
IdentityPlatform_Nestview
object
2 properties
UserCreateReq
object
1 property 1 required
UserRecord
UserRecord defines user record for api response
ChangePasswordReq
object
1 property 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

xsky-users-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 auth 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