List ACS Users Associated with a User Identity

Get all ACS users for a specified user identity

Returns a list of all ACS users assigned to a user identity.

/user_identities/list_acs_users

POSThttps://connect.getseam.com/user_identities/list_acs_users

Authorization

api_keypat_with_workspaceconsole_session

Body

application/json

user_identity_id*string (uuid)

Response

200400401

OK

Body

application/json

acs_users*array of acs_user (object)

ok*boolean

Request

JavaScriptCurl

const response = await fetch('https://connect.getseam.com/user_identities/list_acs_users', {
    method: 'POST',
    headers: {
      "Authorization": "Bearer API Key",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "user_identity_id": "123e4567-e89b-12d3-a456-426614174000"
    }),
});
const data = await response.json();

Response

{
  "acs_users": [
    {
      "acs_user_id": "123e4567-e89b-12d3-a456-426614174000",
      "acs_system_id": "123e4567-e89b-12d3-a456-426614174000",
      "hid_acs_system_id": "123e4567-e89b-12d3-a456-426614174000",
      "workspace_id": "123e4567-e89b-12d3-a456-426614174000",
      "created_at": "2024-04-27T07:56:36.136Z",
      "display_name": "text",
      "external_type": "pti_user",
      "external_type_display_name": "text",
      "is_suspended": false,
      "access_schedule": {
        "starts_at": "2024-04-27T07:56:36.136Z",
        "ends_at": "2024-04-27T07:56:36.136Z"
      },
      "user_identity_id": "text",
      "user_identity_full_name": "text",
      "user_identity_email_address": "text",
      "user_identity_phone_number": "text",
      "full_name": "text",
      "email": "[e-mail]",
      "email_address": "[e-mail]",
      "phone_number": "text"
    }
  ],
  "ok": false
}

Request

Specify the user identity for which you want to retrieve all ACS users by including the corresponding user_identity_id in the request body.

Request Body Parameters

Parameter	Type	Description
user_identity_id	String Required	ID of the user identity for which you want to retrieve all ACS users

Sample Request

cURL (bash)

# Use GET or POST.
curl -X 'GET' \
  'https://connect.getseam.com/user_identities/list_acs_users' \
  -H 'accept: application/json' \
  -H 'Authorization: Bearer ${API_KEY}' \
  -H 'Content-Type: application/json' \
  -d '{
  "user_identity_id": "48500a8e-5e7e-4bde-b7e5-0be97cae5d7a"
}'

Go

acsUsers, uErr := client.UserIdentities.ListAcsUsers(context.Background(), &useridentities.UserIdentitiesListAcsUsersRequest{
    UserIdentityId: "48500a8e-5e7e-4bde-b7e5-0be97cae5d7a",
})

if uErr != nil {
    return uErr
}

fmt.Println(acsUsers)
return nil

Response

Returns an acs_users array, in which each returned ACS user (acs_user) contains the following properties:

Property	Description
acs_user_id	ID of the ACS user
display_name	Display name for the ACS user
full_name	Full name of the ACS user
email_address	Email address of the ACS user
phone_number	Unique phone number of the ACS user in E.164 format (for example, [phone])
acs_system_id	ID of the access control system that contains the ACS user
workspace_id	ID of the workspace that contains the ACS user
created_at	Date and time at which the ACS user was created
is_suspended	Boolean value to indicate whether the ACS user is currently suspended
user_identity_id	ID of the user identity associated with the ACS user
user_identity_email_address	Email address for the user identity associated with the ACS user
user_identity_phone_number	Phone number for the user identity associated with the ACS user

This response also includes a Boolean ok status indicator.

Sample Response

JSON

{
  "acs_users": [
    {
      "acs_user_id": "4d223973-0874-4831-8630-bfcb29e6bce0",
      "display_name": "Jean Doe",
      "full_name": "Jean Doe",
      "email_address": "[e-mail]",
      "acs_system_id": "8aaa5fa0-9381-4463-a0ed-85f9c1fbcef4",
      "workspace_id": "398d80b7-3f96-47c2-b85a-6f8ba21d07be",
      "created_at": "2024-01-11T05:45:41.349Z",
      "is_suspended": false,
      "user_identity_id": "48500a8e-5e7e-4bde-b7e5-0be97cae5d7a",
      "user_identity_email_address": "[e-mail]",
      "user_identity_phone_number": "[phone]"
    }
  ],
  "ok": true
}