openstack
/
keystone
Code Issues Proposed changes

Merge "[api] add relationship links to v3"

This commit is contained in:
Jenkins 2016-08-12 20:26:53 +00:00 committed by Gerrit Code Review
parent 0c78293216 d36e555788
commit 1fff127d04
11 changed files with 194 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

22
api-ref/source/v3/authenticate-v3.inc
View File

@ -90,6 +90,8 @@ Password authentication with unscoped authorization
.. rest_method:: POST /v3/auth/tokens .. rest_method:: POST /v3/auth/tokens
Relationship: ``http://docs.openstack.org/api/openstack-identity/3/rel/auth_tokens``
Authenticates an identity and generates a token. Uses the password authentication method. Authorization is unscoped. Authenticates an identity and generates a token. Uses the password authentication method. Authorization is unscoped.
The request body must include a payload that specifies the The request body must include a payload that specifies the
@ -143,6 +145,8 @@ Password authentication with scoped authorization
.. rest_method:: POST /v3/auth/tokens .. rest_method:: POST /v3/auth/tokens
Relationship: ``http://docs.openstack.org/api/openstack-identity/3/rel/auth_tokens``
Authenticates an identity and generates a token. Uses the password authentication method and scopes authorization to a project or domain. Authenticates an identity and generates a token. Uses the password authentication method and scopes authorization to a project or domain.
The request body must include a payload that specifies the The request body must include a payload that specifies the
@ -205,6 +209,8 @@ Password authentication with explicit unscoped authorization
.. rest_method:: POST /v3/auth/tokens .. rest_method:: POST /v3/auth/tokens
Relationship: ``http://docs.openstack.org/api/openstack-identity/3/rel/auth_tokens``
Authenticates an identity and generates a token. Uses the password authentication method with explicit unscoped authorization. Authenticates an identity and generates a token. Uses the password authentication method with explicit unscoped authorization.
The request body must include a payload that specifies the The request body must include a payload that specifies the
@ -259,6 +265,8 @@ Token authentication with unscoped authorization
.. rest_method:: POST /v3/auth/tokens .. rest_method:: POST /v3/auth/tokens
Relationship: ``http://docs.openstack.org/api/openstack-identity/3/rel/auth_tokens``
Authenticates an identity and generates a token. Uses the token authentication method. Authorization is unscoped. Authenticates an identity and generates a token. Uses the token authentication method. Authorization is unscoped.
In the request body, provide the token ID. In the request body, provide the token ID.
@ -298,6 +306,8 @@ Token authentication with scoped authorization
.. rest_method:: POST /v3/auth/tokens .. rest_method:: POST /v3/auth/tokens
Relationship: ``http://docs.openstack.org/api/openstack-identity/3/rel/auth_tokens``
Authenticates an identity and generates a token. Uses the token authentication method and scopes authorization to a project or domain. Authenticates an identity and generates a token. Uses the token authentication method and scopes authorization to a project or domain.
In the request body, provide the token ID and the ``project`` or In the request body, provide the token ID and the ``project`` or
@ -340,6 +350,8 @@ Validate and show information for token
.. rest_method:: GET /v3/auth/tokens .. rest_method:: GET /v3/auth/tokens
Relationship: ``http://docs.openstack.org/api/openstack-identity/3/rel/auth_tokens``
Validates and shows information for a token, including its expiration date and authorization scope. Validates and shows information for a token, including its expiration date and authorization scope.
Pass your own token in the ``X-Auth-Token`` request header. Pass your own token in the ``X-Auth-Token`` request header.
@ -393,6 +405,8 @@ Check token
.. rest_method:: HEAD /v3/auth/tokens .. rest_method:: HEAD /v3/auth/tokens
Relationship: ``http://docs.openstack.org/api/openstack-identity/3/rel/auth_tokens``
Validates a token. Validates a token.
This call is similar to ``GET /auth/tokens`` but no response body This call is similar to ``GET /auth/tokens`` but no response body
@ -421,6 +435,8 @@ Revoke token
.. rest_method:: DELETE /v3/auth/tokens .. rest_method:: DELETE /v3/auth/tokens
Relationship: ``http://docs.openstack.org/api/openstack-identity/3/rel/auth_tokens``
Revokes a token. Revokes a token.
This call is similar to the HEAD ``/auth/tokens`` call except that This call is similar to the HEAD ``/auth/tokens`` call except that
@ -445,6 +461,8 @@ Get service catalog
.. rest_method:: GET /v3/auth/catalog .. rest_method:: GET /v3/auth/catalog
Relationship: ``http://docs.openstack.org/api/openstack-identity/3/rel/auth_catalog``
New in version 3.3 New in version 3.3
This call returns a service catalog for the X-Auth-Token provided in the This call returns a service catalog for the X-Auth-Token provided in the
@ -486,6 +504,8 @@ Get available project scopes
.. rest_method:: GET /v3/auth/projects .. rest_method:: GET /v3/auth/projects
Relationship: ``http://docs.openstack.org/api/openstack-identity/3/rel/auth_projects``
New in version 3.3 New in version 3.3
This call returns the list of projects that are available to be scoped This call returns the list of projects that are available to be scoped
@ -528,6 +548,8 @@ Get available domain scopes
.. rest_method:: GET /v3/auth/domains .. rest_method:: GET /v3/auth/domains
Relationship: ``http://docs.openstack.org/api/openstack-identity/3/rel/auth_domains``
New in version 3.3 New in version 3.3
This call returns the list of domains that are available to be scoped This call returns the list of domains that are available to be scoped

