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

ObjectStorageUserController provides API for object storage user

XSKY os-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 os-users. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 6 operations across 3 paths, and defines 15 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 3 paths 15 schemas 1 DELETE3 GET1 PATCH1 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 os-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 6

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

os-users 6

ObjectStorageUserController provides API for object storage user

GET
/os-users/
List object storage users
ListObjectStorageUsers 4 params → 200500
POST
/os-users/
create object storage user
CreateObjectStorageUser 1 param → 202400500
GET
/os-users/{user_id}
get object storage user
GetObjectStorageUser 1 param → 200404500
DELETE
/os-users/{user_id}
delete object storage user
DeleteObjectStorageUser 1 param → 202404500
PATCH
/os-users/{user_id}
update object storage user
UpdateObjectStorageUser 2 params → 200202400404500
GET
/os-users/{user_id}/samples
get an object storage user's Samples
GetObjectStorageUserSamples 4 params → 200400404500

Schemas 15

The contract defines 15 schemas that model the data the API accepts and returns. The most detailed are ObjectStorageUser (20 properties), ObjectStorageUserStat (16 properties), ObjectStorageUserCreateReq_Info (14 properties), ObjectStorageUserUpdateReq_Info (13 properties). Each schema is shown below with its type and property counts.

ObjectStorageUserStat
object
ObjectStorageUserStat define the object storage user statistics
16 properties
ObjectStorageUserRecord
ObjectStorageUserRecord is used to combine ObjectStorageUser and ObjectStorageUserStat
ObjectStorageUserResp
object
1 property 1 required
ObjectStorageUsersResp
object
1 property 1 required
ObjectStorageUser
object
ObjectStorageUser is the model of objectstorageuser
20 properties
OSUserPropertiesReq
object
6 properties
ObjectStorageUserCreateReq
object
1 property
ObjectStorageUserSamplesResp
object
1 property 1 required
ObjectStorageUserUpdateReq_Info
object
13 properties
ObjectStorageUserUpdateReq
object
1 property
OSUserProperties
object
OSUserProperties contains properties for a os user.
6 properties
ObjectStorageKey
object
ObjectStorageKey defines access key and secret key for object storage
9 properties
ObjectStorageUser_Nestview
object
2 properties
ObjectStorageUserCreateReq_Info
object
14 properties 1 required
ObjectStoragePolicy_Nestview
object
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

xsky-os-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