Clean up api-ref for domains
Change-Id: Ia829c95945ae13e481a773815065bd2372b5895b
This commit is contained in:
parent
9f77e26b18
commit
e8eeb433e1
|
@ -38,20 +38,20 @@ Request
|
||||||
|
|
||||||
.. rest_parameters:: parameters.yaml
|
.. rest_parameters:: parameters.yaml
|
||||||
|
|
||||||
- name: name
|
- name: domain_name_query
|
||||||
- enabled: enabled
|
- enabled: domain_enabled_query
|
||||||
|
|
||||||
Response Parameters
|
Response Parameters
|
||||||
-------------------
|
-------------------
|
||||||
|
|
||||||
.. rest_parameters:: parameters.yaml
|
.. rest_parameters:: parameters.yaml
|
||||||
|
|
||||||
- name: name
|
|
||||||
- links: links
|
|
||||||
- enabled: enabled
|
|
||||||
- domains: domains
|
- domains: domains
|
||||||
- id: id
|
- description: domain_description_response_body
|
||||||
- description: description
|
- enabled: domain_enabled_response_body
|
||||||
|
- id: domain_id_response_body
|
||||||
|
- links: domain_link_response_body
|
||||||
|
- name: domain_name_response_body
|
||||||
|
|
||||||
Response Example
|
Response Example
|
||||||
----------------
|
----------------
|
||||||
|
@ -76,10 +76,10 @@ Request
|
||||||
.. rest_parameters:: parameters.yaml
|
.. rest_parameters:: parameters.yaml
|
||||||
|
|
||||||
- domain: domain
|
- domain: domain
|
||||||
- enabled: enabled
|
- enabled: domain_enabled_request_body
|
||||||
- description: description
|
- description: domain_description_request_body
|
||||||
- name: name
|
- name: domain_name_request_body
|
||||||
|
|
||||||
Request Example
|
Request Example
|
||||||
---------------
|
---------------
|
||||||
|
|
||||||
|
@ -92,11 +92,11 @@ Response Parameters
|
||||||
.. rest_parameters:: parameters.yaml
|
.. rest_parameters:: parameters.yaml
|
||||||
|
|
||||||
- domain: domain
|
- domain: domain
|
||||||
- name: name
|
- description: domain_description_response_body
|
||||||
- links: links
|
- enabled: domain_enabled_response_body
|
||||||
- enabled: enabled
|
- id: domain_id_response_body
|
||||||
- id: id
|
- links: domain_link_response_body
|
||||||
- description: description
|
- name: domain_name_response_body
|
||||||
|
|
||||||
|
|
||||||
Show domain details
|
Show domain details
|
||||||
|
@ -114,7 +114,7 @@ Request
|
||||||
|
|
||||||
.. rest_parameters:: parameters.yaml
|
.. rest_parameters:: parameters.yaml
|
||||||
|
|
||||||
- domain_id: domain_id
|
- domain_id: domain_id_path
|
||||||
|
|
||||||
Response Parameters
|
Response Parameters
|
||||||
-------------------
|
-------------------
|
||||||
|
@ -122,11 +122,11 @@ Response Parameters
|
||||||
.. rest_parameters:: parameters.yaml
|
.. rest_parameters:: parameters.yaml
|
||||||
|
|
||||||
- domain: domain
|
- domain: domain
|
||||||
- name: name
|
- description: domain_description_response_body
|
||||||
- links: links
|
- enabled: domain_enabled_response_body
|
||||||
- enabled: enabled
|
- id: domain_id_response_body
|
||||||
- id: id
|
- links: domain_link_response_body
|
||||||
- description: description
|
- name: domain_name_response_body
|
||||||
|
|
||||||
Response Example
|
Response Example
|
||||||
----------------
|
----------------
|
||||||
|
@ -150,11 +150,11 @@ Request
|
||||||
|
|
||||||
.. rest_parameters:: parameters.yaml
|
.. rest_parameters:: parameters.yaml
|
||||||
|
|
||||||
|
- domain_id: domain_id_path
|
||||||
- domain: domain
|
- domain: domain
|
||||||
- enabled: enabled
|
- enabled: domain_enabled_update_request_body
|
||||||
- description: description
|
- description: domain_description_update_request_body
|
||||||
- name: name
|
- name: domain_name_update_request_body
|
||||||
- domain_id: domain_id
|
|
||||||
|
|
||||||
Request Example
|
Request Example
|
||||||
---------------
|
---------------
|
||||||
|
@ -168,11 +168,11 @@ Response Parameters
|
||||||
.. rest_parameters:: parameters.yaml
|
.. rest_parameters:: parameters.yaml
|
||||||
|
|
||||||
- domain: domain
|
- domain: domain
|
||||||
- name: name
|
- description: domain_description_response_body
|
||||||
- links: links
|
- enabled: domain_enabled_response_body
|
||||||
- enabled: enabled
|
- id: domain_id_response_body
|
||||||
- id: id
|
- links: domain_link_response_body
|
||||||
- description: description
|
- name: domain_name_response_body
|
||||||
|
|
||||||
Response Example
|
Response Example
|
||||||
----------------
|
----------------
|
||||||
|
@ -195,10 +195,6 @@ When you delete a domain, this call also deletes all entities owned
|
||||||
by it, such as users, groups, and projects, and any credentials and
|
by it, such as users, groups, and projects, and any credentials and
|
||||||
granted roles that relate to those entities.
|
granted roles that relate to those entities.
|
||||||
|
|
||||||
(Since v3.6) The deletion of a non-leaf domain in a domain
|
|
||||||
hierarchy tree is not allowed and fails with a ``Bad Request
|
|
||||||
(400)`` response code.
|
|
||||||
|
|
||||||
If you try to delete an enabled domain, this call returns the
|
If you try to delete an enabled domain, this call returns the
|
||||||
``Forbidden (403)`` response code.
|
``Forbidden (403)`` response code.
|
||||||
|
|
||||||
|
@ -210,4 +206,4 @@ Request
|
||||||
|
|
||||||
.. rest_parameters:: parameters.yaml
|
.. rest_parameters:: parameters.yaml
|
||||||
|
|
||||||
- domain_id: domain_id
|
- domain_id: domain_id_path
|
||||||
|
|
|
@ -136,12 +136,26 @@ user_id_path:
|
||||||
type: string
|
type: string
|
||||||
|
|
||||||
# variables in query
|
# variables in query
|
||||||
|
domain_enabled_query:
|
||||||
|
description: |
|
||||||
|
If set to true, then only domains that are enabled will be returned, if set
|
||||||
|
to false only that are disabled will be returned. Any value other than
|
||||||
|
``0``, including no value, will be interpreted as true.
|
||||||
|
in: query
|
||||||
|
required: false
|
||||||
|
type: string
|
||||||
domain_id_query:
|
domain_id_query:
|
||||||
description: |
|
description: |
|
||||||
Filters the response by a domain ID.
|
Filters the response by a domain ID.
|
||||||
in: query
|
in: query
|
||||||
required: false
|
required: false
|
||||||
type: string
|
type: string
|
||||||
|
domain_name_query:
|
||||||
|
description: |
|
||||||
|
Filters the response by a domain name.
|
||||||
|
in: query
|
||||||
|
required: false
|
||||||
|
type: string
|
||||||
effective_query:
|
effective_query:
|
||||||
description: |
|
description: |
|
||||||
Returns the effective assignments, including any assignments gained by
|
Returns the effective assignments, including any assignments gained by
|
||||||
|
@ -476,7 +490,7 @@ description_9:
|
||||||
type: string
|
type: string
|
||||||
domain:
|
domain:
|
||||||
description: |
|
description: |
|
||||||
A ``domain`` object.
|
A ``domain`` object, containing:
|
||||||
in: body
|
in: body
|
||||||
required: true
|
required: true
|
||||||
type: object
|
type: object
|
||||||
|
@ -494,6 +508,56 @@ domain_2:
|
||||||
in: body
|
in: body
|
||||||
required: false
|
required: false
|
||||||
type: object
|
type: object
|
||||||
|
domain_description_request_body:
|
||||||
|
description: |
|
||||||
|
The description of the domain.
|
||||||
|
in: body
|
||||||
|
required: false
|
||||||
|
type: string
|
||||||
|
domain_description_response_body:
|
||||||
|
description: |
|
||||||
|
The description of the domain.
|
||||||
|
in: body
|
||||||
|
required: true
|
||||||
|
type: string
|
||||||
|
domain_description_update_request_body:
|
||||||
|
description: |
|
||||||
|
The new description of the domain.
|
||||||
|
in: body
|
||||||
|
required: false
|
||||||
|
type: string
|
||||||
|
domain_enabled_request_body:
|
||||||
|
description: |
|
||||||
|
If set to ``true``, domain is created enabled. If set to
|
||||||
|
``false``, domain is created disabled. The default is ``true``.
|
||||||
|
|
||||||
|
Users can only authorize against an enabled domain (and any of its
|
||||||
|
projects). In addition, users can only authenticate if the domain that owns
|
||||||
|
them is also enabled. Disabling a domain prevents both of these things.
|
||||||
|
in: body
|
||||||
|
required: false
|
||||||
|
type: string
|
||||||
|
domain_enabled_response_body:
|
||||||
|
description: |
|
||||||
|
If set to ``true``, domain is enabled. If set to
|
||||||
|
``false``, domain is disabled.
|
||||||
|
in: body
|
||||||
|
required: true
|
||||||
|
type: string
|
||||||
|
domain_enabled_update_request_body:
|
||||||
|
description: |
|
||||||
|
If set to ``true``, domain is enabled. If set to
|
||||||
|
``false``, domain is disabled. The default is ``true``.
|
||||||
|
|
||||||
|
Users can only authorize against an enabled domain (and any of its
|
||||||
|
projects). In addition, users can only authenticate if the domain that owns
|
||||||
|
them is also enabled. Disabling a domain prevents both of these things.
|
||||||
|
When you disable a domain, all tokens that are authorized for that domain
|
||||||
|
become no longer valid. If you reenable the domain, these tokens
|
||||||
|
are not re-enabled.
|
||||||
|
in: body
|
||||||
|
required: false
|
||||||
|
type: string
|
||||||
domain_id_1:
|
domain_id_1:
|
||||||
description: |
|
description: |
|
||||||
The ID of the domain that owns the group. If you
|
The ID of the domain that owns the group. If you
|
||||||
|
@ -534,9 +598,39 @@ domain_id_6:
|
||||||
in: body
|
in: body
|
||||||
required: true
|
required: true
|
||||||
type: string
|
type: string
|
||||||
|
domain_id_response_body:
|
||||||
|
description: |
|
||||||
|
The ID of the domain.
|
||||||
|
in: body
|
||||||
|
required: true
|
||||||
|
type: string
|
||||||
|
domain_link_response_body:
|
||||||
|
description: |
|
||||||
|
The links to the ``domain`` resource.
|
||||||
|
in: body
|
||||||
|
required: true
|
||||||
|
type: object
|
||||||
|
domain_name_request_body:
|
||||||
|
description: |
|
||||||
|
The name of the domain.
|
||||||
|
in: body
|
||||||
|
required: true
|
||||||
|
type: string
|
||||||
|
domain_name_response_body:
|
||||||
|
description: |
|
||||||
|
The name of the domain.
|
||||||
|
in: body
|
||||||
|
required: true
|
||||||
|
type: string
|
||||||
|
domain_name_update_request_body:
|
||||||
|
description: |
|
||||||
|
The new name of the domain.
|
||||||
|
in: body
|
||||||
|
required: false
|
||||||
|
type: string
|
||||||
domains:
|
domains:
|
||||||
description: |
|
description: |
|
||||||
A ``domains`` object.
|
A list of ``domain`` objects, each containing:
|
||||||
in: body
|
in: body
|
||||||
required: true
|
required: true
|
||||||
type: array
|
type: array
|
||||||
|
@ -598,22 +692,6 @@ enabled_10:
|
||||||
in: body
|
in: body
|
||||||
required: true
|
required: true
|
||||||
type: boolean
|
type: boolean
|
||||||
enabled_12:
|
|
||||||
description: |
|
|
||||||
Indicates whether the domain is enabled or
|
|
||||||
disabled. If set to ``true``, the domain is enabled. Users can
|
|
||||||
authorize against an enabled domain and any of its projects. Users
|
|
||||||
that are owned by an enabled domain can authenticate and receive
|
|
||||||
additional authorization. If set to ``false``, the domain is
|
|
||||||
disabled. Users cannot authorize against a disabled domain or any
|
|
||||||
of its projects. Users that are owned by a disabled domain cannot
|
|
||||||
authenticate or receive additional authorization. All tokens that
|
|
||||||
are authorized for a disabled domain or its projects become no
|
|
||||||
longer valid. If you reenable the domain, these tokens are not re-
|
|
||||||
enabled.
|
|
||||||
in: body
|
|
||||||
required: true
|
|
||||||
type: boolean
|
|
||||||
enabled_13:
|
enabled_13:
|
||||||
description: |
|
description: |
|
||||||
If set to ``true``, project is enabled. If set to
|
If set to ``true``, project is enabled. If set to
|
||||||
|
@ -991,12 +1069,6 @@ links:
|
||||||
in: body
|
in: body
|
||||||
required: true
|
required: true
|
||||||
type: object
|
type: object
|
||||||
links_1:
|
|
||||||
description: |
|
|
||||||
The links for the ``domain`` resource.
|
|
||||||
in: body
|
|
||||||
required: true
|
|
||||||
type: object
|
|
||||||
links_10:
|
links_10:
|
||||||
description: |
|
description: |
|
||||||
The links for the ``credentials`` resource.
|
The links for the ``credentials`` resource.
|
||||||
|
|
Loading…
Reference in New Issue