List Users

Get all ACS users

Returns a list of all ACS users.

/acs/users/list

POSThttps://connect.getseam.com/acs/users/list

Authorization

client_sessionpat_with_workspaceconsole_sessionapi_key

Body

application/json

user_identity_idstring (uuid)

user_identity_phone_numbernullable string

user_identity_email_addressstring

acs_system_idstring (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/acs/users/list', {
    method: 'POST',
    headers: {
      "Authorization": "Bearer Client Session Token",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
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-27T06:07:44.302Z",
      "display_name": "text",
      "external_type": "pti_user",
      "external_type_display_name": "text",
      "is_suspended": false,
      "access_schedule": {
        "starts_at": "2024-04-27T06:07:44.302Z",
        "ends_at": "2024-04-27T06:07:44.302Z"
      },
      "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

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

Parameter	Type	Description
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, [phone])
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

Python

seam.acs.users.list(
  user_identity_id="22222222-2222-2222-2222-222222222222",
  user_identity_phone_number="[phone]",
  user_identity_email_address="[e-mail]",
  acs_system_id="11111111-1111-1111-1111-111111111111"
)

cURL (bash)

# Use GET or POST.
curl -X 'GET' \
  'https://connect.getseam.com/acs/users/list' \
  -H 'accept: application/json' \
  -H "Authorization: Bearer ${API_KEY}" \
  -H 'Content-Type: application/json' \
  -d '{
  "user_identity_id": "22222222-2222-2222-2222-222222222222",
  "user_identity_phone_number": "[phone]",
  "user_identity_email_address": "[e-mail]",
  "acs_system_id": "11111111-1111-1111-1111-111111111111"
}'

JavaScript

await seam.acs.users.list({
  user_identity_id: "22222222-2222-2222-2222-222222222222",
  user_identity_phone_number: "[phone]",
  user_identity_email_address: "[e-mail]",
  acs_system_id: "11111111-1111-1111-1111-111111111111"
});

Ruby

# Coming soon!

PHP

$seam->acs->users->list(
  user_identity_id: "22222222-2222-2222-2222-222222222222",
  user_identity_phone_number: "[phone]",
  user_identity_email_address: "[e-mail]",
  acs_system_id: "11111111-1111-1111-1111-111111111111"
);

C#

seam.UsersAcs.List(
  userIdentityId: "22222222-2222-2222-2222-222222222222",
  userIdentityPhoneNumber: "[phone]",
  userIdentityEmailAddress: "[e-mail]",
  acsSystemId: "11111111-1111-1111-1111-111111111111"
);

Java

// Coming soon!

Go

acs_users, uErr := client.Acs.Users.List(
  context.Background(), &acs.UsersListRequest{
    UserIdentityId: api.String("22222222-2222-2222-2222-222222222222"),
    UserIdentityPhoneNumber: api.String("[phone]"),
    UserIdentityEmailAddress: api.String("[e-mail]"),
    AcsSystemId: api.String("11111111-1111-1111-1111-111111111111")
  },
)

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	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, [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	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, [phone])

Sample Response

Python

[
  AcsUser(
    acs_user_id="33333333-3333-3333-3333-333333333333',
    display_name='Jane Doe',
    full_name='Jane Doe',
    email='[e-mail]',
    email_address='[e-mail]',
    phone_number='[phone]',
    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='[e-mail]',
    user_identity_phone_number='[phone]'
  ),
  ...
]

cURL (bash)

{
  "acs_users": [
    {
      "acs_user_id": "33333333-3333-3333-3333-333333333333",
      "display_name": "Jane Doe",
      "full_name": "Jane Doe",
      "email": "[e-mail]",
      "email_address": "[e-mail]",
      "phone_number": "[phone]",
      "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": "[e-mail]",
      "user_identity_phone_number": "[phone]"
    },
    ...
  ],
  "ok": true
}

JavaScript

[
  {
    acs_user_id: '33333333-3333-3333-3333-333333333333',
    display_name: 'Jane Doe',
    full_name: 'Jane Doe',
    email: '[e-mail]',
    email_address: '[e-mail]',
    phone_number: '[phone]',
    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: '[e-mail]',
    user_identity_phone_number: '[phone]'
  },
  ...
]

Ruby

# Coming soon!

PHP

[
  {
    "acs_user_id": "33333333-3333-3333-3333-333333333333",
    "display_name": "Jane Doe",
    "full_name": "Jane Doe",
    "email": "[e-mail]",
    "email_address": "[e-mail]",
    "phone_number": "[phone]",
    "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": "[e-mail]",
    "user_identity_phone_number": "[phone]"
  },
  ...
]

C#

{
  "acs_user_id": "33333333-3333-3333-3333-333333333333",
  "display_name": "Jane Doe",
  "full_name": "Jane Doe",
  "email": "[e-mail]",
  "email_address": "[e-mail]",
  "phone_number": "[phone]",
  "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": "[e-mail]",
  "user_identity_phone_number": "[phone]"
}
...

Java

// Coming soon!

Go

{
  "acs_users": [
    {
      "acs_user_id": "33333333-3333-3333-3333-333333333333",
      "display_name": "Jane Doe",
      "full_name": "Jane Doe",
      "email": "[e-mail]",
      "email_address": "[e-mail]",
      "phone_number": "[phone]",
      "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": "[e-mail]",
      "user_identity_phone_number": "[phone]"
    },
    ...
  ],
  "ok": true
}