"Fossies" - the Fresh Open Source Software Archive

Member "keystone-17.0.0/api-ref/source/v3/users.inc" (13 May 2020, 8523 Bytes) of package /linux/misc/openstack/keystone-17.0.0.tar.gz:


As a special service "Fossies" has tried to format the requested source page into HTML format using (guessed) fasm source code syntax highlighting (style: standard) with prefixed line numbers. Alternatively you can here view or download the uninterpreted source code file. For more information about "users.inc" see the Fossies "Dox" file reference documentation and the latest Fossies "Diffs" side-by-side code changes report: 16.0.1_vs_17.0.0.

    1 .. -*- rst -*-
    2 
    3 =======
    4  Users
    5 =======
    6 
    7 A user is an individual API consumer that is owned by a domain. A
    8 role explicitly associates a user with projects or domains. A user
    9 with no assigned roles has no access to OpenStack resources.
   10 
   11 You can list, create, show details for, update, delete, and change
   12 the password for users.
   13 
   14 You can also list groups, projects, and role assignments for a specified
   15 user.
   16 To list user roles, see `Roles <https://developer.openstack.org/api-ref/
   17 identity/v3/index.html#roles>`_.
   18 
   19 
   20 List users
   21 ==========
   22 
   23 .. rest_method::  GET /v3/users
   24 
   25 Lists users.
   26 
   27 Relationship: ``https://docs.openstack.org/api/openstack-identity/3/rel/users``
   28 
   29 Request
   30 -------
   31 
   32 Parameters
   33 ~~~~~~~~~~
   34 
   35 .. rest_parameters:: parameters.yaml
   36 
   37    - domain_id: domain_id_query
   38    - enabled: enabled_user_query
   39    - idp_id: idp_id_query
   40    - name: name_user_query
   41    - password_expires_at: password_expires_at_query
   42    - protocol_id: protocol_id_query
   43    - unique_id: unique_id_query
   44 
   45 Response
   46 --------
   47 
   48 Parameters
   49 ~~~~~~~~~~
   50 
   51 .. rest_parameters:: parameters.yaml
   52 
   53    - links: link_collection
   54    - users: users_object
   55    - default_project_id: default_project_id_response_body
   56    - domain_id: domain_id_response_body
   57    - enabled: enabled_user_response_body
   58    - id: id_user_body
   59    - links: links_user
   60    - name: user_name_response_body
   61    - password_expires_at: password_expires_at
   62 
   63 Status Codes
   64 ~~~~~~~~~~~~
   65 
   66 .. rest_status_code:: success status.yaml
   67 
   68    - 200
   69 
   70 .. rest_status_code:: error status.yaml
   71 
   72    - 400
   73    - 401
   74    - 403
   75 
   76 Example
   77 ~~~~~~~
   78 
   79 .. literalinclude:: ./samples/admin/users-list-response.json
   80    :language: javascript
   81 
   82 
   83 Create user
   84 ===========
   85 
   86 .. rest_method::  POST /v3/users
   87 
   88 Creates a user.
   89 
   90 Relationship: ``https://docs.openstack.org/api/openstack-identity/3/rel/users``
   91 
   92 Request
   93 -------
   94 
   95 Parameters
   96 ~~~~~~~~~~
   97 
   98 .. rest_parameters:: parameters.yaml
   99 
  100    - user: user_object
  101    - default_project_id: default_project_id_request_body
  102    - domain_id: user_domain_id_request_body
  103    - federated: federated_in_request_body
  104    - enabled: enabled_user_request_body
  105    - name: user_name_create_request_body
  106    - password: password_request_body
  107    - extra: extra_request_body
  108    - options: user_options_request_body
  109 
  110 Example
  111 ~~~~~~~
  112 
  113 .. literalinclude:: ./samples/admin/user-create-request.json
  114    :language: javascript
  115 
  116 Response
  117 --------
  118 
  119 Parameters
  120 ~~~~~~~~~~
  121 
  122 .. rest_parameters:: parameters.yaml
  123 
  124    - user: user_object
  125    - default_project_id: default_project_id_response_body
  126    - domain_id: domain_id_response_body
  127    - enabled: enabled_user_response_body
  128    - federated: federated_in_response_body
  129    - id: id_user_body
  130    - links: links_user
  131    - name: user_name_response_body
  132    - password_expires_at: password_expires_at
  133    - options: response_user_options_body_required
  134 
  135 Status Codes
  136 ~~~~~~~~~~~~
  137 
  138 .. rest_status_code:: success status.yaml
  139 
  140    - 201
  141 
  142 .. rest_status_code:: error status.yaml
  143 
  144    - 400
  145    - 401
  146    - 403
  147    - 409
  148 
  149 Example
  150 ~~~~~~~
  151 
  152 .. literalinclude:: ./samples/admin/user-create-response.json
  153    :language: javascript
  154 
  155 
  156 Show user details
  157 =================
  158 
  159 .. rest_method::  GET /v3/users/{user_id}
  160 
  161 Shows details for a user.
  162 
  163 Relationship: ``https://docs.openstack.org/api/openstack-identity/3/rel/user``
  164 
  165 Request
  166 -------
  167 
  168 Parameters
  169 ~~~~~~~~~~
  170 
  171 .. rest_parameters:: parameters.yaml
  172 
  173    - user_id: user_id_path
  174 
  175 Response
  176 --------
  177 
  178 Parameters
  179 ~~~~~~~~~~
  180 
  181 .. rest_parameters:: parameters.yaml
  182 
  183    - user: user_object
  184    - default_project_id: default_project_id_response_body
  185    - domain_id: domain_id_response_body
  186    - enabled: enabled_user_response_body
  187    - federated: federated_in_response_body
  188    - id: id_user_body
  189    - links: links_user
  190    - name: user_name_response_body
  191    - password_expires_at: password_expires_at
  192 
  193 Status Codes
  194 ~~~~~~~~~~~~
  195 
  196 .. rest_status_code:: success status.yaml
  197 
  198    - 200
  199 
  200 .. rest_status_code:: error status.yaml
  201 
  202    - 400
  203    - 401
  204    - 403
  205    - 404
  206 
  207 Example
  208 ~~~~~~~
  209 
  210 .. literalinclude:: ./samples/admin/user-show-response.json
  211    :language: javascript
  212 
  213 
  214 Update user
  215 ===========
  216 
  217 .. rest_method::  PATCH /v3/users/{user_id}
  218 
  219 Updates a user.
  220 
  221 If the back-end driver does not support this functionality, this
  222 call might return the HTTP ``Not Implemented (501)`` response code.
  223 
  224 Relationship: ``https://docs.openstack.org/api/openstack-identity/3/rel/user``
  225 
  226 Request
  227 -------
  228 
  229 Parameters
  230 ~~~~~~~~~~
  231 
  232 .. rest_parameters:: parameters.yaml
  233 
  234    - user_id: user_id_path
  235    - user: user_object
  236    - default_project_id: default_project_id_update_body
  237    - domain_id: user_domain_id_update_body
  238    - enabled: enabled_user_update_body
  239    - federated: federated_in_request_body
  240    - name: user_name_update_body
  241    - password: user_update_password_body
  242    - options: user_options_request_body
  243 
  244 Example
  245 ~~~~~~~
  246 
  247 .. literalinclude:: ./samples/admin/user-update-request.json
  248    :language: javascript
  249 
  250 Response
  251 --------
  252 
  253 Parameters
  254 ~~~~~~~~~~
  255 
  256 .. rest_parameters:: parameters.yaml
  257 
  258    - user: user_object
  259    - default_project_id: default_project_id_response_body
  260    - domain_id: domain_id_response_body
  261    - enabled: enabled_user_response_body
  262    - federated: federated_in_response_body
  263    - id: id_user_body
  264    - links: links_user
  265    - name: user_name_response_body
  266    - password_expires_at: password_expires_at
  267    - options: response_user_options_body_required
  268 
  269 Status Codes
  270 ~~~~~~~~~~~~
  271 
  272 .. rest_status_code:: success status.yaml
  273 
  274    - 200
  275 
  276 .. rest_status_code:: error status.yaml
  277 
  278    - 400
  279    - 401
  280    - 403
  281    - 404
  282    - 409
  283    - 501
  284 
  285 Example
  286 ~~~~~~~
  287 
  288 .. literalinclude:: ./samples/admin/user-update-response.json
  289    :language: javascript
  290 
  291 
  292 Delete user
  293 ===========
  294 
  295 .. rest_method::  DELETE /v3/users/{user_id}
  296 
  297 Deletes a user.
  298 
  299 Relationship: ``https://docs.openstack.org/api/openstack-identity/3/rel/user``
  300 
  301 Request
  302 -------
  303 
  304 Parameters
  305 ~~~~~~~~~~
  306 
  307 .. rest_parameters:: parameters.yaml
  308 
  309    - user_id: user_id_path
  310 
  311 Response
  312 --------
  313 
  314 Status Codes
  315 ~~~~~~~~~~~~
  316 
  317 .. rest_status_code:: success status.yaml
  318 
  319    - 204
  320 
  321 .. rest_status_code:: error status.yaml
  322 
  323    - 400
  324    - 401
  325    - 403
  326    - 404
  327 
  328 
  329 List groups to which a user belongs
  330 ===================================
  331 
  332 .. rest_method::  GET /v3/users/{user_id}/groups
  333 
  334 Lists groups to which a user belongs.
  335 
  336 Relationship: ``https://docs.openstack.org/api/openstack-identity/3/rel/user_groups``
  337 
  338 Request
  339 -------
  340 
  341 Parameters
  342 ~~~~~~~~~~
  343 
  344 .. rest_parameters:: parameters.yaml
  345 
  346    - user_id: user_id_path
  347 
  348 Response
  349 --------
  350 
  351 Parameters
  352 ~~~~~~~~~~
  353 
  354 .. rest_parameters:: parameters.yaml
  355 
  356    - links: link_collection
  357    - groups: groups
  358    - description: group_description_response_body
  359    - domain_id: group_domain_id_response_body
  360    - id: group_id_response_body
  361    - links: link_response_body
  362    - name: group_name_response_body
  363    - membership_expires_at: membership_expires_at_response_body
  364 
  365 Status Codes
  366 ~~~~~~~~~~~~
  367 
  368 .. rest_status_code:: success status.yaml
  369 
  370    - 200
  371 
  372 .. rest_status_code:: error status.yaml
  373 
  374    - 400
  375    - 401
  376    - 403
  377    - 404
  378 
  379 Example
  380 ~~~~~~~
  381 
  382 .. literalinclude:: ./samples/admin/user-groups-list-response.json
  383    :language: javascript
  384 
  385 
  386 List projects for user
  387 ======================
  388 
  389 .. rest_method::  GET /v3/users/{user_id}/projects
  390 
  391 List projects to which the user has authorization to access.
  392 
  393 Relationship: ``https://docs.openstack.org/api/openstack-identity/3/rel/user_projects``
  394 
  395 Request
  396 -------
  397 
  398 Parameters
  399 ~~~~~~~~~~
  400 
  401 .. rest_parameters:: parameters.yaml
  402 
  403    - user_id: user_id_path
  404 
  405 Response
  406 --------
  407 
  408 Status Codes
  409 ~~~~~~~~~~~~
  410 
  411 .. rest_status_code:: success status.yaml
  412 
  413    - 200
  414 
  415 .. rest_status_code:: error status.yaml
  416 
  417    - 400
  418    - 401
  419    - 403
  420    - 404
  421 
  422 Example
  423 ~~~~~~~
  424 
  425 .. literalinclude:: ./samples/admin/user-projects-list-response.json
  426    :language: javascript
  427 
  428 
  429 Change password for user
  430 ========================
  431 
  432 .. rest_method::  POST /v3/users/{user_id}/password
  433 
  434 Changes the password for a user.
  435 
  436 .. note::
  437     This API call does not require a token for authentication.
  438 
  439 Relationship: ``https://docs.openstack.org/api/openstack-identity/3/rel/user_change_password``
  440 
  441 Request
  442 -------
  443 
  444 Parameters
  445 ~~~~~~~~~~
  446 
  447 .. rest_parameters:: parameters.yaml
  448 
  449    - user_id: user_id_path
  450    - user: user_object
  451    - original_password: original_password
  452    - password: user_password_update_body
  453 
  454 Example
  455 ~~~~~~~
  456 
  457 .. literalinclude:: ./samples/admin/user-password-update-request.json
  458    :language: javascript
  459 
  460 Response
  461 --------
  462 
  463 Status Codes
  464 ~~~~~~~~~~~~
  465 
  466 .. rest_status_code:: success status.yaml
  467 
  468    - 204
  469 
  470 .. rest_status_code:: error status.yaml
  471 
  472    - 400
  473    - 401
  474    - 403
  475    - 404
  476    - 409