10
api-ref/source/v3/credentials.inc
View File

@ -18,6 +18,8 @@ Create credential
.. rest_method:: POST /v3/credentials .. rest_method:: POST /v3/credentials
Relationship: ``http://docs.openstack.org/api/openstack-identity/3/rel/credentials``
Creates a credential. Creates a credential.
The following example shows how to create an EC2-style credential. The following example shows how to create an EC2-style credential.
@ -66,6 +68,8 @@ List credentials
.. rest_method:: GET /v3/credentials .. rest_method:: GET /v3/credentials
Relationship: ``http://docs.openstack.org/api/openstack-identity/3/rel/credentials``
Lists all credentials. Lists all credentials.
Optionally, you can include the ``user_id`` query parameter in the Optionally, you can include the ``user_id`` query parameter in the
@ -106,6 +110,8 @@ Show credential details
.. rest_method:: GET /v3/credentials/{credential_id} .. rest_method:: GET /v3/credentials/{credential_id}
Relationship: ``http://docs.openstack.org/api/openstack-identity/3/rel/credential``
Shows details for a credential. Shows details for a credential.
Normal response codes: 200 Normal response codes: 200
@ -143,6 +149,8 @@ Update credential
.. rest_method:: PATCH /v3/credentials/{credential_id} .. rest_method:: PATCH /v3/credentials/{credential_id}
Relationship: ``http://docs.openstack.org/api/openstack-identity/3/rel/credential``
Updates a credential. Updates a credential.
Normal response codes: 200 Normal response codes: 200
@ -191,6 +199,8 @@ Delete credential
.. rest_method:: DELETE /v3/credentials/{credential_id} .. rest_method:: DELETE /v3/credentials/{credential_id}
Relationship: ``http://docs.openstack.org/api/openstack-identity/3/rel/credential``
Deletes a credential. Deletes a credential.
Normal response codes: 204 Normal response codes: 204

20
api-ref/source/v3/domains-config-v3.inc
View File

@ -40,6 +40,8 @@ Show domain group option configuration
.. rest_method:: GET /v3/domains/{domain_id}/config/{group}/{option} .. rest_method:: GET /v3/domains/{domain_id}/config/{group}/{option}
Relationship: ``http://docs.openstack.org/api/openstack-identity/3/rel/domain_config_default``
Shows details for a domain group option configuration. Shows details for a domain group option configuration.
The API supports only the ``identity`` and ``ldap`` groups. For the The API supports only the ``identity`` and ``ldap`` groups. For the
@ -82,6 +84,8 @@ Update domain group option configuration
.. rest_method:: PATCH /v3/domains/{domain_id}/config/{group}/{option} .. rest_method:: PATCH /v3/domains/{domain_id}/config/{group}/{option}
Relationship: ``http://docs.openstack.org/api/openstack-identity/3/rel/domain_config_default``
Updates a domain group option configuration. Updates a domain group option configuration.
The API supports only the ``identity`` and ``ldap`` groups. For the The API supports only the ``identity`` and ``ldap`` groups. For the
@ -136,6 +140,8 @@ Delete domain group option configuration
.. rest_method:: DELETE /v3/domains/{domain_id}/config/{group}/{option} .. rest_method:: DELETE /v3/domains/{domain_id}/config/{group}/{option}
Relationship: ``http://docs.openstack.org/api/openstack-identity/3/rel/domain_config_default``
Deletes a domain group option configuration. Deletes a domain group option configuration.
The API supports only the ``identity`` and ``ldap`` groups. For the The API supports only the ``identity`` and ``ldap`` groups. For the
@ -160,6 +166,8 @@ Show domain group configuration
.. rest_method:: GET /v3/domains/{domain_id}/config/{group} .. rest_method:: GET /v3/domains/{domain_id}/config/{group}
Relationship: ``http://docs.openstack.org/api/openstack-identity/3/rel/domain_config_default``
Shows details for a domain group configuration. Shows details for a domain group configuration.
The API supports only the ``identity`` and ``ldap`` groups. The API supports only the ``identity`` and ``ldap`` groups.
@ -199,6 +207,8 @@ Update domain group configuration
.. rest_method:: PATCH /v3/domains/{domain_id}/config/{group} .. rest_method:: PATCH /v3/domains/{domain_id}/config/{group}
Relationship: ``http://docs.openstack.org/api/openstack-identity/3/rel/domain_config_default``
Updates a domain group configuration. Updates a domain group configuration.
The API supports only the ``identity`` and ``ldap`` groups. If you The API supports only the ``identity`` and ``ldap`` groups. If you
@ -252,6 +262,8 @@ Delete domain group configuration
.. rest_method:: DELETE /v3/domains/{domain_id}/config/{group} .. rest_method:: DELETE /v3/domains/{domain_id}/config/{group}
Relationship: ``http://docs.openstack.org/api/openstack-identity/3/rel/domain_config_default``
Deletes a domain group configuration. Deletes a domain group configuration.
The API supports only the ``identity`` and ``ldap`` groups. The API supports only the ``identity`` and ``ldap`` groups.
@ -273,6 +285,8 @@ Create domain configuration
.. rest_method:: PUT /v3/domains/{domain_id}/config .. rest_method:: PUT /v3/domains/{domain_id}/config
Relationship: ``http://docs.openstack.org/api/openstack-identity/3/rel/domain_config``
Creates a domain configuration. Creates a domain configuration.
Normal response codes: 200, 201 Normal response codes: 200, 201
@ -321,6 +335,8 @@ Show domain configuration
.. rest_method:: GET /v3/domains/{domain_id}/config .. rest_method:: GET /v3/domains/{domain_id}/config
Relationship: ``http://docs.openstack.org/api/openstack-identity/3/rel/domain_config``
Shows details for a domain configuration. Shows details for a domain configuration.
Normal response codes: 200 Normal response codes: 200
@ -357,6 +373,8 @@ Update domain configuration
.. rest_method:: PATCH /v3/domains/{domain_id}/config .. rest_method:: PATCH /v3/domains/{domain_id}/config
Relationship: ``http://docs.openstack.org/api/openstack-identity/3/rel/domain_config``
Updates a domain configuration. Updates a domain configuration.
Normal response codes: 200 Normal response codes: 200
@ -405,6 +423,8 @@ Delete domain configuration
.. rest_method:: DELETE /v3/domains/{domain_id}/config .. rest_method:: DELETE /v3/domains/{domain_id}/config
Relationship: ``http://docs.openstack.org/api/openstack-identity/3/rel/domain_config``
Deletes a domain configuration. Deletes a domain configuration.
Normal response codes: 204 Normal response codes: 204

