summaryrefslogtreecommitdiff
path: root/api-ref/source/v3
diff options
context:
space:
mode:
Diffstat (limited to 'api-ref/source/v3')
-rw-r--r--api-ref/source/v3/parameters.yaml19
-rw-r--r--api-ref/source/v3/users.inc4
2 files changed, 11 insertions, 12 deletions
diff --git a/api-ref/source/v3/parameters.yaml b/api-ref/source/v3/parameters.yaml
index 8ea55dabe..724ab3582 100644
--- a/api-ref/source/v3/parameters.yaml
+++ b/api-ref/source/v3/parameters.yaml
@@ -1848,6 +1848,15 @@ response_limit_domain_id_body:
in: body
required: true
type: string
+response_user_options_body_required:
+ description: |
+ The resource options for the user. Available resource options are
+ ``ignore_change_password_upon_first_use``, ``ignore_password_expiry``,
+ ``ignore_lockout_failure_attempts``, ``lock_password``,
+ ``multi_factor_auth_enabled``, and ``multi_factor_auth_rules``.
+ in: body
+ required: true
+ type: object
role:
description: |
A ``role`` object
@@ -2143,16 +2152,6 @@ user_options_request_body:
in: body
required: false
type: object
-user_options_response_body:
- description: |
- The resource options for the user. Only present in the response if set on
- the user entity. Available resource options are
- ``ignore_change_password_upon_first_use``, ``ignore_password_expiry``,
- ``ignore_lockout_failure_attempts``, ``lock_password``,
- ``multi_factor_auth_enabled``, and ``multi_factor_auth_rules``.
- in: body
- required: false
- type: object
user_password_update_body:
description: |
The new password for the user.
diff --git a/api-ref/source/v3/users.inc b/api-ref/source/v3/users.inc
index aee2d3386..e6e21defa 100644
--- a/api-ref/source/v3/users.inc
+++ b/api-ref/source/v3/users.inc
@@ -128,7 +128,7 @@ Parameters
- links: links_user
- name: user_name_response_body
- password_expires_at: password_expires_at
- - options: user_options_response_body
+ - options: response_user_options_body_required
Status Codes
~~~~~~~~~~~~
@@ -259,7 +259,7 @@ Parameters
- links: links_user
- name: user_name_response_body
- password_expires_at: password_expires_at
- - options: user_options_response_body
+ - options: response_user_options_body_required
Status Codes
~~~~~~~~~~~~