List ACS Users

POST /acs/users/list ⇒ { acs_users: [acs_user, …] }

Returns a list of all ACS users.

Request

await seam.acs.users.list();

Response

{
  "acs_user_id": "123e4567-e89b-12d3-a456-426614174000",
  "acs_system_id": "123e4567-e89b-12d3-a456-426614174000",
  "acs_access_group_ids": ["123e4567-e89b-12d3-a456-426614174000"],
  "workspace_id": "123e4567-e89b-12d3-a456-426614174000",
  "created_at": "2024-04-05T07:57:05.323Z",
  "display_name": "Jane Doe",
  "full_name": "Jane Doe",
  "email_address": "jane@example.com",
  "phone_number": "+15555550100"
}

Authentication Methods

  • API key

  • Client session token

  • Personal access token

Request Parameters

acs_system_id

Type: string Required: No

ID of the acs_system for which you want to retrieve all acs_users.


created_before

Type: string Required: No


limit

Type: number Required: No


user_identity_email_address

Type: string Required: No

Email address of the user identity for which you want to retrieve all acs_users.


user_identity_id

Type: string Required: No

ID of the user identity for which you want to retrieve all acs_users.


user_identity_phone_number

Type: string Required: No

Phone number of the user identity for which you want to retrieve all acs_users, in E.164 format (for example, +15555550100).


Return Type

Array<acs_user>

Last updated

Logo

© Seam Labs, Inc. All rights reserved.