Get an Access Group

• Request Parameters

• Response

• Examples

Returns a specified access group.

Signature

POST /acs/access_groups/get ⇒ { acs_access_group }

Authentication Methods

• API key

• Personal access token Must also include the seam-workspace header in the request.

To learn more, see Authentication.

Request Parameters

acs_access_group_id String (Required)

ID of the access group that you want to get.

---

Response

acs_access_group

JSON

{
  JSON representation of acs_access_group
}

---

Examples

Get a specific access group

Specify the acs_access_group_id of the access group that you want to retrieve.

JavaScript

Code

await seam.acs.accessGroups.get({
  acs_access_group_id: "44444444-4444-4444-4444-444444444444",
});

Output

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

Python

Code

seam.acs.access_groups.get(acs_access_group_id="44444444-4444-4444-4444-444444444444")

Output

AcsAccessGroup(
    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

Code

seam.acs.access_groups.get(acs_access_group_id: "44444444-4444-4444-4444-444444444444")

Output

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

PHP

Code

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

Output

<?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",
];

Seam CLI

Code

seam acs access-groups get --acs_access_group_id "44444444-4444-4444-4444-444444444444"

Output

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

Go

Code

package main

import api "github.com/seamapi/go"
import accessgroups "github.com/seamapi/go/accessgroups"

func main() {
	client.Acs.AccessGroups.Get(
		context.Background(),
		accessgroups.AccessGroupsGetRequest{
			AcsAccessGroupId: api.String("44444444-4444-4444-4444-444444444444"),
		},
	)
}

Output

api.AcsAccessGroup{AcsAccessGroupId: "44444444-4444-4444-4444-444444444444", Name: "Lobby Access", DisplayName: "Lobby Access", AccessGroupTypeDisplayName: "PTI access level", AccessGroupType: "pti_access_level", ExternalType: "pti_access_level", ExternalTypeDisplayName: "PTI access level", AcsSystemId: "11111111-1111-1111-1111-111111111111", WorkspaceId: "00000000-0000-0000-0000-000000000000", CreatedAt: "2023-11-30T06:27:15.437Z"}

cURL

Code

curl --include --request POST "https://connect.getseam.com/acs/access_groups/get" \
  --header "Authorization: Bearer $SEAM_API_KEY" \
  --json @- <<EOF
{
  "acs_access_group_id": "44444444-4444-4444-4444-444444444444"
}
EOF

Output

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