Users

User management operations

List users

get

Lists users

Authorizations

ApiKeyAuth

X-Auth-TokenstringRequired

Authentication token obtained from the authentication service

Query parameters

domain_idstringOptional

Filter by domain ID

enabledbooleanOptional

Filter by enabled status

namestringOptional

Filter by user name

password_expires_atstringOptional

Filter by password expiration

unique_namestringOptional

Filter by unique name

limitinteger · min: 1Optional

Requests a page size of items

markerstringOptional

The ID of the last-seen item for pagination

Header parameters

X-Auth-TokenstringRequired

A valid authentication token

Responses

200

Users listed successfully

application/json

400

Some content in the request was invalid

application/json

401

User must authenticate before making a request

application/json

403

Policy does not allow current user to do this operation

application/json

get

/users

HTTPcURLJavaScriptPython

GET /keystone/v3/users HTTP/1.1
Host: example.platform9.com
X-Auth-Token: text
Accept: */*

{
  "users": [
    {
      "id": "text",
      "name": "text",
      "description": "text",
      "enabled": true,
      "domain_id": "text",
      "domain": {
        "id": "text",
        "name": "text",
        "description": "text",
        "enabled": true,
        "links": {
          "self": "text",
          "previous": "text",
          "next": "text"
        },
        "options": {}
      },
      "default_project_id": "text",
      "email": "text",
      "password_expires_at": "2025-12-19T16:21:42.158Z",
      "options": {},
      "links": {
        "self": "text",
        "previous": "text",
        "next": "text"
      }
    }
  ],
  "links": {
    "self": "text",
    "previous": "text",
    "next": "text"
  }
}

Create user

post

Creates a user

Authorizations

ApiKeyAuth

X-Auth-TokenstringRequired

Authentication token obtained from the authentication service

Header parameters

X-Auth-TokenstringRequired

A valid authentication token

Body

application/json

Responses

201

User created successfully

application/json

400

Some content in the request was invalid

application/json

401

User must authenticate before making a request

application/json

403

Policy does not allow current user to do this operation

application/json

409

This operation conflicted with another operation on this resource

application/json

post

/users

HTTPcURLJavaScriptPython

POST /keystone/v3/users HTTP/1.1
Host: example.platform9.com
X-Auth-Token: text
Content-Type: application/json
Accept: */*
Content-Length: 153

{
  "user": {
    "name": "text",
    "description": "text",
    "enabled": true,
    "domain_id": "text",
    "default_project_id": "text",
    "email": "text",
    "password": "text",
    "options": {}
  }
}

{
  "user": {
    "id": "text",
    "name": "text",
    "description": "text",
    "enabled": true,
    "domain_id": "text",
    "domain": {
      "id": "text",
      "name": "text",
      "description": "text",
      "enabled": true,
      "links": {
        "self": "text",
        "previous": "text",
        "next": "text"
      },
      "options": {}
    },
    "default_project_id": "text",
    "email": "text",
    "password_expires_at": "2025-12-19T16:21:42.158Z",
    "options": {},
    "links": {
      "self": "text",
      "previous": "text",
      "next": "text"
    }
  }
}

Show user details

get

Shows details for a user

Authorizations

ApiKeyAuth

X-Auth-TokenstringRequired

Authentication token obtained from the authentication service

Path parameters

user_idstringRequired

The user ID

Header parameters

X-Auth-TokenstringRequired

A valid authentication token

Responses

200

User details retrieved successfully

application/json

400

Some content in the request was invalid

application/json

401

User must authenticate before making a request

application/json

403

Policy does not allow current user to do this operation

application/json

404

The requested resource could not be found

application/json

get

/users/{user_id}

HTTPcURLJavaScriptPython

GET /keystone/v3/users/{user_id} HTTP/1.1
Host: example.platform9.com
X-Auth-Token: text
Accept: */*

{
  "user": {
    "id": "text",
    "name": "text",
    "description": "text",
    "enabled": true,
    "domain_id": "text",
    "domain": {
      "id": "text",
      "name": "text",
      "description": "text",
      "enabled": true,
      "links": {
        "self": "text",
        "previous": "text",
        "next": "text"
      },
      "options": {}
    },
    "default_project_id": "text",
    "email": "text",
    "password_expires_at": "2025-12-19T16:21:42.158Z",
    "options": {},
    "links": {
      "self": "text",
      "previous": "text",
      "next": "text"
    }
  }
}

Delete user

delete

Deletes a user

Authorizations

ApiKeyAuth

X-Auth-TokenstringRequired

Authentication token obtained from the authentication service

Path parameters

user_idstringRequired

The user ID

Header parameters

X-Auth-TokenstringRequired

A valid authentication token

Responses

204

User deleted successfully

400

Some content in the request was invalid

application/json

401

User must authenticate before making a request

application/json

403

Policy does not allow current user to do this operation

application/json

404

The requested resource could not be found

application/json

delete

/users/{user_id}

HTTPcURLJavaScriptPython

DELETE /keystone/v3/users/{user_id} HTTP/1.1
Host: example.platform9.com
X-Auth-Token: text
Accept: */*

No content

Update user

patch

Updates a user

Authorizations

ApiKeyAuth

X-Auth-TokenstringRequired

Authentication token obtained from the authentication service

