List Access Groups

Get all access groups

Returns a list of all access groups.

/acs/access_groups/list

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

Authorization

pat_with_workspaceconsole_sessionapi_key

Body

application/json

acs_system_idstring (uuid)

acs_user_idstring (uuid)

Response

200400401

OK

Body

application/json

acs_access_groups*array of acs_access_group (object)

ok*boolean

Request

JavaScriptCurl

const response = await fetch('https://connect.getseam.com/acs/access_groups/list', {
    method: 'POST',
    headers: {
      "Authorization": "Bearer API Token",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

{
  "acs_access_groups": [
    {
      "acs_access_group_id": "123e4567-e89b-12d3-a456-426614174000",
      "acs_system_id": "123e4567-e89b-12d3-a456-426614174000",
      "workspace_id": "123e4567-e89b-12d3-a456-426614174000",
      "name": "text",
      "access_group_type": "pti_unit",
      "access_group_type_display_name": "text",
      "external_type": "pti_unit",
      "external_type_display_name": "text",
      "created_at": "2024-04-27T09:24:59.747Z"
    }
  ],
  "ok": false
}

Request

To filter the list of returned access groups by a specific access control system or ACS user, include one or both of the acs_system_id or acs_user_id parameters, respectively, in the request body. If you omit these parameters, the response includes all access groups in your workspace.

Request Body Parameters

Parameter	Type	Description
acs_system_id	String (UUID) Optional	ID of the access control system for which you want to retrieve all access groups
acs_user_id	String (UUID) Optional	ID of the user for which you want to retrieve all access groups

Sample Request

Python

seam.acs.access_groups.list(
  acs_system_id="11111111-1111-1111-1111-111111111111",
  acs_user_id="33333333-3333-3333-3333-333333333333"
)

cURL (bash)

# Use GET or POST.
curl -X 'GET' \
  'https://connect.getseam.com/acs/access_groups/list' \
  -H 'accept: application/json' \
  -H "Authorization: Bearer ${API_KEY}" \
  -H 'Content-Type: application/json' \
  -d '{
  "acs_system_id": "11111111-1111-1111-1111-111111111111",
  "acs_user_id": "33333333-3333-3333-3333-333333333333"
}'

JavaScript

await seam.acs.access_groups.list({
  acs_system_id: "11111111-1111-1111-1111-111111111111",
  acs_user_id: "33333333-3333-3333-3333-333333333333"
});

Ruby

# Coming Soon!

PHP

$seam->acs->access_groups->list(
  acs_system_id: "11111111-1111-1111-1111-111111111111",
  acs_user_id: "33333333-3333-3333-3333-333333333333"
);

C#

seam.AccessGroupsAcs.List(
  acsSystemId: "11111111-1111-1111-1111-111111111111",
  acsUserId: "33333333-3333-3333-3333-333333333333"
);

Java

// Coming soon!

Go

acs_access_groups, uErr := client.Acs.AccessGroups.List(
  context.Background(), &acs.AccessGroupsListRequest{
    AcsSystemId: api.String("11111111-1111-1111-1111-111111111111"),
    AcsUserId: api.String("33333333-3333-3333-3333-333333333333"),
  },
)

Response

Returns an acs_access_groups array, in which each returned access group (acs_access_group) contains the following properties:

Property	Description
acs_access_group_id	ID of the access group
name	Name of the access group
display_name	Display name for the access group
external_type	Brand-specific terminology for the access group type
external_type_display_name	Display name that corresponds to the brand-specific terminology for the access group type
acs_system_id	ID of the access control system that contains the access group
workspace_id	ID of the workspace that contains the access group
created_at	Date and time at which the access group was created

Sample Response

Python

[
  AcsAccessGroup(
    acs_access_group_id='44444444-4444-4444-4444-444444444444',
    acs_system_id='11111111-1111-1111-1111-111111111111',
    workspace_id='00000000-0000-0000-0000-000000000000',
    name='Lobby Access',
    access_group_type='pti_access_level',
    access_group_type_display_name='PTI access level',
    external_type='pti_access_level',
    external_type_display_name='PTI access level',
    created_at='2023-11-30T06:27:15.437Z'
  ),
  ...
]

cURL (bash)

{
  "acs_access_groups": [
    {
      "acs_access_group_id": "44444444-4444-4444-4444-444444444444",
      "name": "Lobby Access",
      "display_name": "Lobby Access",
      "access_group_type_display_name": "PTI access level",
      "access_group_type": "pti_access_level",
      "external_type": "pti_access_level",
      "external_type_display_name": "PTI access level",
      "acs_system_id": "11111111-1111-1111-1111-111111111111",
      "workspace_id": "00000000-0000-0000-0000-000000000000",
      "created_at": "2023-11-30T06:27:15.437Z"
    },
    ...
  ],
  "ok": true
}

JavaScript

[
  {
    acs_access_group_id: '44444444-4444-4444-4444-444444444444',
    name: 'Lobby Access',
    display_name: 'Lobby Access',
    access_group_type_display_name: 'PTI access level',
    access_group_type: 'pti_access_level',
    external_type: 'pti_access_level',
    external_type_display_name: 'PTI access level',
    acs_system_id: '11111111-1111-1111-1111-111111111111',
    workspace_id: '00000000-0000-0000-0000-000000000000',
    created_at: '2023-11-30T06:27:15.437Z'
  },
  ...
]

Ruby

# Coming Soon!

PHP

[
  {
    "acs_access_group_id": "44444444-4444-4444-4444-444444444444",
    "name": "Lobby Access",
    "display_name": "Lobby Access",
    "access_group_type_display_name": "PTI access level",
    "access_group_type": "pti_access_level",
    "external_type": "pti_access_level",
    "external_type_display_name": "PTI access level",
    "acs_system_id": "11111111-1111-1111-1111-111111111111",
    "workspace_id": "00000000-0000-0000-0000-000000000000",
    "created_at": "2023-11-30T06:27:15.437Z"
  },
  ...
]

C#

{
  "acs_access_group_id": "44444444-4444-4444-4444-444444444444",
  "name": "Lobby Access",
  "display_name": "Lobby Access",
  "access_group_type_display_name": "PTI access level",
  "access_group_type": "pti_access_level",
  "external_type": "pti_access_level",
  "external_type_display_name": "PTI access level",
  "acs_system_id": "11111111-1111-1111-1111-111111111111",
  "workspace_id": "00000000-0000-0000-0000-000000000000",
  "created_at": "2023-11-30T06:27:15.437Z"
}
...

Java

// Coming soon!

Go

{
  "acs_access_groups": [
    {
      "acs_access_group_id": "44444444-4444-4444-4444-444444444444",
      "name": "Lobby Access",
      "display_name": "Lobby Access",
      "access_group_type_display_name": "PTI access level",
      "access_group_type": "pti_access_level",
      "external_type": "pti_access_level",
      "external_type_display_name": "PTI access level",
      "acs_system_id": "11111111-1111-1111-1111-111111111111",
      "workspace_id": "00000000-0000-0000-0000-000000000000",
      "created_at": "2023-11-30T06:27:15.437Z"
    },
    ...
  ],
  "ok": true
}