Supports create, read, update, and delete (CRUD) operations for roles, and services. Requires administrator privileges.
Enables or disables a user.
Normal response codes: 200 Error response codes: 413,415,405,404,403,401,400,503,409
Name | In | Type | Description |
---|---|---|---|
user_id | path | string | The user ID. |
enabled | body | boolean | Indicates whether the user should be enabled (true )
or disabled(false ). |
{
"user": {
"enabled": true
}
}
Name | In | Type | Description |
---|---|---|---|
user | body | string | The user object. |
body | string | The user email. | |
enabled | body | boolean | Indicates whether the user should be enabled (true )
or disabled(false ). |
id | body | string | The user ID. |
name | body | string | The user in-real-life name. |
username | body | string | The user in-real-life name. |
tenantId | body | string | The tenant ID. |
{
"user": {
"id": "3c9530e",
"name": "admin",
"email": "[email protected]",
"username": "admin",
"enabled": true,
"tenantId": "1ca8e0"
}
}
Sets a user’s password
Normal response codes: 200 Error response codes: 413,415,405,404,403,401,400,503,409
Name | In | Type | Description |
---|---|---|---|
user_id | path | string | The user ID. |
password | body | string | User’s new password |
{
"user": {
"password": "new_password"
}
}
Name | In | Type | Description |
---|---|---|---|
user | body | string | The user object. |
enabled | body | boolean | Indicates whether the user should be enabled (true )
or disabled(false ). |
body | string | The user email. | |
name | body | string | The user in-real-life name. |
username | body | string | The user in-real-life name. |
id | body | string | The user ID. |
tenantId | body | string | The tenant ID. |
{
"user": {
"id": "3c9530e",
"name": "admin",
"email": "[email protected]",
"username": "admin",
"enabled": true,
"tenantId": "1ca8e0"
}
}
Sets a user’s tenant
Normal response codes: 200
Error response codes: 413, 415, 405, 404, 403, 401, 400, 503, 409
Name | In | Type | Description |
---|---|---|---|
user_id | path | string | The user ID. |
tenantId | body | string | The tenant ID. |
{
"user": {
"tenantId": "1ca8e0"
}
}
Name | In | Type | Description |
---|---|---|---|
user | body | string | The user object. |
body | string | The user email. | |
enabled | body | boolean | Indicates whether the user should be enabled (true )
or disabled(false ). |
tenant | body | string | The tenant ID. |
id | body | string | The user ID. |
name | body | string | The user in-real-life name. |
username | body | string | The user in-real-life name. |
tenantId | body | string | The tenant ID. |
{
"user": {
"id": "3c9530e",
"name": "admin",
"email": "[email protected]",
"username": "admin",
"enabled": true,
"tenantId": "1ca8e0"
}
}
Creates a service.
Normal response codes: 201 Error response codes: 413,415,405,404,403,401,400,503,409
{
"OS-KSADM:service": {
"id": "123",
"name": "nova",
"type": "compute",
"description": "OpenStack Compute Service"
}
}
Name | In | Type | Description |
---|---|---|---|
Location (Optional) | header | string | |
type | body | string | The type of the service. |
description | body | string | Description about the service. |
name | body | string | The service name. |
id | body | string | The ID of the service. |
Lists all services.
Normal response codes: 200,203 Error response codes: 413,405,404,403,401,400,503
Name | In | Type | Description |
---|---|---|---|
type | body | string | The type of the service. |
description | body | string | Description about the service. |
name | body | string | The service name. |
id | body | string | The ID of the service. |
{
"OS-KSADM:services": [
{
"id": "123",
"name": "nova",
"type": "compute",
"description": "OpenStack Compute Service"
},
{
"id": "234",
"name": "glance",
"type": "image",
"description": "OpenStack Image Service"
}
],
"OS-KSADM:services_links": []
}
Shows information for a service, by ID.
Normal response codes: 200,203 Error response codes: 413,405,404,403,401,400,503
Name | In | Type | Description |
---|---|---|---|
service_id | path | string | The service ID. |
Name | In | Type | Description |
---|---|---|---|
type | body | string | The type of the service. |
description | body | string | Description about the service. |
name | body | string | The service name. |
id | body | string | The ID of the service. |
{
"OS-KSADM:service": {
"id": "123",
"name": "nova",
"type": "compute",
"description": "OpenStack Compute Service"
}
}
Shows information for a service, by name.
Normal response codes: 200,203 Error response codes: 413,405,404,403,401,400,503
Name | In | Type | Description |
---|---|---|---|
serviceName | path | string | The service name. |
type | body | string | The type of the service. |
description | body | string | Description about the service. |
name | body | string | The service name. |
id | body | string | The ID of the service. |
{
"OS-KSADM:service": {
"id": "123",
"name": "nova",
"type": "compute",
"description": "OpenStack Compute Service"
}
}
Deletes a service.
Normal response codes: 204 Error response codes: 413,415,405,404,403,401,400,503,409
Name | In | Type | Description |
---|---|---|---|
service_id | path | string | The service ID. |
Creates a role.
Normal response codes: 201 Error response codes: 413,415,405,404,403,401,400,503,409
{
"role": {
"id": "123",
"name": "Guest",
"description": "Guest Access"
}
}
Name | In | Type | Description |
---|---|---|---|
Location (Optional) | header | string |
Lists all roles.
Normal response codes: 200,203 Error response codes: 413,405,404,403,401,400,503
Name | In | Type | Description |
---|---|---|---|
role_links | body | object | Role links. |
roles | body | string | A roles object. |
description | body | string | The role description. |
name | body | string | The role name. |
id | body | integer | The role ID. |
{
"roles": [
{
"id": "123",
"name": "compute:admin",
"description": "Nova Administrator"
}
],
"roles_links": []
}
Shows details for a role.
Normal response codes: 200,203 Error response codes: 413,415,405,404,403,401,400,503,409
Name | In | Type | Description |
---|---|---|---|
role_id | path | string | The role ID. |
Name | In | Type | Description |
---|---|---|---|
Location (Optional) | header | string | |
description | body | string | The role description. |
name | body | string | The role name. |
id | body | integer | The role ID. |
{
"role": {
"id": "123",
"name": "Guest",
"description": "Guest Access"
}
}
Shows information for a role, by name.
Normal response codes: 200,203 Error response codes: 413,415,405,404,403,401,400,503,409
Name | In | Type | Description |
---|---|---|---|
Location (Optional) | header | string | |
role_name | path | string | The role name. |
description | body | string | The role description. |
name | body | string | The role name. |
id | body | integer | The role ID. |
{
"role": {
"id": "123",
"name": "Guest",
"description": "Guest Access"
}
}
Deletes a role.
Normal response codes: 204 Error response codes: 413,415,405,404,403,401,400,503,409
Name | In | Type | Description |
---|---|---|---|
role_id | path | string | The role ID. |
Grants a role to a user for a tenant.
Normal response codes: 201 Error response codes: 413,415,405,404,403,401,400,503,409
Name | In | Type | Description |
---|---|---|---|
user_id | path | string | The user ID. |
role_id | path | string | The role ID. |
tenant_id | path | string | The tenant ID. |
Revokes a role from a user for a tenant.
Normal response codes: 204 Error response codes: 413,415,405,404,403,401,400,503,409
Name | In | Type | Description |
---|---|---|---|
user_id | path | string | The user ID. |
role_id | path | string | The role ID. |
tenant_id | path | string | The tenant ID. |
Supports Amazon Elastic Compute (EC2) style authentication.
Grants a credential to a user.
Normal response codes: 201
Error response codes: 413,415,405,404,403,401,400,503,409,
Name | In | Type | Description |
---|---|---|---|
userId | path | string | The user ID. |
{
"OS-KSEC2-ec2Credentials": {
"username": "test_user",
"secret": "secretsecret",
"signature": "bbb"
}
}
Lists credentials.
Normal response codes: 200
Error response codes: 413,405,404,403,401,400,503,
Name | In | Type | Description |
---|---|---|---|
userId | path | string | The user ID. |
{
"credentials": [
{
"passwordCredentials": {
"username": "test_user",
"password": "secretsecret"
}
},
{
"OS-KSEC2-ec2Credentials": {
"username": "test_user",
"secret": "secretsecret",
"signature": "bbb"
}
}
],
"credentials_links": []
}
Updates credentials for a user.
Normal response codes: 200
Error response codes: 415,405,404,403,401,400,503,409,
Name | In | Type | Description |
---|---|---|---|
userId | path | string | The user ID. |
{
"OS-KSEC2-ec2Credentials": {
"username": "test_user",
"secret": "secretsecret",
"signature": "bbb"
}
}
{
"OS-KSEC2-ec2Credentials": {
"username": "test_user",
"secret": "secretsecret",
"signature": "bbb"
}
}
Deletes user credentials.
Normal response codes: 204
Error response codes: 413,415,405,404,403,401,400,503,409,
Name | In | Type | Description |
---|---|---|---|
userId | path | string | The user ID. |
Gets user credentials.
Normal response codes: 200
Error response codes: 413,405,404,403,401,400,503,
Name | In | Type | Description |
---|---|---|---|
userId | path | string | The user ID. |
{
"OS-KSEC2-ec2Credentials": {
"username": "test_user",
"secret": "secretsecret",
"signature": "bbb"
}
}
Lists credentials by type.
Normal response codes: 200
Error response codes: 413,405,404,403,401,400,503,
Name | In | Type | Description |
---|---|---|---|
userId | path | string | The user ID. |
type | path | string | The credential type. |
{
"credentials": [
{
"passwordCredentials": {
"username": "test_user",
"password": "secretsecret"
}
}
],
"credentials_links": []
}
Supports password changing for a user by themselves
Changes user’s own password and returns the new token
Normal response codes: 200
Name | In | Type | Description |
---|---|---|---|
userId | path | string | The user ID. |
user | body | string | The user object. |
original_password | body | string | User’s old password |
password | body | string | User’s new password |
Except where otherwise noted, this document is licensed under Creative Commons Attribution 3.0 License. See all OpenStack Legal Documents.