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 fs-user-groups API

FSUserGroupController provides APIs for file storage user group

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

Tagged areas include fs-user-groups. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 7 operations across 3 paths, and defines 12 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.

7 operations 3 paths 12 schemas 2 DELETE2 GET1 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 fs-user-groups 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 7

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

fs-user-groups 7

FSUserGroupController provides APIs for file storage user group

GET
/fs-user-groups/
List file storage user groups
ListFSUserGroups 6 params → 200500
POST
/fs-user-groups/
Create file storage user group
CreateFSUserGroup 1 param → 201400409500
GET
/fs-user-groups/{fs_user_group_id}
Get file storage user group
GetFSUserGroup 1 param → 200404500
DELETE
/fs-user-groups/{fs_user_group_id}
delete file storage user group
DeleteFSUserGroup 1 param → 204404409500
PATCH
/fs-user-groups/{fs_user_group_id}
Update file storage user group
UpdateFSUserGroup 2 params → 200400404409500
PUT
/fs-user-groups/{fs_user_group_id}/fs-users
add users to file storage user group
AddFSUsers 2 params → 200400404409500
DELETE
/fs-user-groups/{fs_user_group_id}/fs-users
remove users from file storage user group
RemoveFSUsers 2 params → 200400404409500

Schemas 12

The contract defines 12 schemas that model the data the API accepts and returns. The most detailed are FSUserGroup (7 properties), FSUserGroupCreateReq_UserGroup (2 properties), FSUser_Nestview (2 properties), FSUserGroupUpdateReq (1 property). Each schema is shown below with its type and property counts.

FSUserGroupCreateReq_UserGroup
object
2 properties 1 required
FSUserGroupCreateReq
object
1 property 1 required
FSUserGroupRemoveUsersReq_UserGroup
object
1 property
FSUserGroupAddUsersReq_UserGroup
object
1 property
FSUserGroupUpdateReq_UserGroup
object
1 property 1 required
FSUserGroupAddUsersReq
object
1 property 1 required
FSUserGroupResp
object
1 property 1 required
FSUserGroupRemoveUsersReq
object
1 property 1 required
FSUserGroupsResp
object
1 property 1 required
FSUserGroupUpdateReq
object
1 property 1 required
FSUserGroup
object
FSUserGroup defines model of file storage user group
7 properties
FSUser_Nestview
object
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

xsky-fs-user-groups-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