List Access Groups
Get all access groups
Returns a list of all access groups.
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
Sample Request
seam.acs.access_groups.list(
acs_system_id="11111111-1111-1111-1111-111111111111",
acs_user_id="33333333-3333-3333-3333-333333333333"
)
# 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"
}'
await seam.acs.access_groups.list({
acs_system_id: "11111111-1111-1111-1111-111111111111",
acs_user_id: "33333333-3333-3333-3333-333333333333"
});
# Coming Soon!
$seam->acs->access_groups->list(
acs_system_id: "11111111-1111-1111-1111-111111111111",
acs_user_id: "33333333-3333-3333-3333-333333333333"
);
seam.AccessGroupsAcs.List(
acsSystemId: "11111111-1111-1111-1111-111111111111",
acsUserId: "33333333-3333-3333-3333-333333333333"
);
// Coming soon!
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 acs_access_group
contains the following properties:
Sample Response
[
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'
),
...
]
{
"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
}
[
{
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'
},
...
]
# Coming Soon!
[
{
"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"
},
...
]
{
"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"
}
...
// Coming soon!
{
"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
}
Last updated