List Users

Get all ACS users

Returns a list of all ACS users.

Request

To filter the list of returned ACS users by a specific access control system, user identity, user identity phone number, or user identity email address, include one or more of the acs_system_id, user_identity_id, user_identity_phone_number, or user_identity_email_address parameters, respectively, in the request body. If you omit these parameters, the response includes all ACS users in your workspace.

Request Body Parameters

ParameterTypeDescription

user_identity_id

String (UUID) Optional

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

user_identity_phone_number

String Optional

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

user_identity_email_address

String Optional

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

acs_system_id

String (UUID) Optional

ID of the access control system for which you want to retrieve all ACS users

Sample Request

seam.acs.users.list(
  user_identity_id="22222222-2222-2222-2222-222222222222",
  user_identity_phone_number="+15555550100",
  user_identity_email_address="jane@example.com",
  acs_system_id="11111111-1111-1111-1111-111111111111"
)

Response

Returns an acs_users array, in which each returned 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

Email address of the ACS user (for backward compatibility)

email_address

Email address of the ACS user

phone_number

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

Indicates whether the ACS user is currently suspended

access_schedule

starts_at and ends_at dates/times for the ACS user's access

user_identity_id

ID of the user identity associated with the ACS user

user_identity_full_name

Full name of the user identity associated with the ACS user

user_identity_email_address

Email address of the user identity associated with the ACS user

user_identity_phone_number

Phone number of the user identity associated with the ACS user in E.164 format (for example, +15555550100)

Sample Response

[
  AcsUser(
    acs_user_id="33333333-3333-3333-3333-333333333333',
    display_name='Jane Doe',
    full_name='Jane Doe',
    email='jane@example.com',
    email_address='jane@example.com',
    phone_number='+15555550100',
    acs_system_id='11111111-1111-1111-1111-111111111111',
    workspace_id='00000000-0000-0000-0000-000000000000",
    created_at='2024-04-05T07:14:28.531Z',
    is_suspended=False,
    access_schedule={
      'starts_at': '2024-03-01T10:40:00.000Z',
      'ends_at': '2024-03-04T10:40:00.000Z'
    },
    user_identity_id='22222222-2222-2222-2222-222222222222',
    user_identity_full_name='Jane Doe',
    user_identity_email_address='jane@example.com',
    user_identity_phone_number='+15555550100'
  ),
  ...
]

Last updated

Logo

Š Seam Labs, Inc. All rights reserved.