10
api-ref/source/v3/domains.inc
View File

@ -28,6 +28,8 @@ List domains
.. rest_method:: GET /v3/domains .. rest_method:: GET /v3/domains
Relationship: ``http://docs.openstack.org/api/openstack-identity/3/rel/domains``
Lists all domains. Lists all domains.
Normal response codes: 200 Normal response codes: 200
@ -65,6 +67,8 @@ Create domain
.. rest_method:: POST /v3/domains .. rest_method:: POST /v3/domains
Relationship: ``http://docs.openstack.org/api/openstack-identity/3/rel/domains``
Creates a domain. Creates a domain.
Normal response codes: 201 Normal response codes: 201
@ -104,6 +108,8 @@ Show domain details
.. rest_method:: GET /v3/domains/{domain_id} .. rest_method:: GET /v3/domains/{domain_id}
Relationship: ``http://docs.openstack.org/api/openstack-identity/3/rel/domains``
Shows details for a domain. Shows details for a domain.
Normal response codes: 200 Normal response codes: 200
@ -140,6 +146,8 @@ Update domain
.. rest_method:: PATCH /v3/domains/{domain_id} .. rest_method:: PATCH /v3/domains/{domain_id}
Relationship: ``http://docs.openstack.org/api/openstack-identity/3/rel/domain``
Updates a domain. Updates a domain.
Normal response codes: 200 Normal response codes: 200
@ -186,6 +194,8 @@ Delete domain
.. rest_method:: DELETE /v3/domains/{domain_id} .. rest_method:: DELETE /v3/domains/{domain_id}
Relationship: ``http://docs.openstack.org/api/openstack-identity/3/rel/domain``
Deletes a domain. Deletes a domain.
To minimize the risk of accidentally deleting a domain, you must To minimize the risk of accidentally deleting a domain, you must

18
api-ref/source/v3/groups.inc
View File

