List Credentials with Access to an Entrance

• Request Parameters

• Response

• Examples

Returns a list of all credentials with access to a specified entrance.

JavaScript

Specify the acs_entrance_id to return all credentials that grant access to the specified entrance.

Code

await seam.acs.entrances.listCredentialsWithAccess({
  acs_entrance_id: "123e4567-e89b-12d3-a456-426614174000",
});

Output

[
  {
    "acs_credential_id": "123e4567-e89b-12d3-a456-426614174000",
    "acs_user_id": "123e4567-e89b-12d3-a456-426614174000",
    "acs_credential_pool_id": "123e4567-e89b-12d3-a456-426614174000",
    "acs_system_id": "123e4567-e89b-12d3-a456-426614174000",
    "parent_acs_credential_id": "123e4567-e89b-12d3-a456-426614174000",
    "display_name": "text",
    "code": "text",
    "card_number": "text",
    "is_issued": false,
    "issued_at": "2024-10-15T12:54:04.155Z",
    "access_method": "code",
    "external_type": "pti_card",
    "external_type_display_name": "text",
    "created_at": "2024-10-15T12:54:04.155Z",
    "workspace_id": "123e4567-e89b-12d3-a456-426614174000",
    "starts_at": "text",
    "ends_at": "text",
    "is_multi_phone_sync_credential": false,
    "is_latest_desired_state_synced_with_provider": false,
    "latest_desired_state_synced_with_provider_at": "2024-10-15T12:54:04.155Z"
  }
]

cURL

Specify the acs_entrance_id to return all credentials that grant access to the specified entrance.

Code

curl --include --request POST "https://connect.getseam.com/acs/entrances/list_credentials_with_access" \
  --header "Authorization: Bearer $SEAM_API_KEY" \
  --json @- <<EOF
{
  "acs_entrance_id": "123e4567-e89b-12d3-a456-426614174000"
}
EOF

Output

{
  "acs_credentials": [
    {
      "acs_credential_id": "123e4567-e89b-12d3-a456-426614174000",
      "acs_user_id": "123e4567-e89b-12d3-a456-426614174000",
      "acs_credential_pool_id": "123e4567-e89b-12d3-a456-426614174000",
      "acs_system_id": "123e4567-e89b-12d3-a456-426614174000",
      "parent_acs_credential_id": "123e4567-e89b-12d3-a456-426614174000",
      "display_name": "text",
      "code": "text",
      "card_number": "text",
      "is_issued": false,
      "issued_at": "2024-10-15T12:54:04.155Z",
      "access_method": "code",
      "external_type": "pti_card",
      "external_type_display_name": "text",
      "created_at": "2024-10-15T12:54:04.155Z",
      "workspace_id": "123e4567-e89b-12d3-a456-426614174000",
      "starts_at": "text",
      "ends_at": "text",
      "is_multi_phone_sync_credential": false,
      "is_latest_desired_state_synced_with_provider": false,
      "latest_desired_state_synced_with_provider_at": "2024-10-15T12:54:04.155Z"
    }
  ]
}

Python

Specify the acs_entrance_id to return all credentials that grant access to the specified entrance.

Code

seam.acs.entrances.list_credentials_with_access(
    acs_entrance_id="123e4567-e89b-12d3-a456-426614174000"
)

Output

[
    AcsCredential(
        acs_credential_id="123e4567-e89b-12d3-a456-426614174000",
        acs_user_id="123e4567-e89b-12d3-a456-426614174000",
        acs_credential_pool_id="123e4567-e89b-12d3-a456-426614174000",
        acs_system_id="123e4567-e89b-12d3-a456-426614174000",
        parent_acs_credential_id="123e4567-e89b-12d3-a456-426614174000",
        display_name="text",
        code="text",
        card_number="text",
        is_issued=false,
        issued_at="2024-10-15T12:54:04.155Z",
        access_method="code",
        external_type="pti_card",
        external_type_display_name="text",
        created_at="2024-10-15T12:54:04.155Z",
        workspace_id="123e4567-e89b-12d3-a456-426614174000",
        starts_at="text",
        ends_at="text",
        is_multi_phone_sync_credential=false,
        is_latest_desired_state_synced_with_provider=false,
        latest_desired_state_synced_with_provider_at="2024-10-15T12:54:04.155Z",
    )
]

Ruby

Specify the acs_entrance_id to return all credentials that grant access to the specified entrance.

Code

seam.acs.entrances.list_credentials_with_access(
  acs_entrance_id: "123e4567-e89b-12d3-a456-426614174000",
)

Output

