diff --git a/api-ref/source/v3/roles.inc b/api-ref/source/v3/roles.inc index 4eca6dffc2..561c5a7812 100644 --- a/api-ref/source/v3/roles.inc +++ b/api-ref/source/v3/roles.inc @@ -78,438 +78,6 @@ virtue of group membership will contain a URL that enables access to the membership of the group. -Assign role to group on project -=============================== - -.. 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. - -Response Codes --------------- - -.. rest_status_code:: success status.yaml - - - 204 - -.. rest_status_code:: error status.yaml - - - 400 - - 401 - - 403 - - 404 - - 409 - -Request Parameters ------------------- - -.. rest_parameters:: parameters.yaml - - - project_id: project_id_path - - group_id: group_id_path - - role_id: role_id_path - - -Check whether group has role assignment on project -================================================== - -.. 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. - -Response Codes --------------- - -.. rest_status_code:: success status.yaml - - - 204 - -.. rest_status_code:: error status.yaml - - - 400 - - 401 - - 403 - - 404 - -Request Parameters ------------------- - -.. rest_parameters:: parameters.yaml - - - project_id: project_id_path - - group_id: group_id_path - - role_id: role_id_path - - -Unassign role from group on project -=================================== - -.. 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. - -Response Codes --------------- - -.. rest_status_code:: success status.yaml - - - 204 - -.. rest_status_code:: error status.yaml - - - 400 - - 401 - - 403 - - 404 - -Request Parameters ------------------- - -.. rest_parameters:: parameters.yaml - - - project_id: project_id_path - - group_id: group_id_path - - role_id: role_id_path - - -Assign role to user on project -============================== - -.. 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. - -Response Codes --------------- - -.. rest_status_code:: success status.yaml - - - 204 - -.. rest_status_code:: error status.yaml - - - 400 - - 401 - - 403 - - 404 - - 409 - -Request Parameters ------------------- - -.. rest_parameters:: parameters.yaml - - - project_id: project_id_path - - user_id: user_id_path - - role_id: role_id_path - - -Check whether user has role assignment on project -================================================= - -.. 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. - -Response Codes --------------- - -.. rest_status_code:: success status.yaml - - - 201 - -.. rest_status_code:: error status.yaml - - - 400 - - 401 - - 403 - - 404 - -Request Parameters ------------------- - -.. rest_parameters:: parameters.yaml - - - project_id: project_id_path - - user_id: user_id_path - - role_id: role_id_path - - -Unassign role from user on project -================================== - -.. 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. - -Response Codes --------------- - -.. rest_status_code:: success status.yaml - - - 204 - -.. rest_status_code:: error status.yaml - - - 400 - - 401 - - 403 - - 404 - -Request Parameters ------------------- - -.. rest_parameters:: parameters.yaml - - - project_id: project_id_path - - user_id: user_id_path - - role_id: role_id_path - - -List role assignments for user on project -========================================= - -.. 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. - -Response Codes --------------- - -.. rest_status_code:: success status.yaml - - - 200 - -.. rest_status_code:: error status.yaml - - - 400 - - 401 - - 403 - -Request Parameters ------------------- - -.. rest_parameters:: parameters.yaml - - - project_id: project_id_path - - user_id: user_id_path - -Response Example ----------------- - -.. literalinclude:: ./samples/admin/project-user-roles-list-response.json - :language: javascript - - -List role assignments for group on project -========================================== - -.. 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. - -Response Codes --------------- - -.. rest_status_code:: success status.yaml - - - 200 - -.. rest_status_code:: error status.yaml - - - 400 - - 401 - - 403 - -Request Parameters ------------------- - -.. rest_parameters:: parameters.yaml - - - project_id: project_id_path - - group_id: group_id_path - -Response Example ----------------- - -.. literalinclude:: ./samples/admin/project-group-roles-list-response.json - :language: javascript - -The functionality of this request can also be achieved using the generalized -list assignments API:: - - GET /role_assignments?group.id={group_id}&scope.project.id={project_id} - - -Assign role to group on domain -============================== - -.. 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. - -Response Codes --------------- - -.. rest_status_code:: success status.yaml - - - 204 - -.. rest_status_code:: error status.yaml - - - 400 - - 401 - - 403 - - 404 - - 409 - -Request Parameters ------------------- - -.. rest_parameters:: parameters.yaml - - - domain_id: domain_id_path - - group_id: group_id_path - - role_id: role_id_path - - -Check whether group has role assignment on domain -================================================= - -.. 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. - -Response Codes --------------- - -.. rest_status_code:: success status.yaml - - - 204 - -.. rest_status_code:: error status.yaml - - - 400 - - 401 - - 403 - - 404 - -Request Parameters ------------------- - -.. rest_parameters:: parameters.yaml - - - domain_id: domain_id_path - - group_id: group_id_path - - role_id: role_id_path - - -Unassign role from group on domain -================================== - -.. 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. - -Response Codes --------------- - -.. rest_status_code:: success status.yaml - - - 204 - -.. rest_status_code:: error status.yaml - - - 400 - - 401 - - 403 - - 404 - -Request Parameters ------------------- - -.. rest_parameters:: parameters.yaml - - - domain_id: domain_id_path - - group_id: group_id_path - - role_id: role_id_path - - - -List role assignments for user on domain -======================================== - -.. 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. - -Response Codes --------------- - -.. rest_status_code:: success status.yaml - - - 200 - -.. rest_status_code:: error status.yaml - - - 400 - - 401 - - 403 - -Request Parameters ------------------- - -.. rest_parameters:: parameters.yaml - - - domain_id: domain_id_path - - user_id: user_id_path - -Response Parameters -------------------- - -.. rest_parameters:: parameters.yaml - - - roles: roles - - id: role_id_response_body - - links: link_response_body - - name: role_name_response_body - -Response Example ----------------- - -.. literalinclude:: ./samples/admin/domain-user-roles-list-response.json - :language: javascript - -The functionality of this request can also be achieved using the generalized -list assignments API:: - - GET /role_assignments?user.id={user_id}&scope.domain.id={domain_id} - - List roles ========== @@ -615,199 +183,6 @@ Response Parameters - name: role_name_response_body -Assign role to user on domain -============================= - -.. rest_method:: PUT /v3/domains/{domain_id}/users/{user_id}/roles/{role_id} - -Relationship: ``http://developer.openstack.org/api-ref/identity/v3/index.html#assign-role-to-user-on-domain`` - -Assigns a role to a user on a domain. - -Response Codes --------------- - -.. rest_status_code:: success status.yaml - - - 204 - -.. rest_status_code:: error status.yaml - - - 400 - - 401 - - 403 - - 404 - - 409 - -Request Parameters ------------------- - -.. rest_parameters:: parameters.yaml - - - domain_id: domain_id_path - - user_id: user_id_path - - role_id: role_id_path - - -Check whether user has role assignment on domain -================================================ - -.. 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. - -Response Codes --------------- - -.. rest_status_code:: success status.yaml - - - 204 - -.. rest_status_code:: error status.yaml - - - 400 - - 401 - - 403 - - 404 - -Request Parameters ------------------- - -.. rest_parameters:: parameters.yaml - - - domain_id: domain_id_path - - user_id: user_id_path - - role_id: role_id_path - - -Unassigns role from user on domain -================================== - -.. 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. - -Response Codes --------------- - -.. rest_status_code:: success status.yaml - - - 204 - -.. rest_status_code:: error status.yaml - - - 400 - - 401 - - 403 - - 404 - - 409 - -Request Parameters ------------------- - -.. rest_parameters:: parameters.yaml - - - domain_id: domain_id_path - - user_id: user_id_path - - role_id: role_id_path - - -List role assignments for group on domain -========================================= - -.. 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. - -Response Codes --------------- - -.. rest_status_code:: success status.yaml - - - 200 - -.. rest_status_code:: error status.yaml - - - 400 - - 401 - - 403 - -Request Parameters ------------------- - -.. rest_parameters:: parameters.yaml - - - domain_id: domain_id_path - - group_id: group_id_path - -Response Example ----------------- - -.. literalinclude:: ./samples/admin/domain-group-roles-list-response.json - :language: javascript - -The functionality of this request can also be achieved using the generalized -list assignments API:: - - GET /role_assignments?group.id={group_id}&scope.domain.id={domain_id} - - -List role assignments -===================== - -.. rest_method:: GET /v3/role_assignments - -Relationship: ``http://docs.openstack.org/api/openstack-identity/3/rel/role_assignments`` - -Lists role assignments. - -Response Codes --------------- - -.. rest_status_code:: success status.yaml - - - 200 - -.. rest_status_code:: error status.yaml - - - 400 - - 401 - - 403 - -Request Parameters ------------------- - -.. rest_parameters:: parameters.yaml - - - effective: effective_query - - include_names: include_names_query - - include_subtree: include_subtree_query - - group.id: group_id_query - - role.id: role_id_query - - scope.domain.id: scope_domain_id_query - - scope.project.id: scope_project_id_query - - user.id: user_id_query - -Response Parameters -------------------- - -.. rest_parameters:: parameters.yaml - - - role_assignments: role_assignments - -Response Example ----------------- - -.. literalinclude:: ./samples/admin/role-assignments-list-response.json - :language: javascript - - Show role details ================= @@ -925,6 +300,79 @@ Deletes a role. Response Codes -------------- +.. rest_status_code:: success status.yaml + + - 204 + +.. rest_status_code:: error status.yaml + + - 400 + - 401 + - 403 + - 404 + +Request Parameters +------------------ + +.. rest_parameters:: parameters.yaml + + - role_id: role_id_path + + +List role assignments for group on domain +========================================= + +.. 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. + +Response Codes +-------------- + +.. rest_status_code:: success status.yaml + + - 200 + +.. rest_status_code:: error status.yaml + + - 400 + - 401 + - 403 + +Request Parameters +------------------ + +.. rest_parameters:: parameters.yaml + + - domain_id: domain_id_path + - group_id: group_id_path + +Response Example +---------------- + +.. literalinclude:: ./samples/admin/domain-group-roles-list-response.json + :language: javascript + +The functionality of this request can also be achieved using the generalized +list assignments API:: + + GET /role_assignments?group.id={group_id}&scope.domain.id={domain_id} + + +Assign role to group on domain +============================== + +.. 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. + +Response Codes +-------------- + .. rest_status_code:: success status.yaml - 204 @@ -942,6 +390,506 @@ Request Parameters .. rest_parameters:: parameters.yaml + - domain_id: domain_id_path + - group_id: group_id_path + - role_id: role_id_path + + +Check whether group has role assignment on domain +================================================= + +.. 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. + +Response Codes +-------------- + +.. rest_status_code:: success status.yaml + + - 204 + +.. rest_status_code:: error status.yaml + + - 400 + - 401 + - 403 + - 404 + +Request Parameters +------------------ + +.. rest_parameters:: parameters.yaml + + - domain_id: domain_id_path + - group_id: group_id_path + - role_id: role_id_path + + +Unassign role from group on domain +================================== + +.. 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. + +Response Codes +-------------- + +.. rest_status_code:: success status.yaml + + - 204 + +.. rest_status_code:: error status.yaml + + - 400 + - 401 + - 403 + - 404 + +Request Parameters +------------------ + +.. rest_parameters:: parameters.yaml + + - domain_id: domain_id_path + - group_id: group_id_path + - role_id: role_id_path + + +List role assignments for user on domain +======================================== + +.. 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. + +Response Codes +-------------- + +.. rest_status_code:: success status.yaml + + - 200 + +.. rest_status_code:: error status.yaml + + - 400 + - 401 + - 403 + +Request Parameters +------------------ + +.. rest_parameters:: parameters.yaml + + - domain_id: domain_id_path + - user_id: user_id_path + +Response Parameters +------------------- + +.. rest_parameters:: parameters.yaml + + - roles: roles + - id: role_id_response_body + - links: link_response_body + - name: role_name_response_body + +Response Example +---------------- + +.. literalinclude:: ./samples/admin/domain-user-roles-list-response.json + :language: javascript + +The functionality of this request can also be achieved using the generalized +list assignments API:: + + GET /role_assignments?user.id={user_id}&scope.domain.id={domain_id} + + +Assign role to user on domain +============================= + +.. rest_method:: PUT /v3/domains/{domain_id}/users/{user_id}/roles/{role_id} + +Relationship: ``http://developer.openstack.org/api-ref/identity/v3/index.html#assign-role-to-user-on-domain`` + +Assigns a role to a user on a domain. + +Response Codes +-------------- + +.. rest_status_code:: success status.yaml + + - 204 + +.. rest_status_code:: error status.yaml + + - 400 + - 401 + - 403 + - 404 + - 409 + +Request Parameters +------------------ + +.. rest_parameters:: parameters.yaml + + - domain_id: domain_id_path + - user_id: user_id_path + - role_id: role_id_path + + +Check whether user has role assignment on domain +================================================ + +.. 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. + +Response Codes +-------------- + +.. rest_status_code:: success status.yaml + + - 204 + +.. rest_status_code:: error status.yaml + + - 400 + - 401 + - 403 + - 404 + +Request Parameters +------------------ + +.. rest_parameters:: parameters.yaml + + - domain_id: domain_id_path + - user_id: user_id_path + - role_id: role_id_path + + +Unassigns role from user on domain +================================== + +.. 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. + +Response Codes +-------------- + +.. rest_status_code:: success status.yaml + + - 204 + +.. rest_status_code:: error status.yaml + + - 400 + - 401 + - 403 + - 404 + - 409 + +Request Parameters +------------------ + +.. rest_parameters:: parameters.yaml + + - domain_id: domain_id_path + - user_id: user_id_path + - role_id: role_id_path + + +List role assignments for group on project +========================================== + +.. 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. + +Response Codes +-------------- + +.. rest_status_code:: success status.yaml + + - 200 + +.. rest_status_code:: error status.yaml + + - 400 + - 401 + - 403 + +Request Parameters +------------------ + +.. rest_parameters:: parameters.yaml + + - project_id: project_id_path + - group_id: group_id_path + +Response Example +---------------- + +.. literalinclude:: ./samples/admin/project-group-roles-list-response.json + :language: javascript + +The functionality of this request can also be achieved using the generalized +list assignments API:: + + GET /role_assignments?group.id={group_id}&scope.project.id={project_id} + + +Assign role to group on project +=============================== + +.. 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. + +Response Codes +-------------- + +.. rest_status_code:: success status.yaml + + - 204 + +.. rest_status_code:: error status.yaml + + - 400 + - 401 + - 403 + - 404 + - 409 + +Request Parameters +------------------ + +.. rest_parameters:: parameters.yaml + + - project_id: project_id_path + - group_id: group_id_path + - role_id: role_id_path + + +Check whether group has role assignment on project +================================================== + +.. 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. + +Response Codes +-------------- + +.. rest_status_code:: success status.yaml + + - 204 + +.. rest_status_code:: error status.yaml + + - 400 + - 401 + - 403 + - 404 + +Request Parameters +------------------ + +.. rest_parameters:: parameters.yaml + + - project_id: project_id_path + - group_id: group_id_path + - role_id: role_id_path + + +Unassign role from group on project +=================================== + +.. 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. + +Response Codes +-------------- + +.. rest_status_code:: success status.yaml + + - 204 + +.. rest_status_code:: error status.yaml + + - 400 + - 401 + - 403 + - 404 + +Request Parameters +------------------ + +.. rest_parameters:: parameters.yaml + + - project_id: project_id_path + - group_id: group_id_path + - role_id: role_id_path + + +List role assignments for user on project +========================================= + +.. 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. + +Response Codes +-------------- + +.. rest_status_code:: success status.yaml + + - 200 + +.. rest_status_code:: error status.yaml + + - 400 + - 401 + - 403 + +Request Parameters +------------------ + +.. rest_parameters:: parameters.yaml + + - project_id: project_id_path + - user_id: user_id_path + +Response Example +---------------- + +.. literalinclude:: ./samples/admin/project-user-roles-list-response.json + :language: javascript + + +Assign role to user on project +============================== + +.. 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. + +Response Codes +-------------- + +.. rest_status_code:: success status.yaml + + - 204 + +.. rest_status_code:: error status.yaml + + - 400 + - 401 + - 403 + - 404 + - 409 + +Request Parameters +------------------ + +.. rest_parameters:: parameters.yaml + + - project_id: project_id_path + - user_id: user_id_path + - role_id: role_id_path + + +Check whether user has role assignment on project +================================================= + +.. 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. + +Response Codes +-------------- + +.. rest_status_code:: success status.yaml + + - 201 + +.. rest_status_code:: error status.yaml + + - 400 + - 401 + - 403 + - 404 + +Request Parameters +------------------ + +.. rest_parameters:: parameters.yaml + + - project_id: project_id_path + - user_id: user_id_path + - role_id: role_id_path + + +Unassign role from user on project +================================== + +.. 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. + +Response Codes +-------------- + +.. rest_status_code:: success status.yaml + + - 204 + +.. rest_status_code:: error status.yaml + + - 400 + - 401 + - 403 + - 404 + +Request Parameters +------------------ + +.. rest_parameters:: parameters.yaml + + - project_id: project_id_path + - user_id: user_id_path - role_id: role_id_path @@ -1163,6 +1111,56 @@ Response Example Status: 204 No Content +List role assignments +===================== + +.. rest_method:: GET /v3/role_assignments + +Relationship: ``http://docs.openstack.org/api/openstack-identity/3/rel/role_assignments`` + +Lists role assignments. + +Response Codes +-------------- + +.. rest_status_code:: success status.yaml + + - 200 + +.. rest_status_code:: error status.yaml + + - 400 + - 401 + - 403 + +Request Parameters +------------------ + +.. rest_parameters:: parameters.yaml + + - effective: effective_query + - include_names: include_names_query + - include_subtree: include_subtree_query + - group.id: group_id_query + - role.id: role_id_query + - scope.domain.id: scope_domain_id_query + - scope.project.id: scope_project_id_query + - user.id: user_id_query + +Response Parameters +------------------- + +.. rest_parameters:: parameters.yaml + + - role_assignments: role_assignments + +Response Example +---------------- + +.. literalinclude:: ./samples/admin/role-assignments-list-response.json + :language: javascript + + List all role inference rules =============================