"Fossies" - the Fresh Open Source Software Archive

Member "keystone-17.0.0/api-ref/source/v3/domains.inc" (13 May 2020, 5805 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 "domains.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  Domains
    5 =========
    6 
    7 A domain is a collection of users, groups, and projects. Each group
    8 and project is owned by exactly one domain.
    9 
   10 Each domain defines a namespace where certain API-visible name
   11 attributes exist, which affects whether those names must be
   12 globally unique or unique within that domain. In the Identity API,
   13 the uniqueness of these attributes is as follows:
   14 
   15 - *Domain name*. Globally unique across all domains.
   16 
   17 - *Role name*. Unique within the owning domain.
   18 
   19 - *User name*. Unique within the owning domain.
   20 
   21 - *Project name*. Unique within the owning domain.
   22 
   23 - *Group name*. Unique within the owning domain.
   24 
   25 List domains
   26 ============
   27 
   28 .. rest_method::  GET /v3/domains
   29 
   30 Lists all domains.
   31 
   32 Relationship: ``https://docs.openstack.org/api/openstack-identity/3/rel/domains``
   33 
   34 Request
   35 -------
   36 
   37 Parameters
   38 ~~~~~~~~~~
   39 
   40 .. rest_parameters:: parameters.yaml
   41 
   42    - name: domain_name_query
   43    - enabled: domain_enabled_query
   44 
   45 Response
   46 --------
   47 
   48 Parameters
   49 ~~~~~~~~~~
   50 
   51 .. rest_parameters:: parameters.yaml
   52 
   53    - domains: domains
   54    - description: domain_description_response_body
   55    - enabled: domain_enabled_response_body
   56    - id: domain_id_response_body
   57    - links: domain_link_response_body
   58    - name: domain_name_response_body
   59 
   60 Status Codes
   61 ~~~~~~~~~~~~
   62 
   63 .. rest_status_code:: success status.yaml
   64 
   65    - 200
   66 
   67 .. rest_status_code:: error status.yaml
   68 
   69    - 400
   70    - 401
   71    - 403
   72    - 404
   73    - 405
   74    - 413
   75    - 503
   76 
   77 Example
   78 ~~~~~~~
   79 
   80 .. literalinclude:: ./samples/admin/domains-list-response.json
   81    :language: javascript
   82 
   83 
   84 Create domain
   85 =============
   86 
   87 .. rest_method::  POST /v3/domains
   88 
   89 Creates a domain.
   90 
   91 Relationship: ``https://docs.openstack.org/api/openstack-identity/3/rel/domains``
   92 
   93 Request
   94 -------
   95 
   96 Parameters
   97 ~~~~~~~~~~
   98 
   99 .. rest_parameters:: parameters.yaml
  100 
  101    - domain: domain
  102    - enabled: domain_enabled_request_body
  103    - description: domain_description_request_body
  104    - name: domain_name_request_body
  105    - options: request_domain_options_body_not_required
  106 
  107 Example
  108 ~~~~~~~
  109 
  110 .. literalinclude:: ./samples/admin/domain-create-request.json
  111    :language: javascript
  112 
  113 Response
  114 --------
  115 
  116 Parameters
  117 ~~~~~~~~~~
  118 
  119 .. rest_parameters:: parameters.yaml
  120 
  121    - domain: domain
  122    - description: domain_description_response_body
  123    - enabled: domain_enabled_response_body
  124    - id: domain_id_response_body
  125    - links: domain_link_response_body
  126    - name: domain_name_response_body
  127    - options: response_role_options_body_required
  128 
  129 Status Codes
  130 ~~~~~~~~~~~~
  131 
  132 .. rest_status_code:: success status.yaml
  133 
  134    - 201
  135 
  136 .. rest_status_code:: error status.yaml
  137 
  138    - 400
  139    - 401
  140    - 403
  141    - 404
  142    - 405
  143    - 409
  144    - 413
  145    - 415
  146    - 503
  147 
  148 
  149 Show domain details
  150 ===================
  151 
  152 .. rest_method::  GET /v3/domains/{domain_id}
  153 
  154 Shows details for a domain.
  155 
  156 Relationship: ``https://docs.openstack.org/api/openstack-identity/3/rel/domains``
  157 
  158 Request
  159 -------
  160 
  161 Parameters
  162 ~~~~~~~~~~
  163 
  164 .. rest_parameters:: parameters.yaml
  165 
  166    - domain_id: domain_id_path
  167 
  168 Response
  169 --------
  170 
  171 Parameters
  172 ~~~~~~~~~~
  173 
  174 .. rest_parameters:: parameters.yaml
  175 
  176    - domain: domain
  177    - description: domain_description_response_body
  178    - enabled: domain_enabled_response_body
  179    - id: domain_id_response_body
  180    - links: domain_link_response_body
  181    - name: domain_name_response_body
  182    - options: response_role_options_body_required
  183 
  184 Status Codes
  185 ~~~~~~~~~~~~
  186 
  187 .. rest_status_code:: success status.yaml
  188 
  189    - 200
  190 
  191 .. rest_status_code:: error status.yaml
  192 
  193    - 400
  194    - 401
  195    - 403
  196    - 404
  197    - 405
  198    - 413
  199    - 503
  200 
  201 Example
  202 ~~~~~~~
  203 
  204 .. literalinclude:: ./samples/admin/domain-show-response.json
  205    :language: javascript
  206 
  207 
  208 Update domain
  209 =============
  210 
  211 .. rest_method::  PATCH /v3/domains/{domain_id}
  212 
  213 Updates a domain.
  214 
  215 Relationship: ``https://docs.openstack.org/api/openstack-identity/3/rel/domain``
  216 
  217 Request
  218 -------
  219 
  220 Parameters
  221 ~~~~~~~~~~
  222 
  223 .. rest_parameters:: parameters.yaml
  224 
  225    - domain_id: domain_id_path
  226    - domain: domain
  227    - enabled: domain_enabled_update_request_body
  228    - description: domain_description_update_request_body
  229    - name: domain_name_update_request_body
  230    - options: request_domain_options_body_not_required
  231 
  232 Example
  233 ~~~~~~~
  234 
  235 .. literalinclude:: ./samples/admin/domain-update-request.json
  236    :language: javascript
  237 
  238 Response
  239 --------
  240 
  241 Parameters
  242 ~~~~~~~~~~
  243 
  244 .. rest_parameters:: parameters.yaml
  245 
  246    - domain: domain
  247    - description: domain_description_response_body
  248    - enabled: domain_enabled_response_body
  249    - id: domain_id_response_body
  250    - links: domain_link_response_body
  251    - name: domain_name_response_body
  252    - options: response_role_options_body_required
  253 
  254 Status Codes
  255 ~~~~~~~~~~~~
  256 
  257 .. rest_status_code:: success status.yaml
  258 
  259    - 200
  260 
  261 .. rest_status_code:: error status.yaml
  262 
  263    - 400
  264    - 401
  265    - 403
  266    - 404
  267    - 405
  268    - 409
  269    - 413
  270    - 415
  271    - 503
  272 
  273 Example
  274 ~~~~~~~
  275 
  276 .. literalinclude:: ./samples/admin/domain-update-response.json
  277    :language: javascript
  278 
  279 
  280 Delete domain
  281 =============
  282 
  283 .. rest_method::  DELETE /v3/domains/{domain_id}
  284 
  285 Deletes a domain.
  286 To minimize the risk of accidentally deleting a domain, you must
  287 first disable the domain by using the update domain method.
  288 
  289 When you delete a domain, this call also deletes all entities owned
  290 by it, such as users, groups, and projects, and any credentials and
  291 granted roles that relate to those entities.
  292 
  293 If you try to delete an enabled domain, this call returns the
  294 ``Forbidden (403)`` response code.
  295 
  296 Relationship: ``https://docs.openstack.org/api/openstack-identity/3/rel/domain``
  297 
  298 Request
  299 -------
  300 
  301 Parameters
  302 ~~~~~~~~~~
  303 
  304 .. rest_parameters:: parameters.yaml
  305 
  306    - domain_id: domain_id_path
  307 
  308 Status Codes
  309 ~~~~~~~~~~~~
  310 
  311 .. rest_status_code:: success status.yaml
  312 
  313    - 204
  314 
  315 .. rest_status_code:: error status.yaml
  316 
  317    - 400
  318    - 401
  319    - 403
  320    - 404
  321    - 405
  322    - 409
  323    - 413
  324    - 415
  325    - 503