[
  {
    "acs_credential_id" => "123e4567-e89b-12d3-a456-426614174000",
    "acs_user_id" => "123e4567-e89b-12d3-a456-426614174000",
    "acs_credential_pool_id" => "123e4567-e89b-12d3-a456-426614174000",
    "acs_system_id" => "123e4567-e89b-12d3-a456-426614174000",
    "parent_acs_credential_id" => "123e4567-e89b-12d3-a456-426614174000",
    "display_name" => "text",
    "code" => "text",
    "card_number" => "text",
    "is_issued" => false,
    "issued_at" => "2024-10-15T12:54:04.155Z",
    "access_method" => "code",
    "external_type" => "pti_card",
    "external_type_display_name" => "text",
    "created_at" => "2024-10-15T12:54:04.155Z",
    "workspace_id" => "123e4567-e89b-12d3-a456-426614174000",
    "starts_at" => "text",
    "ends_at" => "text",
    "is_multi_phone_sync_credential" => false,
    "is_latest_desired_state_synced_with_provider" => false,
    "latest_desired_state_synced_with_provider_at" => "2024-10-15T12:54:04.155Z",
  },
]

PHP

Specify the acs_entrance_id to return all credentials that grant access to the specified entrance.

Code

<?php
$seam->acs->entrances->list_credentials_with_access(
    acs_entrance_id: "123e4567-e89b-12d3-a456-426614174000"
);

Output

<?php
[
    [
        "acs_credential_id" => "123e4567-e89b-12d3-a456-426614174000",
        "acs_user_id" => "123e4567-e89b-12d3-a456-426614174000",
        "acs_credential_pool_id" => "123e4567-e89b-12d3-a456-426614174000",
        "acs_system_id" => "123e4567-e89b-12d3-a456-426614174000",
        "parent_acs_credential_id" => "123e4567-e89b-12d3-a456-426614174000",
        "display_name" => "text",
        "code" => "text",
        "card_number" => "text",
        "is_issued" => false,
        "issued_at" => "2024-10-15T12:54:04.155Z",
        "access_method" => "code",
        "external_type" => "pti_card",
        "external_type_display_name" => "text",
        "created_at" => "2024-10-15T12:54:04.155Z",
        "workspace_id" => "123e4567-e89b-12d3-a456-426614174000",
        "starts_at" => "text",
        "ends_at" => "text",
        "is_multi_phone_sync_credential" => false,
        "is_latest_desired_state_synced_with_provider" => false,
        "latest_desired_state_synced_with_provider_at" =>
            "2024-10-15T12:54:04.155Z",
    ],
];

Go

Specify the acs_entrance_id to return all credentials that grant access to the specified entrance.

Code

package main

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

func main() {
	client.Acs.Entrances.ListCredentialsWithAccess(
		context.Background(),
		entrances.EntrancesListCredentialsWithAccessRequest{
			AcsEntranceId: api.String("123e4567-e89b-12d3-a456-426614174000"),
		},
	)
}

Output

[]api.AcsCredential{api.AcsCredential{AcsCredentialId: "123e4567-e89b-12d3-a456-426614174000", AcsUserId: "123e4567-e89b-12d3-a456-426614174000", AcsCredentialPoolId: "123e4567-e89b-12d3-a456-426614174000", AcsSystemId: "123e4567-e89b-12d3-a456-426614174000", ParentAcsCredentialId: "123e4567-e89b-12d3-a456-426614174000", DisplayName: "text", Code: "text", CardNumber: "text", IsIssued: false, IssuedAt: "2024-10-15T12:54:04.155Z", AccessMethod: "code", ExternalType: "pti_card", ExternalTypeDisplayName: "text", CreatedAt: "2024-10-15T12:54:04.155Z", WorkspaceId: "123e4567-e89b-12d3-a456-426614174000", StartsAt: "text", EndsAt: "text", IsMultiPhoneSyncCredential: false, IsLatestDesiredStateSyncedWithProvider: false, LatestDesiredStateSyncedWithProviderAt: "2024-10-15T12:54:04.155Z"}}

Seam CLI

Specify the acs_entrance_id to return all credentials that grant access to the specified entrance.

Code

seam acs entrances list-credentials-with-access --acs_entrance_id "123e4567-e89b-12d3-a456-426614174000"

Output

[
  {
    "acs_credential_id": "123e4567-e89b-12d3-a456-426614174000",
    "acs_user_id": "123e4567-e89b-12d3-a456-426614174000",
    "acs_credential_pool_id": "123e4567-e89b-12d3-a456-426614174000",
    "acs_system_id": "123e4567-e89b-12d3-a456-426614174000",
    "parent_acs_credential_id": "123e4567-e89b-12d3-a456-426614174000",
    "display_name": "text",
    "code": "text",
    "card_number": "text",
    "is_issued": false,
    "issued_at": "2024-10-15T12:54:04.155Z",
    "access_method": "code",
    "external_type": "pti_card",
    "external_type_display_name": "text",
    "created_at": "2024-10-15T12:54:04.155Z",
    "workspace_id": "123e4567-e89b-12d3-a456-426614174000",
    "starts_at": "text",
    "ends_at": "text",
    "is_multi_phone_sync_credential": false,
    "is_latest_desired_state_synced_with_provider": false,
    "latest_desired_state_synced_with_provider_at": "2024-10-15T12:54:04.155Z"
  }
]

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_entrance_id String (Required)

ID of the entrance for which you want to list all credentials that grant access.

---

include_if Array of Enums

Conditions that credentials must meet to be included in the returned list.

Enum values

Possible enum values:

• visionline_metadata.is_valid

---

Response

Array of acs_credentials

---

Examples