@ -25,6 +25,8 @@ Show group details
.. rest_method:: GET /v3/groups/{group_id} .. rest_method:: GET /v3/groups/{group_id}
Relationship: ``http://docs.openstack.org/api/openstack-identity/3/rel/group``
Shows details for a group. Shows details for a group.
Normal response codes: 200 Normal response codes: 200
@ -61,6 +63,8 @@ Update group
.. rest_method:: PATCH /v3/groups/{group_id} .. rest_method:: PATCH /v3/groups/{group_id}
Relationship: ``http://docs.openstack.org/api/openstack-identity/3/rel/group``
Updates a group. Updates a group.
If the back-end driver does not support this functionality, the If the back-end driver does not support this functionality, the
@ -110,6 +114,8 @@ Delete group
.. rest_method:: DELETE /v3/groups/{group_id} .. rest_method:: DELETE /v3/groups/{group_id}
Relationship: ``http://docs.openstack.org/api/openstack-identity/3/rel/group``
Deletes a group. Deletes a group.
Error response codes:204,413,415,405,404,403,401,400,503,409, Error response codes:204,413,415,405,404,403,401,400,503,409,
@ -127,6 +133,8 @@ Add user to group
.. rest_method:: PUT /v3/groups/{group_id}/users/{user_id} .. rest_method:: PUT /v3/groups/{group_id}/users/{user_id}
Relationship: ``http://docs.openstack.org/api/openstack-identity/3/rel/group_user``
Adds a user to a group. Adds a user to a group.
Error response codes:204,413,415,405,404,403,401,400,503,409, Error response codes:204,413,415,405,404,403,401,400,503,409,
@ -145,6 +153,8 @@ Remove user from group
.. rest_method:: DELETE /v3/groups/{group_id}/users/{user_id} .. rest_method:: DELETE /v3/groups/{group_id}/users/{user_id}
Relationship: ``http://docs.openstack.org/api/openstack-identity/3/rel/group_user``
Removes a user from a group. Removes a user from a group.
Normal response codes: 204 Normal response codes: 204
@ -164,6 +174,8 @@ Check whether user belongs to group
.. rest_method:: HEAD /v3/groups/{group_id}/users/{user_id} .. rest_method:: HEAD /v3/groups/{group_id}/users/{user_id}
Relationship: ``http://docs.openstack.org/api/openstack-identity/3/rel/group_user``
Validates that a user belongs to a group. Validates that a user belongs to a group.
Normal response codes: 204 Normal response codes: 204
@ -183,6 +195,8 @@ List users in group
.. rest_method:: GET /v3/groups/{group_id}/users .. rest_method:: GET /v3/groups/{group_id}/users
Relationship: ``http://docs.openstack.org/api/openstack-identity/3/rel/group_users``
Lists the users that belong to a group. Lists the users that belong to a group.
Normal response codes: 200 Normal response codes: 200
@ -207,6 +221,8 @@ Create group
.. rest_method:: POST /v3/groups .. rest_method:: POST /v3/groups
Relationship: ``http://docs.openstack.org/api/openstack-identity/3/rel/groups``
Creates a group. Creates a group.
Normal response codes: 201 Normal response codes: 201
@ -251,6 +267,8 @@ List groups
.. rest_method:: GET /v3/groups .. rest_method:: GET /v3/groups
Relationship: ``http://docs.openstack.org/api/openstack-identity/3/rel/groups``
Lists groups. Lists groups.
Normal response codes: 200 Normal response codes: 200

10
api-ref/source/v3/policies.inc
View File

@ -27,6 +27,8 @@ Create policy
.. rest_method:: POST /v3/policies .. rest_method:: POST /v3/policies
Relationship: ``http://docs.openstack.org/api/openstack-identity/3/rel/policies``
Creates a policy. Creates a policy.
Normal response codes: 201 Normal response codes: 201
@ -68,6 +70,8 @@ List policies
.. rest_method:: GET /v3/policies .. rest_method:: GET /v3/policies
Relationship: ``http://docs.openstack.org/api/openstack-identity/3/rel/policies``
Lists policies. Lists policies.
Normal response codes: 200 Normal response codes: 200
@ -105,6 +109,8 @@ Show policy details
.. rest_method:: GET /v3/policies/{policy_id} .. rest_method:: GET /v3/policies/{policy_id}
Relationship: ``http://docs.openstack.org/api/openstack-identity/3/rel/policy``
Shows details for a policy. Shows details for a policy.
Normal response codes: 200 Normal response codes: 200
@ -142,6 +148,8 @@ Update policy
.. rest_method:: PATCH /v3/policies/{policy_id} .. rest_method:: PATCH /v3/policies/{policy_id}
Relationship: ``http://docs.openstack.org/api/openstack-identity/3/rel/policy``
Updates a policy. Updates a policy.
Normal response codes: 200 Normal response codes: 200
@ -190,6 +198,8 @@ Delete policy
.. rest_method:: DELETE /v3/policies/{policy_id} .. rest_method:: DELETE /v3/policies/{policy_id}
Relationship: ``http://docs.openstack.org/api/openstack-identity/3/rel/policy``
Deletes a policy. Deletes a policy.
Normal response codes: 204 Normal response codes: 204

14
api-ref/source/v3/projects.inc
View File

