472 lines
8.1 KiB
ReStructuredText
472 lines
8.1 KiB
ReStructuredText
.. -*- rst -*-
|
|
|
|
=======
|
|
Users
|
|
=======
|
|
|
|
A user is an individual API consumer that is owned by a domain. A
|
|
role explicitly associates a user with projects or domains. A user
|
|
with no assigned roles has no access to OpenStack resources.
|
|
|
|
You can list, create, show details for, update, delete, and change
|
|
the password for users.
|
|
|
|
You can also list groups, projects, and role assignments for a specified
|
|
user.
|
|
To list user roles, see `Roles <https://developer.openstack.org/api-ref/
|
|
identity/v3/index.html#roles>`_.
|
|
|
|
|
|
List users
|
|
==========
|
|
|
|
.. rest_method:: GET /v3/users
|
|
|
|
Lists users.
|
|
|
|
Relationship: ``https://docs.openstack.org/api/openstack-identity/3/rel/users``
|
|
|
|
Request
|
|
-------
|
|
|
|
Parameters
|
|
~~~~~~~~~~
|
|
|
|
.. rest_parameters:: parameters.yaml
|
|
|
|
- domain_id: domain_id_query
|
|
- enabled: enabled_user_query
|
|
- idp_id: idp_id_query
|
|
- name: name_user_query
|
|
- password_expires_at: password_expires_at_query
|
|
- protocol_id: protocol_id_query
|
|
- unique_id: unique_id_query
|
|
|
|
Response
|
|
--------
|
|
|
|
Parameters
|
|
~~~~~~~~~~
|
|
|
|
.. rest_parameters:: parameters.yaml
|
|
|
|
- links: link_collection
|
|
- users: users_object
|
|
- default_project_id: default_project_id_response_body
|
|
- domain_id: domain_id_response_body
|
|
- enabled: enabled_user_response_body
|
|
- id: id_user_body
|
|
- links: links_user
|
|
- name: user_name_response_body
|
|
- password_expires_at: password_expires_at
|
|
|
|
Status Codes
|
|
~~~~~~~~~~~~
|
|
|
|
.. rest_status_code:: success status.yaml
|
|
|
|
- 200
|
|
|
|
.. rest_status_code:: error status.yaml
|
|
|
|
- 400
|
|
- 401
|
|
- 403
|
|
|
|
Example
|
|
~~~~~~~
|
|
|
|
.. literalinclude:: ./samples/admin/users-list-response.json
|
|
:language: javascript
|
|
|
|
|
|
Create user
|
|
===========
|
|
|
|
.. rest_method:: POST /v3/users
|
|
|
|
Creates a user.
|
|
|
|
Relationship: ``https://docs.openstack.org/api/openstack-identity/3/rel/users``
|
|
|
|
Request
|
|
-------
|
|
|
|
Parameters
|
|
~~~~~~~~~~
|
|
|
|
.. rest_parameters:: parameters.yaml
|
|
|
|
- user: user_object
|
|
- default_project_id: default_project_id_request_body
|
|
- domain_id: user_domain_id_request_body
|
|
- enabled: enabled_user_request_body
|
|
- name: user_name_create_request_body
|
|
- password: password_request_body
|
|
- extra: extra_request_body
|
|
- options: user_options_request_body
|
|
|
|
Example
|
|
~~~~~~~
|
|
|
|
.. literalinclude:: ./samples/admin/user-create-request.json
|
|
:language: javascript
|
|
|
|
Response
|
|
--------
|
|
|
|
Parameters
|
|
~~~~~~~~~~
|
|
|
|
.. rest_parameters:: parameters.yaml
|
|
|
|
- user: user_object
|
|
- default_project_id: default_project_id_response_body
|
|
- domain_id: domain_id_response_body
|
|
- enabled: enabled_user_response_body
|
|
- id: id_user_body
|
|
- links: links_user
|
|
- name: user_name_response_body
|
|
- password_expires_at: password_expires_at
|
|
- options: response_user_options_body_required
|
|
|
|
Status Codes
|
|
~~~~~~~~~~~~
|
|
|
|
.. rest_status_code:: success status.yaml
|
|
|
|
- 201
|
|
|
|
.. rest_status_code:: error status.yaml
|
|
|
|
- 400
|
|
- 401
|
|
- 403
|
|
- 409
|
|
|
|
Example
|
|
~~~~~~~
|
|
|
|
.. literalinclude:: ./samples/admin/user-create-response.json
|
|
:language: javascript
|
|
|
|
|
|
Show user details
|
|
=================
|
|
|
|
.. rest_method:: GET /v3/users/{user_id}
|
|
|
|
Shows details for a user.
|
|
|
|
Relationship: ``https://docs.openstack.org/api/openstack-identity/3/rel/user``
|
|
|
|
Request
|
|
-------
|
|
|
|
Parameters
|
|
~~~~~~~~~~
|
|
|
|
.. rest_parameters:: parameters.yaml
|
|
|
|
- user_id: user_id_path
|
|
|
|
Response
|
|
--------
|
|
|
|
Parameters
|
|
~~~~~~~~~~
|
|
|
|
.. rest_parameters:: parameters.yaml
|
|
|
|
- user: user_object
|
|
- default_project_id: default_project_id_response_body
|
|
- domain_id: domain_id_response_body
|
|
- enabled: enabled_user_response_body
|
|
- id: id_user_body
|
|
- links: links_user
|
|
- name: user_name_response_body
|
|
- password_expires_at: password_expires_at
|
|
|
|
Status Codes
|
|
~~~~~~~~~~~~
|
|
|
|
.. rest_status_code:: success status.yaml
|
|
|
|
- 200
|
|
|
|
.. rest_status_code:: error status.yaml
|
|
|
|
- 400
|
|
- 401
|
|
- 403
|
|
- 404
|
|
|
|
Example
|
|
~~~~~~~
|
|
|
|
.. literalinclude:: ./samples/admin/user-show-response.json
|
|
:language: javascript
|
|
|
|
|
|
Update user
|
|
===========
|
|
|
|
.. rest_method:: PATCH /v3/users/{user_id}
|
|
|
|
Updates a user.
|
|
|
|
If the back-end driver does not support this functionality, this
|
|
call might return the HTTP ``Not Implemented (501)`` response code.
|
|
|
|
Relationship: ``https://docs.openstack.org/api/openstack-identity/3/rel/user``
|
|
|
|
Request
|
|
-------
|
|
|
|
Parameters
|
|
~~~~~~~~~~
|
|
|
|
.. rest_parameters:: parameters.yaml
|
|
|
|
- user_id: user_id_path
|
|
- user: user_object
|
|
- default_project_id: default_project_id_update_body
|
|
- domain_id: user_domain_id_update_body
|
|
- enabled: enabled_user_update_body
|
|
- name: user_name_update_body
|
|
- password: user_update_password_body
|
|
- options: user_options_request_body
|
|
|
|
Example
|
|
~~~~~~~
|
|
|
|
.. literalinclude:: ./samples/admin/user-update-request.json
|
|
:language: javascript
|
|
|
|
Response
|
|
--------
|
|
|
|
Parameters
|
|
~~~~~~~~~~
|
|
|
|
.. rest_parameters:: parameters.yaml
|
|
|
|
- user: user_object
|
|
- default_project_id: default_project_id_response_body
|
|
- domain_id: domain_id_response_body
|
|
- enabled: enabled_user_response_body
|
|
- id: id_user_body
|
|
- links: links_user
|
|
- name: user_name_response_body
|
|
- password_expires_at: password_expires_at
|
|
- options: response_user_options_body_required
|
|
|
|
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/user-update-response.json
|
|
:language: javascript
|
|
|
|
|
|
Delete user
|
|
===========
|
|
|
|
.. rest_method:: DELETE /v3/users/{user_id}
|
|
|
|
Deletes a user.
|
|
|
|
Relationship: ``https://docs.openstack.org/api/openstack-identity/3/rel/user``
|
|
|
|
Request
|
|
-------
|
|
|
|
Parameters
|
|
~~~~~~~~~~
|
|
|
|
.. rest_parameters:: parameters.yaml
|
|
|
|
- user_id: user_id_path
|
|
|
|
Response
|
|
--------
|
|
|
|
Status Codes
|
|
~~~~~~~~~~~~
|
|
|
|
.. rest_status_code:: success status.yaml
|
|
|
|
- 204
|
|
|
|
.. rest_status_code:: error status.yaml
|
|
|
|
- 400
|
|
- 401
|
|
- 403
|
|
- 404
|
|
|
|
|
|
List groups to which a user belongs
|
|
===================================
|
|
|
|
.. rest_method:: GET /v3/users/{user_id}/groups
|
|
|
|
Lists groups to which a user belongs.
|
|
|
|
Relationship: ``https://docs.openstack.org/api/openstack-identity/3/rel/user_groups``
|
|
|
|
Request
|
|
-------
|
|
|
|
Parameters
|
|
~~~~~~~~~~
|
|
|
|
.. rest_parameters:: parameters.yaml
|
|
|
|
- user_id: user_id_path
|
|
|
|
Response
|
|
--------
|
|
|
|
Parameters
|
|
~~~~~~~~~~
|
|
|
|
.. rest_parameters:: parameters.yaml
|
|
|
|
- links: link_collection
|
|
- groups: groups
|
|
- description: group_description_response_body
|
|
- domain_id: group_domain_id_response_body
|
|
- id: group_id_response_body
|
|
- links: link_response_body
|
|
- name: group_name_response_body
|
|
- membership_expires_at: membership_expires_at_response_body
|
|
|
|
Status Codes
|
|
~~~~~~~~~~~~
|
|
|
|
.. rest_status_code:: success status.yaml
|
|
|
|
- 200
|
|
|
|
.. rest_status_code:: error status.yaml
|
|
|
|
- 400
|
|
- 401
|
|
- 403
|
|
- 404
|
|
|
|
Example
|
|
~~~~~~~
|
|
|
|
.. literalinclude:: ./samples/admin/user-groups-list-response.json
|
|
:language: javascript
|
|
|
|
|
|
List projects for user
|
|
======================
|
|
|
|
.. rest_method:: GET /v3/users/{user_id}/projects
|
|
|
|
List projects to which the user has authorization to access.
|
|
|
|
Relationship: ``https://docs.openstack.org/api/openstack-identity/3/rel/user_projects``
|
|
|
|
Request
|
|
-------
|
|
|
|
Parameters
|
|
~~~~~~~~~~
|
|
|
|
.. rest_parameters:: parameters.yaml
|
|
|
|
- user_id: user_id_path
|
|
|
|
Response
|
|
--------
|
|
|
|
Status Codes
|
|
~~~~~~~~~~~~
|
|
|
|
.. rest_status_code:: success status.yaml
|
|
|
|
- 200
|
|
|
|
.. rest_status_code:: error status.yaml
|
|
|
|
- 400
|
|
- 401
|
|
- 403
|
|
- 404
|
|
|
|
Example
|
|
~~~~~~~
|
|
|
|
.. literalinclude:: ./samples/admin/user-projects-list-response.json
|
|
:language: javascript
|
|
|
|
|
|
Change password for user
|
|
========================
|
|
|
|
.. rest_method:: POST /v3/users/{user_id}/password
|
|
|
|
Changes the password for a user.
|
|
|
|
.. note::
|
|
This API call does not require a token for authentication.
|
|
|
|
Relationship: ``https://docs.openstack.org/api/openstack-identity/3/rel/user_change_password``
|
|
|
|
Request
|
|
-------
|
|
|
|
Parameters
|
|
~~~~~~~~~~
|
|
|
|
.. rest_parameters:: parameters.yaml
|
|
|
|
- user_id: user_id_path
|
|
- user: user_object
|
|
- original_password: original_password
|
|
- password: user_password_update_body
|
|
|
|
Example
|
|
~~~~~~~
|
|
|
|
.. literalinclude:: ./samples/admin/user-password-update-request.json
|
|
:language: javascript
|
|
|
|
Response
|
|
--------
|
|
|
|
Status Codes
|
|
~~~~~~~~~~~~
|
|
|
|
.. rest_status_code:: success status.yaml
|
|
|
|
- 204
|
|
|
|
.. rest_status_code:: error status.yaml
|
|
|
|
- 400
|
|
- 401
|
|
- 403
|
|
- 404
|
|
- 409
|