Перейти к основному содержимому
API docs by Redocly

IAM API (v1.0)

Managing control panel users, service users, user groups and S3 keys

Groups

Get list of groups

Authorizations:
X-Auth-Token

Responses

Create group

Authorizations:
X-Auth-Token
Request Body schema: application/json
required

Payload

description
string
name
string

Responses

Request samples

Content type
application/json
{
  • "description": "string",
  • "name": "string"
}

Delete group

Authorizations:
X-Auth-Token
path Parameters
group_id
required
string

group id

Responses

Get group

Authorizations:
X-Auth-Token
path Parameters
group_id
required
string

group id

Responses

Update group name or description

Authorizations:
X-Auth-Token
path Parameters
group_id
required
string

group id

Request Body schema: application/json
required

Payload

description
string
name
string

Responses

Request samples

Content type
application/json
{
  • "description": "string",
  • "name": "string"
}

UnassignRoles

Authorizations:
X-Auth-Token
path Parameters
group_id
required
string

group id

Request Body schema: application/json
required

Payload

Array of objects (models.RoleRequest)
Array
project_id
string
role_name
string
scope
string

Responses

Request samples

Content type
application/json
{
  • "roles": [
    ]
}

AssignRoles

Authorizations:
X-Auth-Token
path Parameters
group_id
required
string

group id

Request Body schema: application/json
required

Payload

Array of objects (models.RoleRequest)
Array
project_id
string
role_name
string
scope
string

Responses

Request samples

Content type
application/json
{
  • "roles": [
    ]
}

Remove users from group

Authorizations:
X-Auth-Token
path Parameters
group_id
required
string

group id

Request Body schema: application/json
required

Payload

keystone_ids
Array of strings

Responses

Request samples

Content type
application/json
{
  • "keystone_ids": [
    ]
}

Add users to group

Authorizations:
X-Auth-Token
path Parameters
group_id
required
string

group id

Request Body schema: application/json
required

Payload

keystone_ids
Array of strings

Responses

Request samples

Content type
application/json
{
  • "keystone_ids": [
    ]
}

Users

Get info about current user.

Authorizations:
X-Auth-Token

Responses

Get list of users

Authorizations:
X-Auth-Token

Responses

Add user to account

Authorizations:
X-Auth-Token
Request Body schema: application/json
required

Payload

auth_type
string (models.UserAuthType)
Enum: "local" "federated"
email
string
object (models.FederationInfo)
group_ids
Array of strings
Array of objects (models.RoleRequest)
subscriptions
Array of strings
subscriptions_only
boolean

Responses

Request samples

Content type
application/json
{
  • "auth_type": "local",
  • "email": "string",
  • "federation": {
    },
  • "group_ids": [
    ],
  • "roles": [
    ],
  • "subscriptions": [
    ],
  • "subscriptions_only": true
}

Delete user from account

Authorizations:
X-Auth-Token
path Parameters
user_id
required
string

user id

Responses

Get info about user

Authorizations:
X-Auth-Token
path Parameters
user_id
required
string

user id

Responses

Access

Authorizations:
X-Auth-Token
path Parameters
user_id
required
string

user id

Request Body schema: application/json
required

Payload

group_ids
Array of strings
Array of objects (models.RoleRequest)

Responses

Request samples

Content type
application/json
{
  • "group_ids": [
    ],
  • "roles": [
    ]
}

RemoveGroups

Authorizations:
X-Auth-Token
path Parameters
user_id
required
string

user id

Request Body schema: application/json
required

Payload

group_ids
Array of strings

Responses

Request samples

Content type
application/json
{
  • "group_ids": [
    ]
}

AddGroups

Authorizations:
X-Auth-Token
path Parameters
user_id
required
string

user id

Request Body schema: application/json
required

Payload

group_ids
Array of strings

Responses

Request samples

Content type
application/json
{
  • "group_ids": [
    ]
}

ResendInvite

Authorizations:
X-Auth-Token
path Parameters
user_id
required
string

user id

Responses

UnassignRoles

Authorizations:
X-Auth-Token
path Parameters
user_id
required
string

user id

Request Body schema: application/json
required

Payload

Array of objects (models.RoleRequest)
Array
project_id
string
role_name
string
scope
string

Responses

Request samples

Content type
application/json
{
  • "roles": [
    ]
}

AssignRoles

Authorizations:
X-Auth-Token
path Parameters
user_id
required
string

user id

Request Body schema: application/json
required

Payload

Array of objects (models.RoleRequest)
Array
project_id
string
role_name
string
scope
string

Responses

Request samples

Content type
application/json
{
  • "roles": [
    ]
}

Projects

Get list of projects

Authorizations:
X-Auth-Token
query Parameters
includeDeleted
boolean

include deleted

includeRoles
boolean

include roles

Responses

Service users

Get list of service users

Authorizations:
X-Auth-Token

Responses

Create service user

Authorizations:
X-Auth-Token
Request Body schema: application/json
required

Payload

enabled
boolean
group_ids
Array of strings
name
string
password
string
Array of objects (models.RoleRequest)

Responses

Request samples

Content type
application/json
{
  • "enabled": true,
  • "group_ids": [
    ],
  • "name": "string",
  • "password": "string",
  • "roles": [
    ]
}

Delete service user from account and also delete user's keypairs

Authorizations:
X-Auth-Token
path Parameters
user_id
required
string

user id

Responses

Get service user

Authorizations:
X-Auth-Token
path Parameters
user_id
required
string

user id

Responses

Update info about user

Authorizations:
X-Auth-Token
path Parameters
user_id
required
string

user id

Request Body schema: application/json
required

Payload

enabled
boolean
name
string
password
string

Responses

Request samples

Content type
application/json
{
  • "enabled": true,
  • "name": "string",
  • "password": "string"
}

RemoveGroups

Authorizations:
X-Auth-Token
path Parameters
user_id
required
string

user id

Request Body schema: application/json
required

Payload

group_ids
Array of strings

Responses

Request samples

Content type
application/json
{
  • "group_ids": [
    ]
}

AddGroups

Authorizations:
X-Auth-Token
path Parameters
user_id
required
string

user id

Request Body schema: application/json
required

Payload

group_ids
Array of strings

Responses

Request samples

Content type
application/json
{
  • "group_ids": [
    ]
}

UnassignRoles

Authorizations:
X-Auth-Token
path Parameters
user_id
required
string

user id

Request Body schema: application/json
required

Payload

Array of objects (models.RoleRequest)
Array
project_id
string
role_name
string
scope
string

Responses

Request samples

Content type
application/json
{
  • "roles": [
    ]
}

AssignRoles

Authorizations:
X-Auth-Token
path Parameters
user_id
required
string

user id

Request Body schema: application/json
required

Payload

Array of objects (models.RoleRequest)
Array
project_id
string
role_name
string
scope
string

Responses

Request samples

Content type
application/json
{
  • "roles": [
    ]
}

Credentials

List S3 credentials for the specified user

Authorizations:
X-Auth-Token
path Parameters
user_id
required
string

user id

Responses

Create S3 credential for the specified user

Authorizations:
X-Auth-Token
path Parameters
user_id
required
string

user id

Request Body schema: application/json
required

Payload

name
string
project_id
string

Responses

Request samples

Content type
application/json
{
  • "name": "cred_name",
  • "project_id": "f9a2a75fd6a74d658c211ced448dd149"
}

Delete S3 credential for the specified user

Authorizations:
X-Auth-Token
path Parameters
user_id
required
string

user id

access_key
required
string

access key

Responses