@ -32,6 +32,8 @@ List projects
.. rest_method:: GET /v3/projects .. rest_method:: GET /v3/projects
Relationship: ``http://docs.openstack.org/api/openstack-identity/3/rel/projects``
Lists projects. Lists projects.
Normal response codes: 200 Normal response codes: 200
@ -76,6 +78,8 @@ Create project
.. rest_method:: POST /v3/projects .. rest_method:: POST /v3/projects
Relationship: ``http://docs.openstack.org/api/openstack-identity/3/rel/projects``
Creates a project, including a project acting as a domain. Creates a project, including a project acting as a domain.
Normal response codes: 201 Normal response codes: 201
@ -124,6 +128,8 @@ Show project details
.. rest_method:: GET /v3/projects/{project_id} .. rest_method:: GET /v3/projects/{project_id}
Relationship: ``http://docs.openstack.org/api/openstack-identity/3/rel/project``
Shows details for a project. Shows details for a project.
Normal response codes: 200 Normal response codes: 200
@ -179,6 +185,8 @@ Update project
.. rest_method:: PATCH /v3/projects/{project_id} .. rest_method:: PATCH /v3/projects/{project_id}
Relationship: ``http://docs.openstack.org/api/openstack-identity/3/rel/project``
Updates a project. Updates a project.
Normal response codes: 200 Normal response codes: 200
@ -230,6 +238,8 @@ Delete project
.. rest_method:: DELETE /v3/projects/{project_id} .. rest_method:: DELETE /v3/projects/{project_id}
Relationship: ``http://docs.openstack.org/api/openstack-identity/3/rel/project``
Deletes a project. Deletes a project.
Normal response codes: 204 Normal response codes: 204
@ -248,6 +258,8 @@ Enable or disable project and its subtree
.. rest_method:: PATCH /v3/projects/{project_id}/cascade .. rest_method:: PATCH /v3/projects/{project_id}/cascade
Relationship: ``http://docs.openstack.org/api/openstack-identity/3/rel/project``
(Since Identity API v3.7) Enables or disables a project and its entire subtree. (Since Identity API v3.7) Enables or disables a project and its entire subtree.
A project subtree includes all projects beneath the parent project A project subtree includes all projects beneath the parent project
@ -306,6 +318,8 @@ Delete project subtree
.. rest_method:: DELETE /v3/projects/{project_id}/cascade .. rest_method:: DELETE /v3/projects/{project_id}/cascade
Relationship: ``http://docs.openstack.org/api/openstack-identity/3/rel/project``
(Since Identity API v3.7) Deletes a project and its entire subtree. (Since Identity API v3.7) Deletes a project and its entire subtree.
A project subtree includes all projects beneath the parent project A project subtree includes all projects beneath the parent project

10
api-ref/source/v3/regions-v3.inc
View File

@ -20,6 +20,8 @@ Show region details
.. rest_method:: GET /v3/regions/{region_id} .. rest_method:: GET /v3/regions/{region_id}
Relationship: ``http://docs.openstack.org/api/openstack-identity/3/rel/regions``
Shows details for a region, by ID. Shows details for a region, by ID.
Normal response codes: 200 Normal response codes: 200
@ -55,6 +57,8 @@ Update region
.. rest_method:: PATCH /v3/regions/{region_id} .. rest_method:: PATCH /v3/regions/{region_id}
Relationship: ``http://docs.openstack.org/api/openstack-identity/3/rel/region``
Updates a region. Updates a region.
You can update the description or parent region ID for a region. You can update the description or parent region ID for a region.
@ -106,6 +110,8 @@ Delete region
.. rest_method:: DELETE /v3/regions/{region_id} .. rest_method:: DELETE /v3/regions/{region_id}
Relationship: ``http://docs.openstack.org/api/openstack-identity/3/rel/region``
Deletes a region. Deletes a region.
The following error might occur: The following error might occur:
@ -129,6 +135,8 @@ List regions
.. rest_method:: GET /v3/regions .. rest_method:: GET /v3/regions
Relationship: ``http://docs.openstack.org/api/openstack-identity/3/rel/regions``
Lists regions. Lists regions.
Normal response codes: 200 Normal response codes: 200
@ -164,6 +172,8 @@ Create region
.. rest_method:: POST /v3/regions .. rest_method:: POST /v3/regions
Relationship: ``http://docs.openstack.org/api/openstack-identity/3/rel/regions``
Creates a region. Creates a region.
When you create the region, you can optionally specify a region ID. When you create the region, you can optionally specify a region ID.

44
api-ref/source/v3/roles.inc
View File

