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.
Returns a list of all access system users in an access group.
ID of the access group for which you want to retrieve all access system users.
POST /acs/access_groups/list_users HTTP/1.1
Host: connect.getseam.com
Authorization: Bearer API Token
Content-Type: application/json
Accept: */*
Content-Length: 62
{
"acs_access_group_id": "123e4567-e89b-12d3-a456-426614174000"
}{
"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": "2025-07-01T05:00:02.710Z",
"display_name": "text",
"external_type": "pti_user",
"external_type_display_name": "text",
"is_suspended": true,
"access_schedule": {
"starts_at": "2025-07-01T05:00:02.710Z",
"ends_at": "2025-07-01T05:00:02.710Z"
},
"user_identity_id": "text",
"user_identity_full_name": "text",
"user_identity_email_address": "text",
"user_identity_phone_number": "text",
"warnings": [
{
"created_at": "2025-07-01T05:00:02.710Z",
"message": "text",
"warning_code": "being_deleted"
}
],
"errors": [
{
"created_at": "2025-07-01T05:00:02.710Z",
"message": "text",
"error_code": "deleted_externally"
}
],
"pending_mutations": [
{
"created_at": "2025-07-01T05:00:02.710Z",
"message": "text",
"mutation_code": "creating"
}
],
"last_successful_sync_at": "2025-07-01T05:00:02.710Z",
"connected_account_id": "123e4567-e89b-12d3-a456-426614174000",
"full_name": "text",
"email_address": "[email protected]",
"phone_number": "text",
"is_managed": true
}
],
"ok": true
}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
acs_access_group_id
String (UUID) Required
ID of the access group for which you want to retrieve all users
Sample Request
seam.acs.access_groups.list_users(
acs_access_group_id="44444444-4444-4444-4444-444444444444"
)Response
Returns an acs_users array, in which each returned acs_user contains the following properties:
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='[email protected]',
email_address='[email protected]',
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='[email protected]',
user_identity_phone_number='+15555550100'
),
...
]Last updated
Was this helpful?