List Users in an Access Group

Get all users for a specified access group

Returns a list of all ACS users in an access group.

Request

Specify the access group for which you want to retrieve all users by including the corresponding acs_access_group_id in the request body.

Request Body Parameters

Parameter	Type	Description
acs_access_group_id	String (UUID) Required	ID of the access group for which you want to retrieve all users

Sample Request

Python

seam.acs.access_groups.list_users(
  acs_access_group_id="44444444-4444-4444-4444-444444444444"
)

cURL (bash)

# Use GET or POST.
curl -X 'GET' \
  'https://connect.getseam.com/acs/access_groups/list_users' \
  -H 'accept: application/json' \
  -H "Authorization: Bearer ${API_KEY}" \
  -H 'Content-Type: application/json' \
  -d '{
  "acs_access_group_id": "44444444-4444-4444-4444-444444444444"
}'

JavaScript

await seam.acs.access_groups.list_users({
  acs_access_group_id: "44444444-4444-4444-4444-444444444444"
});

Ruby

# Coming Soon!

PHP

$seam->acs->access_groups->list_users(
  acs_access_group_id: "44444444-4444-4444-4444-444444444444"
);

C#

seam.AccessGroupsAcs.ListUsers(
  acsAccessGroupId: "44444444-4444-4444-4444-444444444444"
);

Java

// Coming soon!

Go

acs_users, uErr := client.Acs.AccessGroups.ListUsers(
  context.Background(), &acs.AccessGroupsListUsersRequest{
    AcsAccessGroupId: "44444444-4444-4444-4444-444444444444",
  },
)

Response

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