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.

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

ParameterTypeDescription

user_identity_id

String Required

ID of the user identity for which you want to retrieve all ACS users

Sample Request

# 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"
}'

Response

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

PropertyDescription

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, +15555550100)

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

{
  "acs_users": [
    {
      "acs_user_id": "4d223973-0874-4831-8630-bfcb29e6bce0",
      "display_name": "Jean Doe",
      "full_name": "Jean Doe",
      "email_address": "jean@example.com",
      "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": "jean@example.com",
      "user_identity_phone_number": "+15555550110"
    }
  ],
  "ok": true
}

Last updated

Logo

Š Seam Labs, Inc. All rights reserved.