List Entrances

• Request Parameters

• Response

• Examples

Returns a list of all access system entrances.

Signature

POST /acs/entrances/list ⇒ { acs_entrances: [acs_entrance, …] }

Authentication Methods

• API key

• Client session token

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

To learn more, see Authentication.

Request Parameters

acs_credential_id String

ID of the credential for which you want to retrieve all entrances.

---

acs_system_id String

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

---

Response

Array of acs_entrances

JSON

{
  JSON representation of acs_entrance
}

---

Examples

List entrances

To filter the list of entrances, specify the desired acs_system_id or acs_user_id.

JavaScript

Code

await seam.acs.entrances.list();

Output

[
  {
    "acs_system_id": "123e4567-e89b-12d3-a456-426614174000",
    "acs_entrance_id": "123e4567-e89b-12d3-a456-426614174000",
    "created_at": "2024-04-05T07:57:05.323Z",
    "display_name": "text"
  }
]

Python

Code

seam.acs.entrances.list()

Output

[
    AcsEntrance(
        acs_system_id="123e4567-e89b-12d3-a456-426614174000",
        acs_entrance_id="123e4567-e89b-12d3-a456-426614174000",
        created_at="2024-04-05T07:57:05.323Z",
        display_name="text",
    )
]

Ruby

Code

seam.acs.entrances.list()

Output

[
  {
    "acs_system_id" => "123e4567-e89b-12d3-a456-426614174000",
    "acs_entrance_id" => "123e4567-e89b-12d3-a456-426614174000",
    "created_at" => "2024-04-05T07:57:05.323Z",
    "display_name" => "text",
  },
]

PHP

Code

<?php
$seam->acs->entrances->list();

Output

<?php
[
    [
        "acs_system_id" => "123e4567-e89b-12d3-a456-426614174000",
        "acs_entrance_id" => "123e4567-e89b-12d3-a456-426614174000",
        "created_at" => "2024-04-05T07:57:05.323Z",
        "display_name" => "text",
    ],
];

Seam CLI

Code

seam acs entrances list

Output

[
  {
    "acs_system_id": "123e4567-e89b-12d3-a456-426614174000",
    "acs_entrance_id": "123e4567-e89b-12d3-a456-426614174000",
    "created_at": "2024-04-05T07:57:05.323Z",
    "display_name": "text"
  }
]

Go

Code

package main

func main() {
	client.Acs.Entrances.List(context.Background())
}

Output

[]api.AcsEntrance{api.AcsEntrance{AcsSystemId: "123e4567-e89b-12d3-a456-426614174000", AcsEntranceId: "123e4567-e89b-12d3-a456-426614174000", CreatedAt: "2024-04-05T07:57:05.323Z", DisplayName: "text"}}

cURL

Code

curl --include --request POST "https://connect.getseam.com/acs/entrances/list" \
  --header "Authorization: Bearer $SEAM_API_KEY"

Output

{
  "acs_entrances": [
    {
      "acs_system_id": "123e4567-e89b-12d3-a456-426614174000",
      "acs_entrance_id": "123e4567-e89b-12d3-a456-426614174000",
      "created_at": "2024-04-05T07:57:05.323Z",
      "display_name": "text"
    }
  ]
}