Document the "immutable" resource option
Roles, projects, and domains can accept "immutable" as a resource option. This change explains the option in the admin guide and updates the API reference to mention it. Change-Id: I95926927472f6418f97a08fea0ebd56da04ce7a5 Related-bug: #1823258
This commit is contained in:
parent
62cd34d40d
commit
34f6144a47
|
@ -102,6 +102,7 @@ Parameters
|
||||||
- enabled: domain_enabled_request_body
|
- enabled: domain_enabled_request_body
|
||||||
- description: domain_description_request_body
|
- description: domain_description_request_body
|
||||||
- name: domain_name_request_body
|
- name: domain_name_request_body
|
||||||
|
- options: request_domain_options_body_not_required
|
||||||
|
|
||||||
Example
|
Example
|
||||||
~~~~~~~
|
~~~~~~~
|
||||||
|
@ -123,6 +124,7 @@ Parameters
|
||||||
- id: domain_id_response_body
|
- id: domain_id_response_body
|
||||||
- links: domain_link_response_body
|
- links: domain_link_response_body
|
||||||
- name: domain_name_response_body
|
- name: domain_name_response_body
|
||||||
|
- options: response_role_options_body_required
|
||||||
|
|
||||||
Status Codes
|
Status Codes
|
||||||
~~~~~~~~~~~~
|
~~~~~~~~~~~~
|
||||||
|
@ -177,6 +179,7 @@ Parameters
|
||||||
- id: domain_id_response_body
|
- id: domain_id_response_body
|
||||||
- links: domain_link_response_body
|
- links: domain_link_response_body
|
||||||
- name: domain_name_response_body
|
- name: domain_name_response_body
|
||||||
|
- options: response_role_options_body_required
|
||||||
|
|
||||||
Status Codes
|
Status Codes
|
||||||
~~~~~~~~~~~~
|
~~~~~~~~~~~~
|
||||||
|
@ -224,6 +227,7 @@ Parameters
|
||||||
- enabled: domain_enabled_update_request_body
|
- enabled: domain_enabled_update_request_body
|
||||||
- description: domain_description_update_request_body
|
- description: domain_description_update_request_body
|
||||||
- name: domain_name_update_request_body
|
- name: domain_name_update_request_body
|
||||||
|
- options: request_domain_options_body_not_required
|
||||||
|
|
||||||
Example
|
Example
|
||||||
~~~~~~~
|
~~~~~~~
|
||||||
|
@ -245,6 +249,7 @@ Parameters
|
||||||
- id: domain_id_response_body
|
- id: domain_id_response_body
|
||||||
- links: domain_link_response_body
|
- links: domain_link_response_body
|
||||||
- name: domain_name_response_body
|
- name: domain_name_response_body
|
||||||
|
- options: response_role_options_body_required
|
||||||
|
|
||||||
Status Codes
|
Status Codes
|
||||||
~~~~~~~~~~~~
|
~~~~~~~~~~~~
|
||||||
|
|
|
@ -1664,6 +1664,13 @@ request_default_limit_body_not_required:
|
||||||
in: body
|
in: body
|
||||||
required: false
|
required: false
|
||||||
type: integer
|
type: integer
|
||||||
|
request_domain_options_body_not_required:
|
||||||
|
description: |
|
||||||
|
The resource options for the domain. Available resource options are
|
||||||
|
``immutable``.
|
||||||
|
in: body
|
||||||
|
required: false
|
||||||
|
type: object
|
||||||
request_limit_domain_id_not_required:
|
request_limit_domain_id_not_required:
|
||||||
description: |
|
description: |
|
||||||
The name of the domain.
|
The name of the domain.
|
||||||
|
@ -1676,6 +1683,13 @@ request_limit_project_id_not_required:
|
||||||
in: body
|
in: body
|
||||||
required: false
|
required: false
|
||||||
type: string
|
type: string
|
||||||
|
request_project_options_body_not_required:
|
||||||
|
description: |
|
||||||
|
The resource options for the project. Available resource options are
|
||||||
|
``immutable``.
|
||||||
|
in: body
|
||||||
|
required: false
|
||||||
|
type: object
|
||||||
request_region_id_registered_limit_body_not_required:
|
request_region_id_registered_limit_body_not_required:
|
||||||
description: |
|
description: |
|
||||||
The ID of the region that contains the service endpoint.
|
The ID of the region that contains the service endpoint.
|
||||||
|
@ -1698,6 +1712,13 @@ request_resource_name_body_not_required:
|
||||||
in: body
|
in: body
|
||||||
required: false
|
required: false
|
||||||
type: string
|
type: string
|
||||||
|
request_role_options_body_not_required:
|
||||||
|
description: |
|
||||||
|
The resource options for the role. Available resource options are
|
||||||
|
``immutable``.
|
||||||
|
in: body
|
||||||
|
required: false
|
||||||
|
type: object
|
||||||
request_service_id_registered_limit_body_not_required:
|
request_service_id_registered_limit_body_not_required:
|
||||||
description: |
|
description: |
|
||||||
The UUID of the service to update to which the registered
|
The UUID of the service to update to which the registered
|
||||||
|
@ -1842,12 +1863,33 @@ response_body_system_required:
|
||||||
in: body
|
in: body
|
||||||
required: true
|
required: true
|
||||||
type: array
|
type: array
|
||||||
|
response_domain_options_body_required:
|
||||||
|
description: |
|
||||||
|
The resource options for the domain. Available resource options are
|
||||||
|
``immutable``.
|
||||||
|
in: body
|
||||||
|
required: true
|
||||||
|
type: object
|
||||||
response_limit_domain_id_body:
|
response_limit_domain_id_body:
|
||||||
description: |
|
description: |
|
||||||
The ID of the domain.
|
The ID of the domain.
|
||||||
in: body
|
in: body
|
||||||
required: true
|
required: true
|
||||||
type: string
|
type: string
|
||||||
|
response_project_options_body_required:
|
||||||
|
description: |
|
||||||
|
The resource options for the project. Available resource options are
|
||||||
|
``immutable``.
|
||||||
|
in: body
|
||||||
|
required: true
|
||||||
|
type: object
|
||||||
|
response_role_options_body_required:
|
||||||
|
description: |
|
||||||
|
The resource options for the role. Available resource options are
|
||||||
|
``immutable``.
|
||||||
|
in: body
|
||||||
|
required: true
|
||||||
|
type: object
|
||||||
response_user_options_body_required:
|
response_user_options_body_required:
|
||||||
description: |
|
description: |
|
||||||
The resource options for the user. Available resource options are
|
The resource options for the user. Available resource options are
|
||||||
|
|
|
@ -126,6 +126,7 @@ Parameters
|
||||||
- enabled: project_enabled_request_body
|
- enabled: project_enabled_request_body
|
||||||
- parent_id: project_parent_id_request_body
|
- parent_id: project_parent_id_request_body
|
||||||
- tags: project_tags_request_body
|
- tags: project_tags_request_body
|
||||||
|
- options: request_project_options_body_not_required
|
||||||
|
|
||||||
Examples
|
Examples
|
||||||
~~~~~~~~
|
~~~~~~~~
|
||||||
|
@ -157,6 +158,7 @@ Parameters
|
||||||
- links: link_response_body
|
- links: link_response_body
|
||||||
- name: project_name_response_body
|
- name: project_name_response_body
|
||||||
- parent_id: project_parent_id_response_body
|
- parent_id: project_parent_id_response_body
|
||||||
|
- options: response_project_options_body_required
|
||||||
|
|
||||||
Status Codes
|
Status Codes
|
||||||
~~~~~~~~~~~~
|
~~~~~~~~~~~~
|
||||||
|
@ -213,6 +215,7 @@ Parameters
|
||||||
- links: link_response_body
|
- links: link_response_body
|
||||||
- name: project_name_response_body
|
- name: project_name_response_body
|
||||||
- parent_id: project_parent_id_response_body
|
- parent_id: project_parent_id_response_body
|
||||||
|
- options: response_project_options_body_required
|
||||||
|
|
||||||
Status Codes
|
Status Codes
|
||||||
~~~~~~~~~~~~
|
~~~~~~~~~~~~
|
||||||
|
@ -272,6 +275,7 @@ Parameters
|
||||||
- domain_id: project_domain_id_update_request_body
|
- domain_id: project_domain_id_update_request_body
|
||||||
- enabled: project_enabled_update_request_body
|
- enabled: project_enabled_update_request_body
|
||||||
- tags: project_tags_request_body
|
- tags: project_tags_request_body
|
||||||
|
- options: request_project_options_body_not_required
|
||||||
|
|
||||||
Example
|
Example
|
||||||
~~~~~~~
|
~~~~~~~
|
||||||
|
@ -296,6 +300,7 @@ Parameters
|
||||||
- name: project_name_response_body
|
- name: project_name_response_body
|
||||||
- links: link_response_body
|
- links: link_response_body
|
||||||
- parent_id: project_parent_id_response_body
|
- parent_id: project_parent_id_response_body
|
||||||
|
- options: response_project_options_body_required
|
||||||
|
|
||||||
|
|
||||||
Status Codes
|
Status Codes
|
||||||
|
@ -354,4 +359,4 @@ Status Codes
|
||||||
- 400
|
- 400
|
||||||
- 401
|
- 401
|
||||||
- 403
|
- 403
|
||||||
- 404
|
- 404
|
||||||
|
|
|
@ -176,6 +176,7 @@ Parameters
|
||||||
- name: role_name_create_body
|
- name: role_name_create_body
|
||||||
- domain_id: role_domain_id_request_body
|
- domain_id: role_domain_id_request_body
|
||||||
- description: role_description_create_body
|
- description: role_description_create_body
|
||||||
|
- options: request_role_options_body_not_required
|
||||||
|
|
||||||
Example
|
Example
|
||||||
~~~~~~~
|
~~~~~~~
|
||||||
|
@ -203,6 +204,7 @@ Parameters
|
||||||
- links: link_response_body
|
- links: link_response_body
|
||||||
- name: role_name_response_body
|
- name: role_name_response_body
|
||||||
- description: role_description_response_body_required
|
- description: role_description_response_body_required
|
||||||
|
- options: response_role_options_body_required
|
||||||
|
|
||||||
Status Codes
|
Status Codes
|
||||||
~~~~~~~~~~~~
|
~~~~~~~~~~~~
|
||||||
|
@ -252,6 +254,7 @@ Parameters
|
||||||
- links: link_response_body
|
- links: link_response_body
|
||||||
- name: role_name_response_body
|
- name: role_name_response_body
|
||||||
- description: role_description_response_body_required
|
- description: role_description_response_body_required
|
||||||
|
- options: response_role_options_body_required
|
||||||
|
|
||||||
Status Codes
|
Status Codes
|
||||||
~~~~~~~~~~~~
|
~~~~~~~~~~~~
|
||||||
|
@ -295,6 +298,7 @@ Parameters
|
||||||
- role: role
|
- role: role
|
||||||
- name: role_name_update_body
|
- name: role_name_update_body
|
||||||
- description: role_description_update_body
|
- description: role_description_update_body
|
||||||
|
- options: request_role_options_body_not_required
|
||||||
|
|
||||||
Example
|
Example
|
||||||
~~~~~~~
|
~~~~~~~
|
||||||
|
@ -316,6 +320,7 @@ Parameters
|
||||||
- links: link_response_body
|
- links: link_response_body
|
||||||
- name: role_name_response_body
|
- name: role_name_response_body
|
||||||
- description: role_description_response_body_required
|
- description: role_description_response_body_required
|
||||||
|
- options: response_role_options_body_required
|
||||||
|
|
||||||
Status Codes
|
Status Codes
|
||||||
~~~~~~~~~~~~
|
~~~~~~~~~~~~
|
||||||
|
|
|
@ -6,6 +6,7 @@
|
||||||
"links": {
|
"links": {
|
||||||
"self": "http://example.com/identity/v3/domains/161718"
|
"self": "http://example.com/identity/v3/domains/161718"
|
||||||
},
|
},
|
||||||
"name": "myDomain"
|
"name": "myDomain",
|
||||||
|
"options": {}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
|
@ -6,6 +6,7 @@
|
||||||
"links": {
|
"links": {
|
||||||
"self": "http://example.com/identity/v3/domains/default"
|
"self": "http://example.com/identity/v3/domains/default"
|
||||||
},
|
},
|
||||||
"name": "Default"
|
"name": "Default",
|
||||||
|
"options": {}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
|
@ -6,6 +6,7 @@
|
||||||
"enabled": true,
|
"enabled": true,
|
||||||
"description": "Owns users and projects on Identity API v2.",
|
"description": "Owns users and projects on Identity API v2.",
|
||||||
"name": "Default",
|
"name": "Default",
|
||||||
"id": "default"
|
"id": "default",
|
||||||
|
"options": {}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
|
@ -4,6 +4,7 @@
|
||||||
"domain_id": "default",
|
"domain_id": "default",
|
||||||
"enabled": true,
|
"enabled": true,
|
||||||
"is_domain": false,
|
"is_domain": false,
|
||||||
"name": "myNewProject"
|
"name": "myNewProject",
|
||||||
|
"options": {}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
|
@ -10,6 +10,7 @@
|
||||||
},
|
},
|
||||||
"name": "myNewProject",
|
"name": "myNewProject",
|
||||||
"parent_id": "default",
|
"parent_id": "default",
|
||||||
"tags": []
|
"tags": [],
|
||||||
|
"options": {}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
|
@ -7,6 +7,7 @@
|
||||||
"self": "http://example.com/identity/v3/projects/263fd9"
|
"self": "http://example.com/identity/v3/projects/263fd9"
|
||||||
},
|
},
|
||||||
"name": "Dev Group A",
|
"name": "Dev Group A",
|
||||||
|
"options": {},
|
||||||
"parent_id": "183ab2",
|
"parent_id": "183ab2",
|
||||||
"parents": [
|
"parents": [
|
||||||
{
|
{
|
||||||
|
|
|
@ -9,6 +9,7 @@
|
||||||
"self": "http://example.com/identity/v3/projects/0c4e939acacf4376bdcd1129f1a054ad"
|
"self": "http://example.com/identity/v3/projects/0c4e939acacf4376bdcd1129f1a054ad"
|
||||||
},
|
},
|
||||||
"name": "admin",
|
"name": "admin",
|
||||||
"parent_id": "default"
|
"parent_id": "default",
|
||||||
|
"options": {}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
|
@ -7,6 +7,7 @@
|
||||||
"self": "http://example.com/identity/v3/projects/263fd9"
|
"self": "http://example.com/identity/v3/projects/263fd9"
|
||||||
},
|
},
|
||||||
"name": "Dev Group A",
|
"name": "Dev Group A",
|
||||||
|
"options": {},
|
||||||
"parent_id": "183ab2",
|
"parent_id": "183ab2",
|
||||||
"subtree": [
|
"subtree": [
|
||||||
{
|
{
|
||||||
|
|
|
@ -10,6 +10,7 @@
|
||||||
"is_domain": true,
|
"is_domain": true,
|
||||||
"name": "myUpdatedProject",
|
"name": "myUpdatedProject",
|
||||||
"parent_id": null,
|
"parent_id": null,
|
||||||
"tags": []
|
"tags": [],
|
||||||
|
"options": {}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
|
@ -5,6 +5,7 @@
|
||||||
"self": "http://example.com/identity/v3/roles/1e443fa8cee3482a8a2b6954dd5c8f12"
|
"self": "http://example.com/identity/v3/roles/1e443fa8cee3482a8a2b6954dd5c8f12"
|
||||||
},
|
},
|
||||||
"description": "My new role",
|
"description": "My new role",
|
||||||
"name": "developer"
|
"name": "developer",
|
||||||
|
"options": {}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
|
@ -6,6 +6,7 @@
|
||||||
"self": "http://example.com/identity/v3/roles/1e443fa8cee3482a8a2b6954dd5c8f12"
|
"self": "http://example.com/identity/v3/roles/1e443fa8cee3482a8a2b6954dd5c8f12"
|
||||||
},
|
},
|
||||||
"description": "My new role",
|
"description": "My new role",
|
||||||
"name": "Developer"
|
"name": "Developer",
|
||||||
|
"options": {}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
|
@ -6,6 +6,7 @@
|
||||||
"self": "http://example.com/identity/v3/roles/1e443fa8cee3482a8a2b6954dd5c8f12"
|
"self": "http://example.com/identity/v3/roles/1e443fa8cee3482a8a2b6954dd5c8f12"
|
||||||
},
|
},
|
||||||
"description": "My new role",
|
"description": "My new role",
|
||||||
"name": "Developer"
|
"name": "Developer",
|
||||||
|
"options": {}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
|
@ -188,3 +188,75 @@ authenticate.
|
||||||
|
|
||||||
|
|
||||||
See :ref:`multi_factor_authentication` for further details.
|
See :ref:`multi_factor_authentication` for further details.
|
||||||
|
|
||||||
|
Role Options
|
||||||
|
============
|
||||||
|
|
||||||
|
The following options are available on role resources. If left undefined, they
|
||||||
|
are assumed to be false or disabled.
|
||||||
|
|
||||||
|
immutable
|
||||||
|
---------
|
||||||
|
|
||||||
|
Type: ``Boolean``
|
||||||
|
|
||||||
|
Specify whether a role is immutable. An immutable role may not be deleted or
|
||||||
|
modified except to remove the ``immutable`` option.
|
||||||
|
|
||||||
|
.. code-block:: json
|
||||||
|
|
||||||
|
{
|
||||||
|
"role": {
|
||||||
|
"options": {
|
||||||
|
"immutable": true
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
Project Options
|
||||||
|
===============
|
||||||
|
|
||||||
|
The following options are available on project resources. If left undefined, they
|
||||||
|
are assumed to be false or disabled.
|
||||||
|
|
||||||
|
immutable
|
||||||
|
---------
|
||||||
|
|
||||||
|
Type: ``Boolean``
|
||||||
|
|
||||||
|
Specify whether a project is immutable. An immutable project may not be deleted
|
||||||
|
or modified except to remove the ``immutable`` option.
|
||||||
|
|
||||||
|
.. code-block:: json
|
||||||
|
|
||||||
|
{
|
||||||
|
"project": {
|
||||||
|
"options": {
|
||||||
|
"immutable": true
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
Domain Options
|
||||||
|
==============
|
||||||
|
|
||||||
|
The following options are available on domain resources. If left undefined, they
|
||||||
|
are assumed to be false or disabled.
|
||||||
|
|
||||||
|
immutable
|
||||||
|
---------
|
||||||
|
|
||||||
|
Type: ``Boolean``
|
||||||
|
|
||||||
|
Specify whether a domain is immutable. An immutable domain may not be deleted
|
||||||
|
or modified except to remove the ``immutable`` option.
|
||||||
|
|
||||||
|
.. code-block:: json
|
||||||
|
|
||||||
|
{
|
||||||
|
"domain": {
|
||||||
|
"options": {
|
||||||
|
"immutable": true
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
Loading…
Reference in New Issue