Path parameters

user_idstringRequired

The user ID

Header parameters

X-Auth-TokenstringRequired

A valid authentication token

Body

application/json

Responses

200

User updated successfully

application/json

400

Some content in the request was invalid

application/json

401

User must authenticate before making a request

application/json

403

Policy does not allow current user to do this operation

application/json

404

The requested resource could not be found

application/json

409

This operation conflicted with another operation on this resource

application/json

patch

/users/{user_id}

HTTPcURLJavaScriptPython

PATCH /keystone/v3/users/{user_id} HTTP/1.1
Host: example.platform9.com
X-Auth-Token: text
Content-Type: application/json
Accept: */*
Content-Length: 153

{
  "user": {
    "name": "text",
    "description": "text",
    "enabled": true,
    "domain_id": "text",
    "default_project_id": "text",
    "email": "text",
    "password": "text",
    "options": {}
  }
}

{
  "user": {
    "id": "text",
    "name": "text",
    "description": "text",
    "enabled": true,
    "domain_id": "text",
    "domain": {
      "id": "text",
      "name": "text",
      "description": "text",
      "enabled": true,
      "links": {
        "self": "text",
        "previous": "text",
        "next": "text"
      },
      "options": {}
    },
    "default_project_id": "text",
    "email": "text",
    "password_expires_at": "2025-12-19T16:21:42.158Z",
    "options": {},
    "links": {
      "self": "text",
      "previous": "text",
      "next": "text"
    }
  }
}

List user groups

get

Lists groups to which a user belongs

Authorizations

ApiKeyAuth

X-Auth-TokenstringRequired

Authentication token obtained from the authentication service

Path parameters

user_idstringRequired

The user ID

Query parameters

limitinteger · min: 1Optional

Requests a page size of items

markerstringOptional

The ID of the last-seen item for pagination

Header parameters

X-Auth-TokenstringRequired

A valid authentication token

Responses

200

User groups listed successfully

application/json

400

Some content in the request was invalid

application/json

401

User must authenticate before making a request

application/json

403

Policy does not allow current user to do this operation

application/json

404

The requested resource could not be found

application/json

get

/users/{user_id}/groups

HTTPcURLJavaScriptPython

GET /keystone/v3/users/{user_id}/groups HTTP/1.1
Host: example.platform9.com
X-Auth-Token: text
Accept: */*

{
  "groups": [
    {
      "id": "text",
      "name": "text",
      "description": "text",
      "domain_id": "text",
      "domain": {
        "id": "text",
        "name": "text",
        "description": "text",
        "enabled": true,
        "links": {
          "self": "text",
          "previous": "text",
          "next": "text"
        },
        "options": {}
      },
      "links": {
        "self": "text",
        "previous": "text",
        "next": "text"
      }
    }
  ],
  "links": {
    "self": "text",
    "previous": "text",
    "next": "text"
  }
}

List user tenants

get

Lists tenants for a user

Authorizations

ApiKeyAuth

X-Auth-TokenstringRequired

Authentication token obtained from the authentication service

Path parameters

user_idstringRequired

The user ID

Query parameters

limitinteger · min: 1Optional

Requests a page size of items

markerstringOptional

The ID of the last-seen item for pagination

Header parameters

X-Auth-TokenstringRequired

A valid authentication token

Responses

200

User tenants listed successfully

application/json

400

Some content in the request was invalid

application/json

401

User must authenticate before making a request

application/json

403

Policy does not allow current user to do this operation

application/json

404

The requested resource could not be found

application/json

get

/users/{user_id}/projects

HTTPcURLJavaScriptPython

GET /keystone/v3/users/{user_id}/projects HTTP/1.1
Host: example.platform9.com
X-Auth-Token: text
Accept: */*

{
  "projects": [
    {
      "id": "text",
      "name": "text",
      "description": "text",
      "enabled": true,
      "domain_id": "text",
      "domain": {
        "id": "text",
        "name": "text",
        "description": "text",
        "enabled": true,
        "links": {
          "self": "text",
          "previous": "text",
          "next": "text"
        },
        "options": {}
      },
      "parent_id": "text",
      "is_domain": true,
      "tags": [
        "text"
      ],
      "options": {},
      "links": {
        "self": "text",
        "previous": "text",
        "next": "text"
      }
    }
  ],
  "links": {
    "self": "text",
    "previous": "text",
    "next": "text"
  }
}

Change user password

post

Changes the password for a user

Authorizations

ApiKeyAuth

X-Auth-TokenstringRequired

Authentication token obtained from the authentication service

Path parameters

user_idstringRequired

The user ID

Header parameters

X-Auth-TokenstringRequired

A valid authentication token

Body

application/json

Responses

204

Password changed successfully

400

Some content in the request was invalid

application/json

401

User must authenticate before making a request

application/json

403

Policy does not allow current user to do this operation

application/json

404

The requested resource could not be found

application/json

post

/users/{user_id}/password

HTTPcURLJavaScriptPython

POST /keystone/v3/users/{user_id}/password HTTP/1.1
Host: example.platform9.com
X-Auth-Token: text
Content-Type: application/json
Accept: */*
Content-Length: 55

{
  "user": {
    "password": "text",
    "original_password": "text"
  }
}

No content