List Users in an Access Group

Get all users for a specified access group

Returns a list of all users in an access group.

/acs/access_groups/list_users

POSThttps://connect.getseam.com/acs/access_groups/list_users

Authorization

Body

acs_access_group_id*string (uuid)

Response

Body

acs_users*array of acs_user (object)

ok*boolean

Request

const response = await fetch('https://connect.getseam.com/acs/access_groups/list_users', {
    method: 'POST',
    headers: {
      "Authorization": "Bearer Client Session Token",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "acs_access_group_id": "123e4567-e89b-12d3-a456-426614174000"
    }),
});
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:42:09.804Z",
      "display_name": "text",
      "external_type": "pti_user",
      "external_type_display_name": "text",
      "is_suspended": false,
      "access_schedule": {
        "starts_at": "2024-04-27T06:42:09.804Z",
        "ends_at": "2024-04-27T06:42:09.804Z"
      },
      "user_identity_id": "text",
      "user_identity_full_name": "text",
      "user_identity_email_address": "text",
      "user_identity_phone_number": "text",
      "full_name": "text",
      "email": "name@gmail.com",
      "email_address": "name@gmail.com",
      "phone_number": "text"
    }
  ],
  "ok": false
}

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

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

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"
)

# 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"
}'

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

# Coming Soon!

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

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

// Coming soon!

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 user (acs_user) contains the following properties:

Property Description

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, `+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`)

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'
  ),
  ...
]

{
  "acs_users": [
    {
      "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"
    },
    ...
  ],
  "ok": true
}

[
  {
    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'
  },
  ...
]

# Coming soon!

[
  {
    "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"
  },
  ...
]

{
  "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"
}
...

// Coming soon!

{
  "acs_users": [
    {
      "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"
    },
    ...
  ],
  "ok": true
}

PreviousRemove a User from an Access Group NextCredentials

Last updated 11 days ago