diff options
| -rw-r--r-- | api-ref/source/v3/groups.inc | 336 |
1 files changed, 195 insertions, 141 deletions
diff --git a/api-ref/source/v3/groups.inc b/api-ref/source/v3/groups.inc index 834614b31..93175da11 100644 --- a/api-ref/source/v3/groups.inc +++ b/api-ref/source/v3/groups.inc @@ -26,33 +26,26 @@ List groups .. rest_method:: GET /v3/groups -Relationship: ``https://docs.openstack.org/api/openstack-identity/3/rel/groups`` - Lists groups. -Response Codes --------------- - -.. rest_status_code:: success status.yaml - - - 200 - -.. rest_status_code:: error status.yaml +Relationship: ``https://docs.openstack.org/api/openstack-identity/3/rel/groups`` - - 400 - - 401 - - 403 +Request +------- -Request Parameters ------------------- +Parameters +~~~~~~~~~~ .. rest_parameters:: parameters.yaml - name: group_name_query - domain_id: domain_id_query -Response Parameters -------------------- +Response +-------- + +Parameters +~~~~~~~~~~ .. rest_parameters:: parameters.yaml @@ -64,8 +57,21 @@ Response Parameters - links: link_response_body - name: group_name_response_body -Response Example ----------------- +Status Codes +~~~~~~~~~~~~ + +.. rest_status_code:: success status.yaml + + - 200 + +.. rest_status_code:: error status.yaml + + - 400 + - 401 + - 403 + +Example +~~~~~~~ .. literalinclude:: ./samples/admin/groups-list-response.json :language: javascript @@ -76,26 +82,15 @@ Create group .. rest_method:: POST /v3/groups -Relationship: ``https://docs.openstack.org/api/openstack-identity/3/rel/groups`` - Creates a group. -Response Codes --------------- - -.. rest_status_code:: success status.yaml +Relationship: ``https://docs.openstack.org/api/openstack-identity/3/rel/groups`` - - 201 +Request +------- -.. rest_status_code:: error status.yaml - - - 400 - - 401 - - 403 - - 409 - -Request Parameters ------------------- +Parameters +~~~~~~~~~~ .. rest_parameters:: parameters.yaml @@ -104,14 +99,17 @@ Request Parameters - domain_id: group_domain_id_request_body - name: group_name_request_body -Request Example ---------------- +Example +~~~~~~~ .. literalinclude:: ./samples/admin/group-create-request.json :language: javascript -Response Parameters -------------------- +Response +-------- + +Parameters +~~~~~~~~~~ .. rest_parameters:: parameters.yaml @@ -122,8 +120,22 @@ Response Parameters - links: link_response_body - name: group_name_response_body -Response Example ----------------- +Status Codes +~~~~~~~~~~~~ + +.. rest_status_code:: success status.yaml + + - 201 + +.. rest_status_code:: error status.yaml + + - 400 + - 401 + - 403 + - 409 + +Example +~~~~~~~ .. literalinclude:: ./samples/admin/group-show-response.json :language: javascript @@ -134,33 +146,25 @@ Show group details .. rest_method:: GET /v3/groups/{group_id} -Relationship: ``https://docs.openstack.org/api/openstack-identity/3/rel/group`` - Shows details for a group. -Response Codes --------------- - -.. rest_status_code:: success status.yaml - - - 200 - -.. rest_status_code:: error status.yaml +Relationship: ``https://docs.openstack.org/api/openstack-identity/3/rel/group`` - - 400 - - 401 - - 403 - - 404 +Request +------- -Request Parameters ------------------- +Parameters +~~~~~~~~~~ .. rest_parameters:: parameters.yaml - group_id: group_id_path -Response Parameters -------------------- +Response +-------- + +Parameters +~~~~~~~~~~ .. rest_parameters:: parameters.yaml @@ -171,8 +175,22 @@ Response Parameters - links: link_response_body - name: group_name_response_body -Response Example ----------------- +Status Codes +~~~~~~~~~~~~ + +.. rest_status_code:: success status.yaml + + - 200 + +.. rest_status_code:: error status.yaml + + - 400 + - 401 + - 403 + - 404 + +Example +~~~~~~~ .. literalinclude:: ./samples/admin/group-show-response.json :language: javascript @@ -183,31 +201,18 @@ Update group .. rest_method:: PATCH /v3/groups/{group_id} -Relationship: ``https://docs.openstack.org/api/openstack-identity/3/rel/group`` - Updates a group. If the back-end driver does not support this functionality, the call returns the ``Not Implemented (501)`` response code. -Response Codes --------------- - -.. rest_status_code:: success status.yaml - - - 200 +Relationship: ``https://docs.openstack.org/api/openstack-identity/3/rel/group`` -.. rest_status_code:: error status.yaml +Request +------- - - 400 - - 401 - - 403 - - 404 - - 409 - - 501 - -Request Parameters ------------------- +Parameters +~~~~~~~~~~ .. rest_parameters:: parameters.yaml @@ -217,14 +222,17 @@ Request Parameters - domain_id: group_domain_id_update_request_body - name: group_name_update_request_body -Request Example ---------------- +Example +~~~~~~~ .. literalinclude:: ./samples/admin/group-update-request.json :language: javascript -Response Parameters -------------------- +Response +-------- + +Parameters +~~~~~~~~~~ .. rest_parameters:: parameters.yaml @@ -235,8 +243,24 @@ Response Parameters - links: link_response_body - name: group_name_response_body -Response Example ----------------- +Status Codes +~~~~~~~~~~~~ + +.. rest_status_code:: success status.yaml + + - 200 + +.. rest_status_code:: error status.yaml + + - 400 + - 401 + - 403 + - 404 + - 409 + - 501 + +Example +~~~~~~~ .. literalinclude:: ./samples/admin/group-update-response.json :language: javascript @@ -247,12 +271,25 @@ Delete group .. rest_method:: DELETE /v3/groups/{group_id} +Deletes a group. + Relationship: ``https://docs.openstack.org/api/openstack-identity/3/rel/group`` -Deletes a group. +Request +------- + +Parameters +~~~~~~~~~~ + +.. rest_parameters:: parameters.yaml + + - group_id: group_id_path + +Response +-------- -Response Codes --------------- +Status Codes +~~~~~~~~~~~~ .. rest_status_code:: success status.yaml @@ -265,25 +302,32 @@ Response Codes - 403 - 404 -Request Parameters ------------------- - -.. rest_parameters:: parameters.yaml - - - group_id: group_id_path - List users in group =================== .. rest_method:: GET /v3/groups/{group_id}/users +Lists the users that belong to a group. + Relationship: ``https://docs.openstack.org/api/openstack-identity/3/rel/group_users`` -Lists the users that belong to a group. +Request +------- + +Parameters +~~~~~~~~~~ -Response Codes --------------- +.. rest_parameters:: parameters.yaml + + - group_id: group_id_path + - password_expires_at: password_expires_at_query + +Response +-------- + +Status Codes +~~~~~~~~~~~~ .. rest_status_code:: success status.yaml @@ -296,16 +340,8 @@ Response Codes - 403 - 404 -Request Parameters ------------------- - -.. rest_parameters:: parameters.yaml - - - group_id: group_id_path - - password_expires_at: password_expires_at_query - -Response Example ----------------- +Example +~~~~~~~ .. literalinclude:: ./samples/admin/group-users-list-response.json :language: javascript @@ -316,12 +352,26 @@ Add user to group .. rest_method:: PUT /v3/groups/{group_id}/users/{user_id} +Adds a user to a group. + Relationship: ``https://docs.openstack.org/api/openstack-identity/3/rel/group_user`` -Adds a user to a group. +Request +------- + +Parameters +~~~~~~~~~~ + +.. rest_parameters:: parameters.yaml + + - user_id: user_id_path + - group_id: group_id_path + +Response +-------- -Response Codes --------------- +Status Codes +~~~~~~~~~~~~ .. rest_status_code:: success status.yaml @@ -334,26 +384,32 @@ Response Codes - 403 - 404 -Request Parameters ------------------- - -.. rest_parameters:: parameters.yaml - - - user_id: user_id_path - - group_id: group_id_path - Check whether user belongs to group =================================== .. rest_method:: HEAD /v3/groups/{group_id}/users/{user_id} +Validates that a user belongs to a group. + Relationship: ``https://docs.openstack.org/api/openstack-identity/3/rel/group_user`` -Validates that a user belongs to a group. +Request +------- + +Parameters +~~~~~~~~~~ + +.. rest_parameters:: parameters.yaml + + - user_id: user_id_path + - group_id: group_id_path -Response Codes --------------- +Response +-------- + +Status Codes +~~~~~~~~~~~~ .. rest_status_code:: success status.yaml @@ -366,26 +422,32 @@ Response Codes - 403 - 404 -Request Parameters ------------------- - -.. rest_parameters:: parameters.yaml - - - user_id: user_id_path - - group_id: group_id_path - Remove user from group ====================== .. rest_method:: DELETE /v3/groups/{group_id}/users/{user_id} +Removes a user from a group. + Relationship: ``https://docs.openstack.org/api/openstack-identity/3/rel/group_user`` -Removes a user from a group. +Request +------- + +Parameters +~~~~~~~~~~ -Response Codes --------------- +.. rest_parameters:: parameters.yaml + + - user_id: user_id_path + - group_id: group_id_path + +Response +-------- + +Status Codes +~~~~~~~~~~~~ .. rest_status_code:: success status.yaml @@ -397,11 +459,3 @@ Response Codes - 401 - 403 - 404 - -Request Parameters ------------------- - -.. rest_parameters:: parameters.yaml - - - user_id: user_id_path - - group_id: group_id_path |