Get an Access Group

Get a specified access group

Returns a specified access group.

/acs/access_groups/get

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

Authorization

client_sessionpat_with_workspaceconsole_sessionapi_key

Body

application/json

acs_access_group_id*string (uuid)

Response

200400401

OK

Body

application/json

acs_access_group*acs_access_group (object)

ok*boolean

Request

JavaScriptCurl

const response = await fetch('https://connect.getseam.com/acs/access_groups/get', {
    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_access_group": {
    "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-27T12:55:10.896Z"
  },
  "ok": false
}

Request

Specify the desired access group 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 desired access group

Sample Request

Python

seam.acs.access_groups.get(
  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/get' \
  -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.get({
  acs_access_group_id: "44444444-4444-4444-4444-444444444444"
});

Ruby

# Coming Soon!

PHP

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

C#

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

Java

// Coming soon!

Go

acs_access_group, uErr := client.Acs.AccessGroups.Get(
  context.Background(), &acs.AccessGroupsGetRequest{
    AcsAccessGroupId: "44444444-4444-4444-4444-444444444444",
  },
)

Response

Returns an acs_access_group containing 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_group": {
    "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_group": {
    "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
}