Users
Authentication token obtained from the authentication service
Filter by domain ID
Filter by enabled status
Filter by user name
Filter by password expiration
Filter by unique name
Requests a page size of items
The ID of the last-seen item for pagination
A valid authentication token
Users listed successfully
Some content in the request was invalid
User must authenticate before making a request
Policy does not allow current user to do this operation
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": "2026-01-01T00:00:00.000Z",
"options": {},
"links": {
"self": "text",
"previous": "text",
"next": "text"
}
}
],
"links": {
"self": "text",
"previous": "text",
"next": "text"
}
}Authentication token obtained from the authentication service
A valid authentication token
User created successfully
Some content in the request was invalid
User must authenticate before making a request
Policy does not allow current user to do this operation
This operation conflicted with another operation on this resource
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": "2026-01-01T00:00:00.000Z",
"options": {},
"links": {
"self": "text",
"previous": "text",
"next": "text"
}
}
}Authentication token obtained from the authentication service
The user ID
A valid authentication token
User details retrieved successfully
Some content in the request was invalid
User must authenticate before making a request
Policy does not allow current user to do this operation
The requested resource could not be found
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": "2026-01-01T00:00:00.000Z",
"options": {},
"links": {
"self": "text",
"previous": "text",
"next": "text"
}
}
}Authentication token obtained from the authentication service
The user ID
A valid authentication token
User deleted successfully
No content
Some content in the request was invalid
User must authenticate before making a request
Policy does not allow current user to do this operation
The requested resource could not be found
DELETE /keystone/v3/users/{user_id} HTTP/1.1
Host: example.platform9.com
X-Auth-Token: text
Accept: */*
No content
Authentication token obtained from the authentication service
The user ID
A valid authentication token
User updated successfully
Some content in the request was invalid
User must authenticate before making a request
Policy does not allow current user to do this operation
The requested resource could not be found
This operation conflicted with another operation on this resource
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": "2026-01-01T00:00:00.000Z",
"options": {},
"links": {
"self": "text",
"previous": "text",
"next": "text"
}
}
}Authentication token obtained from the authentication service
The user ID
Requests a page size of items
The ID of the last-seen item for pagination
A valid authentication token
User groups listed successfully
Some content in the request was invalid
User must authenticate before making a request
Policy does not allow current user to do this operation
The requested resource could not be found
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"
}
}Authentication token obtained from the authentication service
The user ID
Requests a page size of items
The ID of the last-seen item for pagination
A valid authentication token
User tenants listed successfully
Some content in the request was invalid
User must authenticate before making a request
Policy does not allow current user to do this operation
The requested resource could not be found
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"
}
}Authentication token obtained from the authentication service
The user ID
A valid authentication token
Password changed successfully
No content
Some content in the request was invalid
User must authenticate before making a request
Policy does not allow current user to do this operation
The requested resource could not be found
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
Last updated
Was this helpful?