@ -83,6 +83,8 @@ Assign role to group on project
.. rest_method:: PUT /v3/projects/{project_id}/groups/{group_id}/roles/{role_id} .. rest_method:: PUT /v3/projects/{project_id}/groups/{group_id}/roles/{role_id}
Relationship: ``http://docs.openstack.org/api/openstack-identity/3/rel/project_group_role``
Assigns a role to a group on a project. Assigns a role to a group on a project.
Normal response codes: 204 Normal response codes: 204
@ -103,6 +105,8 @@ Check whether group has role assignment on project
.. rest_method:: HEAD /v3/projects/{project_id}/groups/{group_id}/roles/{role_id} .. rest_method:: HEAD /v3/projects/{project_id}/groups/{group_id}/roles/{role_id}
Relationship: ``http://docs.openstack.org/api/openstack-identity/3/rel/project_group_role``
Validates that a group has a role assignment on a project. Validates that a group has a role assignment on a project.
Normal response codes: 204 Normal response codes: 204
@ -123,6 +127,8 @@ Unassign role from group on project
.. rest_method:: DELETE /v3/projects/{project_id}/groups/{group_id}/roles/{role_id} .. rest_method:: DELETE /v3/projects/{project_id}/groups/{group_id}/roles/{role_id}
Relationship: ``http://docs.openstack.org/api/openstack-identity/3/rel/project_group_role``
Unassigns a role from a group on a project. Unassigns a role from a group on a project.
Normal response codes: 204 Normal response codes: 204
@ -143,6 +149,8 @@ Assign role to user on project
.. rest_method:: PUT /v3/projects/{project_id}/users/{user_id}/roles/{role_id} .. rest_method:: PUT /v3/projects/{project_id}/users/{user_id}/roles/{role_id}
Relationship: ``http://docs.openstack.org/api/openstack-identity/3/rel/project_user_role``
Assigns a role to a user on a project. Assigns a role to a user on a project.
Normal response codes: 204 Normal response codes: 204
@ -163,6 +171,8 @@ Check whether user has role assignment on project
.. rest_method:: HEAD /v3/projects/{project_id}/users/{user_id}/roles/{role_id} .. rest_method:: HEAD /v3/projects/{project_id}/users/{user_id}/roles/{role_id}
Relationship: ``http://docs.openstack.org/api/openstack-identity/3/rel/project_user_role``
Validates that a user has a role on a project. Validates that a user has a role on a project.
Normal response codes: 204 Normal response codes: 204
@ -183,6 +193,8 @@ Unassign role from user on project
.. rest_method:: DELETE /v3/projects/{project_id}/users/{user_id}/roles/{role_id} .. rest_method:: DELETE /v3/projects/{project_id}/users/{user_id}/roles/{role_id}
Relationship: ``http://docs.openstack.org/api/openstack-identity/3/rel/project_user_role``
Unassigns a role from a user on a project. Unassigns a role from a user on a project.
Normal response codes: 204 Normal response codes: 204
@ -203,6 +215,8 @@ List role assignments for user on project
.. rest_method:: GET /v3/projects/{project_id}/users/{user_id}/roles .. rest_method:: GET /v3/projects/{project_id}/users/{user_id}/roles
Relationship: ``http://docs.openstack.org/api/openstack-identity/3/rel/project_user_role``
Lists role assignments for a user on a project. Lists role assignments for a user on a project.
Normal response codes: 200 Normal response codes: 200
@ -228,6 +242,8 @@ List role assignments for group on project
.. rest_method:: GET /v3/projects/{project_id}/groups/{group_id}/roles .. rest_method:: GET /v3/projects/{project_id}/groups/{group_id}/roles
Relationship: ``http://docs.openstack.org/api/openstack-identity/3/rel/project_user_role``
Lists role assignments for a group on a project. Lists role assignments for a group on a project.
Normal response codes: 200 Normal response codes: 200
@ -258,6 +274,8 @@ Assign role to group on domain
.. rest_method:: PUT /v3/domains/{domain_id}/groups/{group_id}/roles/{role_id} .. rest_method:: PUT /v3/domains/{domain_id}/groups/{group_id}/roles/{role_id}
Relationship: ``http://docs.openstack.org/api/openstack-identity/3/rel/domain_group_role``
Assigns a role to a group on a domain. Assigns a role to a group on a domain.
Normal response codes: 204 Normal response codes: 204
@ -277,6 +295,8 @@ Check whether group has role assignment on domain
.. rest_method:: HEAD /v3/domains/{domain_id}/groups/{group_id}/roles/{role_id} .. rest_method:: HEAD /v3/domains/{domain_id}/groups/{group_id}/roles/{role_id}
Relationship: ``http://docs.openstack.org/api/openstack-identity/3/rel/domain_group_role``
Validates that a group has a role assignment on a domain. Validates that a group has a role assignment on a domain.
Normal response codes: 204 Normal response codes: 204
@ -297,6 +317,8 @@ Unassign role from group on domain
.. rest_method:: DELETE /v3/domains/{domain_id}/groups/{group_id}/roles/{role_id} .. rest_method:: DELETE /v3/domains/{domain_id}/groups/{group_id}/roles/{role_id}
Relationship: ``http://docs.openstack.org/api/openstack-identity/3/rel/domain_group_role``
Unassigns a role from a group on a domain. Unassigns a role from a group on a domain.
Normal response codes: 204 Normal response codes: 204
@ -317,6 +339,8 @@ List role assignments for user on domain
.. rest_method:: GET /v3/domains/{domain_id}/users/{user_id}/roles .. rest_method:: GET /v3/domains/{domain_id}/users/{user_id}/roles
Relationship: ``http://docs.openstack.org/api/openstack-identity/3/rel/domain_user_roles``
Lists role assignments for a user on a domain. Lists role assignments for a user on a domain.
Normal response codes: 200 Normal response codes: 200
@ -357,6 +381,8 @@ List roles
.. rest_method:: GET /v3/roles .. rest_method:: GET /v3/roles
Relationship: ``http://docs.openstack.org/api/openstack-identity/3/rel/roles``
Lists roles. Lists roles.
Normal response codes: 200 Normal response codes: 200
@ -392,6 +418,8 @@ Create role
.. rest_method:: POST /v3/roles .. rest_method:: POST /v3/roles
Relationship: ``http://docs.openstack.org/api/openstack-identity/3/rel/roles``
Creates a role. Creates a role.
Normal response codes: 201 Normal response codes: 201
@ -427,6 +455,8 @@ Assign role to user on domain
.. rest_method:: PUT /v3/domains/{domain_id}/users/{user_id}/roles/{role_id} .. rest_method:: PUT /v3/domains/{domain_id}/users/{user_id}/roles/{role_id}
Relationship: ``http://developer.openstack.org/api-ref-identity-v3.html#assignRoleToUser-domain``
Assigns a role to a user on a domain. Assigns a role to a user on a domain.
Normal response codes: 204 Normal response codes: 204
@ -447,6 +477,8 @@ Check whether user has role assignment on domain
.. rest_method:: HEAD /v3/domains/{domain_id}/users/{user_id}/roles/{role_id} .. rest_method:: HEAD /v3/domains/{domain_id}/users/{user_id}/roles/{role_id}
Relationship: ``http://docs.openstack.org/api/openstack-identity/3/rel/domain_user_role``
Validates that a user has a role assignment on a domain. Validates that a user has a role assignment on a domain.
Normal response codes: 204 Normal response codes: 204
@ -467,6 +499,8 @@ Unassigns role from user on domain
.. rest_method:: DELETE /v3/domains/{domain_id}/users/{user_id}/roles/{role_id} .. rest_method:: DELETE /v3/domains/{domain_id}/users/{user_id}/roles/{role_id}
Relationship: ``http://docs.openstack.org/api/openstack-identity/3/rel/domain_user_role``
Unassigns a role from a user on a domain. Unassigns a role from a user on a domain.
Normal response codes: 204 Normal response codes: 204
@ -487,6 +521,8 @@ List role assignments
.. rest_method:: GET /v3/role_assignments .. rest_method:: GET /v3/role_assignments
Relationship: ``http://docs.openstack.org/api/openstack-identity/3/rel/role_assignments``
Lists role assignments. Lists role assignments.
Normal response codes: 200 Normal response codes: 200
@ -525,6 +561,8 @@ Show role details
.. rest_method:: GET /v3/roles/{role_id} .. rest_method:: GET /v3/roles/{role_id}
Relationship: ``http://docs.openstack.org/api/openstack-identity/3/rel/role``
Shows details for a role. Shows details for a role.
Normal response codes: 200 Normal response codes: 200
@ -559,6 +597,8 @@ Update role
.. rest_method:: PATCH /v3/roles/{role_id} .. rest_method:: PATCH /v3/roles/{role_id}
Relationship: ``http://docs.openstack.org/api/openstack-identity/3/rel/role``
Updates a role. Updates a role.
Normal response codes: 200 Normal response codes: 200
@ -601,6 +641,8 @@ Delete role
.. rest_method:: DELETE /v3/roles/{role_id} .. rest_method:: DELETE /v3/roles/{role_id}
Relationship: ``http://docs.openstack.org/api/openstack-identity/3/rel/role``
Deletes a role. Deletes a role.
Normal response codes: 204 Normal response codes: 204
@ -619,6 +661,8 @@ List role assignments for group on domain
.. rest_method:: GET /v3/domains/{domain_id}/groups/{group_id}/roles .. rest_method:: GET /v3/domains/{domain_id}/groups/{group_id}/roles
Relationship: ``http://docs.openstack.org/api/openstack-identity/3/rel/domain_group_roles``
Lists role assignments for a group on a domain. Lists role assignments for a group on a domain.
Normal response codes: 200 Normal response codes: 200

