GET /staged_config/access/users

Retrieves a list of all staged users.

Retrieves a list of all staged users. The staged configuration is not active until a deploy is performed. Must have ADMIN or SAASADMIN capability to call this endpoint. All staged users will be returned for ADMIN capability. All staged users, except ADMIN capability users, will be returned for SAASADMIN capability.

Table 1. GET /staged_config/access/users resource details
MIME Type
application/json

Table 2. GET /staged_config/access/users request parameter details
Parameter	Type	Optionality	Data Type	MIME Type	Description
Range	header	Optional	String	text/plain	Optional - Use this parameter to restrict the number of elements that are returned in the list to a specified range. The list is indexed starting at zero.
fields	query	Optional	String	text/plain	Optional - Use this parameter to specify which fields you would like to get back in the response. Fields that are not named are excluded. Specify subfields in brackets and multiple fields in the same object are separated by commas.
filter	query	Optional	String	text/plain	Optional - This parameter is used to restrict the elements in a list base on the contents of various fields.
sort	query	Optional	String	text/plain	Optional - This parameter is used to sort the elements in a list.

Table 3. GET /staged_config/access/users response codes
HTTP Response Code	Unique Code	Description
200		The staged users were retrieved.
422	38313001	Field in sort parameter does not exist.
422	38313002	Sorting not supported on field in sort parameter.

Response Description

Returns an array of user structures.

id - Long - The ID of the user. The ID of the staged user and the ID of the same deployed user are the same. This field is read only.
username - String - The username of the user. This field is read only.
email - String - The email of the user.
description - String - The description of the user. This field is only modifiable in the staged configuration.
user_role_id - Long - The user_role_id of the user. This field is only modifiable in the staged configuration. Access staged user roles using /api/staged_config/user_roles API, and deployed user roles under /api/confg/user_roles API.
security_profile_id - Long - The security_profile_id of the user. This field is only modifiable in the staged configuration. Access staged security profiles using /api/staged_config/security_profiles API, and deployed user roles under /api/config/security_profiles API.
locale_id - String - The locale_id of the user. Access locales using /system/information/locales API.
enable_popup_notifications - Boolean - Indicates if popup system notifications are enabled for this user.
old_password - String - This field will always be null when returned in a response. Required to be set to the current password when a user is changing their own system password.
password - String - This field will always be null when returned in a response. Set to the new password when a user is changing their own system password.
password_creation_time - Long - The time in milliseconds since epoch when the current password was created. Combined with the password_expiry_interval from the /system/authorization/password_policies API to calculate when the password expires.
tenant_id - Long - The tenant_id of the current user. This field is only modifiable in the staged configuration. Access tenants using /config/access/tenant_management/tenants API.
allow_system_authentication_fallback - Boolean - Allow system authentication fallback for this user when external authentication is configured. Has no effect if system authentication is configured.
inactivity_timeout - Long - The inactivity timeout (in milliseconds), truncated to minutes. Set to 0 if a user should not be logged out after being inactive.

Response Sample


[
    {
        "allow_system_authentication_fallback": true,
        "description": "String",
        "email": "String",
        "enable_popup_notifications": true,
        "id": 42,
        "inactivity_timeout": 42,
        "locale_id": "String",
        "old_password": "String",
        "password": "String",
        "password_creation_time": 42,
        "security_profile_id": 42,
        "tenant_id": 42,
        "user_role_id": 42,
        "username": "String"
    }
]