Listing Users

Function

This API is used to list the IAM Identity Center users in the specified identity source. It can be called only from the organization's management account or from a delegated administrator account of a cloud service.

URI

GET /v1/identity-stores/{identity_store_id}/users

**Table 1** Path parameters
Parameter	Mandatory	Type	Description
identity_store_id	Yes	String	Globally unique ID of an identity source. Minimum length: 12 Maximum length: 12

**Table 2** Query parameters
Parameter	Mandatory	Type	Description
marker	No	String	Pagination marker. Minimum length: 24 Maximum length: 24
limit	No	Integer	Maximum number of results returned for each request. Minimum value: 1 Maximum value: 100 Default value: 100
user_name	No	String	Username

Request Parameters

**Table 3** Parameters in the request header
Parameter	Mandatory	Type	Description
X-Security-Token	No	String	Security token (session token) of your temporary security credentials. If a temporary security credential is used, this header is required. Maximum length: 2048

Response Parameters

Status code: 200

**Table 4** Parameters in the response body
Parameter	Type	Description
page_info	Object	Pagination information.
users	Array of objects	List of users in the identity source.

**Table 5** page_info
Parameter	Type	Description
next_marker	String	If present, it indicates that the available output is more than the output contained in the current response. Use this value in the marker request parameter in a subsequent call to the operation to get the next part of the output. You should repeat this operation until the next_marker response returns null.
current_count	Integer	Number of records returned on this page.

**Table 6** users
Parameter	Type	Description
addresses	Array of objects	Address list of a user. Array length: 1-1
display_name	String	Display name of a user. Minimum length: 1 Maximum length: 1024
emails	Array of objects	Email address list of a user. Array length: 1-1
external_id	String	Identifier assigned by an external identity source to a resource.
external_ids	Array of objects	External ID list of a user. Array length: 1-10
identity_store_id	String	Globally unique ID of an identity source. Minimum length: 1 Maximum length: 36
locale	String	Geographical area or location of a user. Minimum length: 1 Maximum length: 1024
name	Object	User's name.
nickname	String	Nickname of a user. Minimum length: 1 Maximum length: 1024
phone_numbers	Array of objects	Phone number list of a user. Array length: 1-1
preferred_language	String	User's preferred language. Minimum length: 1 Maximum length: 1024
profile_url	String	URL associated with a user. Minimum length: 1 Maximum length: 1024
timezone	String	User time zone. Minimum length: 1 Maximum length: 1024
title	String	User title. Minimum length: 1 Maximum length: 1024
user_id	String	Globally unique ID of an IAM Identity Center user in the identity source. Minimum length: 1 Maximum length: 47
user_name	String	Username, which uniquely identifies a user. Minimum length: 2 Maximum length: 128
user_type	String	User type. Minimum length: 1 Maximum length: 1024
created_at	Long	Timestamp when a user is created.
created_by	String	Creator.
updated_at	Long	Timestamp when a user is updated.
updated_by	String	Updater.
enabled	Boolean	Whether a user is enabled.
enterprise	Object	User work information.

**Table 7** users.addresses
Parameter	Type	Description
country	String	Country or region. Minimum length: 1 Maximum length: 1024
formatted	String	Formatted address to be displayed. Minimum length: 1 Maximum length: 1024
locality	String	Location. Minimum length: 1 Maximum length: 1024
postal_code	String	Postal code. Minimum length: 1 Maximum length: 1024
primary	Boolean	Whether the address is the user's primary address.
region	String	Region. Minimum length: 1 Maximum length: 1024
street_address	String	Street. Minimum length: 1 Maximum length: 1024
type	String	Address type. Minimum length: 1 Maximum length: 1024

**Table 8** users.emails
Parameter	Type	Description
primary	Boolean	Whether the value is the user's primary email address.
type	String	Email address type. Minimum length: 1 Maximum length: 1024
value	String	Email address. Minimum length: 1 Maximum length: 1024
verification_status	String	Verification status of an email address. Enumerated value: NOT_VERIFIED VERIFIED

**Table 9** users.external_ids
Parameter	Type	Description
id	String	Resource ID issued by an external identity provider. Minimum length: 1 Maximum length: 256
issuer	String	Issuer of an external ID. Minimum length: 1 Maximum length: 100

**Table 10** users.name
Parameter	Type	Description
family_name	String	Family name of a user. Minimum length: 1 Maximum length: 1024
formatted	String	Formatted name to be displayed. Minimum length: 1 Maximum length: 1024
given_name	String	Given name of a user. Minimum length: 1 Maximum length: 1024
honorific_prefix	String	Prefix of a user's name. Minimum length: 1 Maximum length: 1024
honorific_suffix	String	Suffix of a user's name. Minimum length: 1 Maximum length: 1024
middle_name	String	Middle name of a user. Minimum length: 1 Maximum length: 1024

**Table 11** users.phone_numbers
Parameter	Type	Description
primary	Boolean	Whether the value is the user's primary phone number.
type	String	Phone number type. Minimum length: 1 Maximum length: 1024
value	String	Phone number. Minimum length: 1 Maximum length: 1024

**Table 12** enterprise
Parameter	Type	Description
cost_center	String	Cost Center. Minimum length: 1 Maximum length: 1024
department	String	Department. Minimum length: 1 Maximum length: 1024
division	String	Division. Minimum length: 1 Maximum length: 1024
employee_number	String	Employee ID. Minimum length: 1 Maximum length: 1024
manager	Object	Manager.
organization	String	Organization. Minimum length: 1 Maximum length: 1024

**Table 13** manager
Parameter	Type	Description
value	String	Manager. Minimum length: 1 Maximum length: 1024

Status code: 400

**Table 14** Parameters in the response body
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error message.
request_id	String	Request ID.
encoded_authorization_message	String	Encrypted error message.

Status code: 403

**Table 15** Parameters in the response body
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error message.
request_id	String	Request ID.
encoded_authorization_message	String	Encrypted error message.

Example Request

Listing the IAM Identity Center users in the specified identity source

GET https://{hostname}/v1/identity-stores/{identity_store_id}/users

Example Response

Status code: 200

{
  "page_info" : {
    "next_marker" : null,
    "current_count" : 1
  },
  "users" : [ {
    "addresses" : null,
    "display_name" : "Display name of a user",
    "emails" : [ {
      "primary" : true,
      "type" : "Work",
      "value" : "email@example.com"
    } ],
    "external_ids" : null,
    "identity_store_id" : "d-a00aaaa33f",
    "locale" : null,
    "name" : {
      "family_name" : "Family name",
      "formatted" : null,
      "given_name" : "Given name",
      "honorific_prefix" : null,
      "honorific_suffix" : null,
      "middle_name" : null
    },
    "nickname" : null,
    "phone_numbers" : null,
    "preferred_language" : null,
    "profile_url" : null,
    "timezone" : null,
    "title" : null,
    "user_id" : "ac6aa714-daa7-1aaa-aaa2-6715aaaa4dd9",
    "user_name" : "Username u1",
    "user_type" : null,
    "created_at" : 1687184129925,
    "created_by" : "5146d03d8aaaaaaaaaaaabbae60620a5",
    "updated_at" : 1687184129926,
    "updated_by" : "5146d03d8aaaaaaaaaaaabbae60620a5",
    "enabled" : true
  } ]
}