20
api-ref/source/v3/service-catalog.inc
View File

@ -24,6 +24,8 @@ List services
.. rest_method:: GET /v3/services .. rest_method:: GET /v3/services
Relationship: ``http://docs.openstack.org/api/openstack-identity/3/rel/services``
Lists all services. Lists all services.
Normal response codes: 200 Normal response codes: 200
@ -61,6 +63,8 @@ Create service
.. rest_method:: POST /v3/services .. rest_method:: POST /v3/services
Relationship: ``http://docs.openstack.org/api/openstack-identity/3/rel/services``
Creates a service. Creates a service.
Normal response codes: 201 Normal response codes: 201
@ -102,6 +106,8 @@ Show endpoint details
.. rest_method:: GET /v3/endpoints/{endpoint_id} .. rest_method:: GET /v3/endpoints/{endpoint_id}
Relationship: ``http://docs.openstack.org/api/openstack-identity/3/rel/endpoints``
Shows details for an endpoint. Shows details for an endpoint.
Normal response codes: 200 Normal response codes: 200
@ -139,6 +145,8 @@ Update endpoint
.. rest_method:: PATCH /v3/endpoints/{endpoint_id} .. rest_method:: PATCH /v3/endpoints/{endpoint_id}
Relationship: ``http://docs.openstack.org/api/openstack-identity/3/rel/endpoint``
Updates an endpoint. Updates an endpoint.
Normal response codes: 200 Normal response codes: 200
@ -187,6 +195,8 @@ Delete endpoint
.. rest_method:: DELETE /v3/endpoints/{endpoint_id} .. rest_method:: DELETE /v3/endpoints/{endpoint_id}
Relationship: ``http://docs.openstack.org/api/openstack-identity/3/rel/endpoint``
Deletes an endpoint. Deletes an endpoint.
Normal response codes: 204 Normal response codes: 204
@ -205,6 +215,8 @@ List endpoints
.. rest_method:: GET /v3/endpoints .. rest_method:: GET /v3/endpoints
Relationship: ``http://docs.openstack.org/api/openstack-identity/3/rel/endpoints``
Lists all available endpoints. Lists all available endpoints.
Normal response codes: 200 Normal response codes: 200
@ -245,6 +257,8 @@ Create endpoint
.. rest_method:: POST /v3/endpoints .. rest_method:: POST /v3/endpoints
Relationship: ``http://docs.openstack.org/api/openstack-identity/3/rel/endpoints``
Creates an endpoint. Creates an endpoint.
Normal response codes: 201 Normal response codes: 201
@ -289,6 +303,8 @@ Show service details
.. rest_method:: GET /v3/services/{service_id} .. rest_method:: GET /v3/services/{service_id}
Relationship: ``http://docs.openstack.org/api/openstack-identity/3/rel/service``
Shows details for a service. Shows details for a service.
Normal response codes: 200 Normal response codes: 200
@ -325,6 +341,8 @@ Update service
.. rest_method:: PATCH /v3/services/{service_id} .. rest_method:: PATCH /v3/services/{service_id}
Relationship: ``http://docs.openstack.org/api/openstack-identity/3/rel/services``
Updates a service. Updates a service.
The request body is the same as the create service request body, The request body is the same as the create service request body,
@ -376,6 +394,8 @@ Delete service
.. rest_method:: DELETE /v3/services/{service_id} .. rest_method:: DELETE /v3/services/{service_id}
Relationship: ``http://docs.openstack.org/api/openstack-identity/3/rel/service``
Deletes a service. Deletes a service.
If you try to delete a service that still has associated endpoints, If you try to delete a service that still has associated endpoints,

