List Access Groups

await seam.acs.accessGroups.list({
  acs_system_id: "1b529056-1b04-450b-b3da-016b65a5017f",
  acs_user_id: "ebe506e1-33ba-44e8-892b-2d12c1709cd8",
  user_identity_id: "9b1deda4-07e2-4e90-acde-5724b6ab7305",
});

/*
[
  {
    "access_group_type": "salto_ks_access_group",
    "access_group_type_display_name": "Salto KS Access Group",
    "acs_access_group_id": "3f448826-9875-4947-9519-e468090a4f7d",
    "acs_system_id": "1b529056-1b04-450b-b3da-016b65a5017f",
    "connected_account_id": "daba7bd0-edb6-4bb9-a70b-f9ae08a0e301",
    "created_at": "2025-06-15T16:54:17.946453Z",
    "display_name": "Main Group",
    "external_type": "salto_ks_access_group",
    "external_type_display_name": "Salto KS Access Group",
    "is_managed": true,
    "name": "My Access Group",
    "pending_mutations": [],
    "warnings": [],
    "workspace_id": "ac19352c-869a-4209-9ce7-44c740a8b5d0"
  }
]
*/

{
  "acs_access_groups": [
    {
      "access_group_type": "pti_unit",
      "access_group_type_display_name": "<string>",
      "acs_access_group_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "acs_system_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "connected_account_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "created_at": "2023-11-07T05:31:56Z",
      "display_name": "<string>",
      "errors": [
        {
          "created_at": "2023-11-07T05:31:56Z",
          "error_code": "failed_to_create_on_acs_system",
          "message": "<string>"
        }
      ],
      "external_type": "pti_unit",
      "external_type_display_name": "<string>",
      "is_managed": true,
      "name": "<string>",
      "pending_mutations": [
        {
          "created_at": "2023-11-07T05:31:56Z",
          "message": "<string>",
          "mutation_code": "creating"
        }
      ],
      "warnings": [
        {
          "created_at": "2023-11-07T05:31:56Z",
          "message": "<string>",
          "warning_code": "unknown_issue_with_acs_access_group"
        }
      ],
      "workspace_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "access_schedule": {
        "ends_at": "2023-11-07T05:31:56Z",
        "starts_at": "2023-11-07T05:31:56Z"
      }
    }
  ]
}

GET

acs

access_groups

list

await seam.acs.accessGroups.list({
  acs_system_id: "1b529056-1b04-450b-b3da-016b65a5017f",
  acs_user_id: "ebe506e1-33ba-44e8-892b-2d12c1709cd8",
  user_identity_id: "9b1deda4-07e2-4e90-acde-5724b6ab7305",
});

/*
[
  {
    "access_group_type": "salto_ks_access_group",
    "access_group_type_display_name": "Salto KS Access Group",
    "acs_access_group_id": "3f448826-9875-4947-9519-e468090a4f7d",
    "acs_system_id": "1b529056-1b04-450b-b3da-016b65a5017f",
    "connected_account_id": "daba7bd0-edb6-4bb9-a70b-f9ae08a0e301",
    "created_at": "2025-06-15T16:54:17.946453Z",
    "display_name": "Main Group",
    "external_type": "salto_ks_access_group",
    "external_type_display_name": "Salto KS Access Group",
    "is_managed": true,
    "name": "My Access Group",
    "pending_mutations": [],
    "warnings": [],
    "workspace_id": "ac19352c-869a-4209-9ce7-44c740a8b5d0"
  }
]
*/

{
  "acs_access_groups": [
    {
      "access_group_type": "pti_unit",
      "access_group_type_display_name": "<string>",
      "acs_access_group_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "acs_system_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "connected_account_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "created_at": "2023-11-07T05:31:56Z",
      "display_name": "<string>",
      "errors": [
        {
          "created_at": "2023-11-07T05:31:56Z",
          "error_code": "failed_to_create_on_acs_system",
          "message": "<string>"
        }
      ],
      "external_type": "pti_unit",
      "external_type_display_name": "<string>",
      "is_managed": true,
      "name": "<string>",
      "pending_mutations": [
        {
          "created_at": "2023-11-07T05:31:56Z",
          "message": "<string>",
          "mutation_code": "creating"
        }
      ],
      "warnings": [
        {
          "created_at": "2023-11-07T05:31:56Z",
          "message": "<string>",
          "warning_code": "unknown_issue_with_acs_access_group"
        }
      ],
      "workspace_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "access_schedule": {
        "ends_at": "2023-11-07T05:31:56Z",
        "starts_at": "2023-11-07T05:31:56Z"
      }
    }
  ]
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

acs_system_id

string<uuid>

ID of the access system for which you want to retrieve all access groups.

acs_user_id

string<uuid>

ID of the access system user for which you want to retrieve all access groups.

user_identity_id

string<uuid>

ID of the user identity for which you want to retrieve all access groups.

string

String for which to search. Filters returned access groups to include all records that satisfy a partial match using name or acs_access_group_id.

Minimum string length: 1

Response

acs_access_groups

object[]

required

Show child attributes

Getting Started

Granting Access

Devices and Systems

Setup

Monitoring

Low-Level APIs

List Access Groups

Authorizations

Query Parameters

Response