Help us improve your experience.

Let us know what you think.

Do you have time for a two-minute survey?

 

GET /config/access/users

 

Retrieve Deployed Users.

Retrieves a list of all deployed users. The deployed configuration is the active configuration. This endpoint is available to be called by every user or authorized service. If called by a user or authorized service with the ADMIN capability, all deployed users will be returned. If called by a user or authorized service with the SAASADMIN capability, all deployed users without the ADMIN capability will be returned. If called by anyone else, only the deployed user for the current user will be returned.

Table 1: GET /config/access/users Resource Details

MIME Type

application/json

Table 2: GET /config/access/users Request Parameter Details

Parameter

Type

Optionality

Data Type

MIME Type

Description

current_user

query

Optional

Boolean

text/plain

Only return the caller's user. If called with an authorized service no user will be returned.

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.

sort

query

Optional

String

text/plain

Optional - This parameter is used to sort the elements in a list.

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.

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.

Table 3: GET /config/access/users Response Codes

HTTP Response Code

Unique Code

Description

200

 

The deployed users were retrieved.

422

38314001

Field in sort parameter does not exist.

422

38314002

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