16
api-ref/source/v3/users.inc
View File

@ -22,6 +22,8 @@ Show user details
.. rest_method:: GET /v3/users/{user_id} .. rest_method:: GET /v3/users/{user_id}
Relationship: ``http://docs.openstack.org/api/openstack-identity/3/rel/user``
Shows details for a user. Shows details for a user.
Normal response codes: 200 Normal response codes: 200
@ -60,6 +62,8 @@ Update user
.. rest_method:: PATCH /v3/users/{user_id} .. rest_method:: PATCH /v3/users/{user_id}
Relationship: ``http://docs.openstack.org/api/openstack-identity/3/rel/user``
Updates a user's password, or whether they are enabled or Updates a user's password, or whether they are enabled or
disabled. disabled.
@ -114,6 +118,8 @@ Delete user
.. rest_method:: DELETE /v3/users/{user_id} .. rest_method:: DELETE /v3/users/{user_id}
Relationship: ``http://docs.openstack.org/api/openstack-identity/3/rel/user``
Deletes a user. Deletes a user.
Error response codes:204,413,415,405,404,403,401,400,503,409, Error response codes:204,413,415,405,404,403,401,400,503,409,
@ -131,6 +137,8 @@ List groups to which a user belongs
.. rest_method:: GET /v3/users/{user_id}/groups .. rest_method:: GET /v3/users/{user_id}/groups
Relationship: ``http://docs.openstack.org/api/openstack-identity/3/rel/user_groups``
Lists groups to which a user belongs. Lists groups to which a user belongs.
Normal response codes: 200 Normal response codes: 200
@ -155,6 +163,8 @@ Change password for user
.. rest_method:: POST /v3/users/{user_id}/password .. rest_method:: POST /v3/users/{user_id}/password
Relationship: ``http://docs.openstack.org/api/openstack-identity/3/rel/user_change_password``
Changes the password for a user. Changes the password for a user.
Error response codes:204,413,415,405,404,403,401,400,503,409, Error response codes:204,413,415,405,404,403,401,400,503,409,
@ -181,6 +191,8 @@ Create user
.. rest_method:: POST /v3/users .. rest_method:: POST /v3/users
Relationship: ``http://docs.openstack.org/api/openstack-identity/3/rel/users``
Creates a user. Creates a user.
Error response codes:201,413,415,405,404,403,401,400,503,409, Error response codes:201,413,415,405,404,403,401,400,503,409,
@ -223,6 +235,8 @@ List users
.. rest_method:: GET /v3/users .. rest_method:: GET /v3/users
Relationship: ``http://docs.openstack.org/api/openstack-identity/3/rel/users``
Lists users. Lists users.
Normal response codes: 200 Normal response codes: 200
@ -264,6 +278,8 @@ List projects for user
.. rest_method:: GET /v3/users/{user_id}/projects .. rest_method:: GET /v3/users/{user_id}/projects
Relationship: ``http://docs.openstack.org/api/openstack-identity/3/rel/user_projects``
List projects for a user. List projects for a user.
Normal response codes: 200 Normal response codes: 200