diff options
Diffstat (limited to 'latest/admin_api/user_admin_api.html')
| -rw-r--r-- | latest/admin_api/user_admin_api.html | 7 |
1 files changed, 7 insertions, 0 deletions
diff --git a/latest/admin_api/user_admin_api.html b/latest/admin_api/user_admin_api.html index 0acc361803..20043020a8 100644 --- a/latest/admin_api/user_admin_api.html +++ b/latest/admin_api/user_admin_api.html @@ -296,6 +296,9 @@ granting them access to the Admin API, among other things.</p> </li> <li> <p><code>deactivated</code> - <strong>bool</strong>, optional. If unspecified, deactivation state will be left unchanged.</p> +</li> +<li> +<p><code>locked</code> - <strong>bool</strong>, optional. If unspecified, locked state will be left unchanged.</p> <p>Note: the <code>password</code> field must also be set if both of the following are true:</p> <ul> <li><code>deactivated</code> is set to <code>false</code> and the user was previously deactivated (you are reactivating this user)</li> @@ -368,6 +371,10 @@ that contain this value. This parameter is ignored when using the <code>name</co Defaults to <code>true</code> to include guest users.</p> </li> <li> +<p><code>admins</code> - Optional flag to filter admins. If <code>true</code>, only admins are queried. If <code>false</code>, admins are excluded from +the query. When the flag is absent (the default), <strong>both</strong> admins and non-admins are included in the search results.</p> +</li> +<li> <p><code>deactivated</code> - string representing a bool - Is optional and if <code>true</code> will <strong>include</strong> deactivated users. Defaults to <code>false</code> to exclude deactivated users.</p> </li> |