Skip to content

Latest commit

 

History

History
257 lines (228 loc) · 9.87 KB

list-credentials.md

File metadata and controls

257 lines (228 loc) · 9.87 KB
Raw
description
Get all credentials

List Credentials

Returns a list of all credentials.

{% swagger src="https://connect.getseam.com/openapi.json" path="/acs/credentials/list" method="post" %} https://connect.getseam.com/openapi.json {% endswagger %}

Request

Filter the list of returned credentials by ACS user, access control system, or user identity by including one or more of the acs_user_id, acs_system_id, or user_identity_id parameters, respectively, in the request body. You can also include the is_multi_phone_sync_credential parameter.

Request Body Parameters

ParameterTypeDescription
acs_user_idString (UUID)
Optional		ID of the user for which you want to retrieve all credentials
acs_system_idString (UUID)
Optional		ID of the access control system for which you want to retrieve all credentials
user_identity_idString (UUID)
Optional		ID of the user identity for which you want to retrieve all credentials
is_multi_phone_sync_credentialBoolean
Optional		Indicates whether you want to retrieve only multi-phone sync credentials or non-multi-phone sync credentials

Sample Request

{% tabs %} {% tab title="Python" %}

seam.acs.credentials.list(
  acs_user_id="33333333-3333-3333-3333-333333333333",
  acs_system_id="11111111-1111-1111-1111-111111111111",
  user_identity_id="22222222-2222-2222-2222-222222222222",
  is_multi_phone_sync_credential=True
)

{% endtab %}

{% tab title="cURL (bash)" %}

# Use GET or POST.
curl -X 'GET' \
  'https://connect.getseam.com/acs/credentials/list' \
  -H 'accept: application/json' \
  -H "Authorization: Bearer ${API_KEY}" \
  -H 'Content-Type: application/json' \
  -d '{
  "acs_user_id": "33333333-3333-3333-3333-333333333333",
  "acs_system_id": "11111111-1111-1111-1111-111111111111",
  "user_identity_id": "22222222-2222-2222-2222-222222222222",
  "is_multi_phone_sync_credential": true
}'

{% endtab %}

{% tab title="JavaScript" %}

await seam.acs.credentials.list({
  acs_user_id: "33333333-3333-3333-3333-333333333333",
  acs_system_id: "11111111-1111-1111-1111-111111111111",
  user_identity_id: "22222222-2222-2222-2222-222222222222",
  is_multi_phone_sync_credential: true
});

{% endtab %}

{% tab title="Ruby" %}

# Coming soon!

{% endtab %}

{% tab title="PHP" %}

$seam->acs->credentials->list(
  acs_user_id: "33333333-3333-3333-3333-333333333333",
  acs_system_id: "11111111-1111-1111-1111-111111111111",
  user_identity_id: "22222222-2222-2222-2222-222222222222",
  is_multi_phone_sync_credential: true
);

{% endtab %}

{% tab title="C#" %}

seam.CredentialsAcs.List(
  acsUserId: "33333333-3333-3333-3333-333333333333",
  acsSystemId: "11111111-1111-1111-1111-111111111111",
  userIdentityId: "22222222-2222-2222-2222-222222222222",
  is_multi_phone_sync_credential: true
);

{% endtab %}

{% tab title="Java" %}

// Coming soon!

{% endtab %}

{% tab title="Go" %}

acs_credentials, uErr := client.Acs.Credentials.List(
  context.Background(), &acs.CredentialsListRequest{
    AcsUserId: api.String("33333333-3333-3333-3333-333333333333"),
    AcsSystemId: api.String("11111111-1111-1111-1111-111111111111"),
    UserIdentityId: api.String("22222222-2222-2222-2222-222222222222"),
    IsMultiPhoneSyncCredential: api.Bool(true),
  },
)

{% endtab %} {% endtabs %}

Response

Returns an acs_credentials array, in which each returned credential (acs_credential) contains the following properties:

PropertyDescription
acs_credential_idID of the credential
acs_user_idID of the user to whom the credential belongs
display_nameDisplay name that corresponds to the credential type
codeAccess (PIN) code for the credential
acs_system_idID of the access control system that contains the credential
access_methodAccess method for the credential. Supported values: code, card, mobile_key
external_typeBrand-specific terminology for the credential type
external_type_display_nameDisplay name that corresponds to the brand-specific terminology for the credential type
workspace_idID of the workspace that contains the credential
created_atDate and time at which the credential was created
is_multi_phone_sync_credentialIndicates whether the credential is a multi-phone sync credential
starts_atDate and time at which the credential validity starts, in ISO 8601 format
ends_atDate and time at which the credential validity ends, in ISO 8601 format
XXX_metadataACS manufacturer-specific metadata for the credential, where XXX is the manufacturer

Sample Response

{% hint style="info" %} This response contains manufacturer-specific metadata that may vary by manufacturer. {% endhint %}

{% tabs %} {% tab title="Python" %}

[
  AcsCredential(
    acs_credential_id='99999999-9999-9999-9999-999999999999',
    acs_user_id='33333333-3333-3333-3333-333333333333',
    display_name='Multi Phone Sync Credential',
    code=null,
    acs_system_id='11111111-1111-1111-1111-111111111111',
    access_method='mobile_key',
    workspace_id='00000000-0000-0000-0000-000000000000',
    created_at='2024-04-12T03:56:22.396Z',
    is_multi_phone_sync_credential=True,
    # manufacturer-specific metadata
  ),
  ...
]

{% endtab %}

{% tab title="cURL (bash)" %}

{
  "acs_credentials": [
    {
      "acs_credential_id": "99999999-9999-9999-9999-999999999999",
      "acs_user_id": "33333333-3333-3333-3333-333333333333",
      "display_name": "Multi Phone Sync Credential",
      "code": null,
      "acs_system_id": "11111111-1111-1111-1111-111111111111",
      "access_method": "mobile_key",
      "workspace_id": "00000000-0000-0000-0000-000000000000",
      "created_at": "2024-04-12T03:56:22.396Z",
      "is_multi_phone_sync_credential": true,
      # manufacturer-specific metadata
    }
    ...
  ],
  "ok": true
}

{% endtab %}

{% tab title="JavaScript" %}

[
  {
    acs_credential_id: '99999999-9999-9999-9999-999999999999',
    acs_user_id: '33333333-3333-3333-3333-333333333333',
    display_name: 'Multi Phone Sync Credential',
    code: null,
    acs_system_id: '11111111-1111-1111-1111-111111111111',
    access_method: 'mobile_key',
    workspace_id: '00000000-0000-0000-0000-000000000000',
    created_at: '2024-04-12T03:56:22.396Z',
    is_multi_phone_sync_credential: true,
    // manufacturer-specific metadata
  },
  ...
]

{% endtab %}

{% tab title="Ruby" %}

# Coming soon!

{% endtab %}

{% tab title="PHP" %}

[
  {
    "acs_credential_id": "99999999-9999-9999-9999-999999999999",
    "acs_user_id": "33333333-3333-3333-3333-333333333333",
    "display_name": "Multi Phone Sync Credential",
    "code": null,
    "acs_system_id": "11111111-1111-1111-1111-111111111111",
    "access_method": "mobile_key",
    "workspace_id": "00000000-0000-0000-0000-000000000000",
    "created_at": "2024-04-12T03:56:22.396Z",
    "is_multi_phone_sync_credential": true,
    // manufacturer-specific metadata
  },
  ...
]

{% endtab %}

{% tab title="C#" %}

{
  "acs_credential_id": "99999999-9999-9999-9999-999999999999",
  "acs_user_id": "33333333-3333-3333-3333-333333333333",
  "display_name": "Multi Phone Sync Credential",
  "code": null,
  "acs_system_id": "11111111-1111-1111-1111-111111111111",
  "access_method": "mobile_key",
  "workspace_id": "00000000-0000-0000-0000-000000000000",
  "created_at": "2024-04-12T03:56:22.396Z",
  "is_multi_phone_sync_credential": true,
  // manufacturer-specific metadata
}
...

{% endtab %}

{% tab title="Java" %}

// Coming soon!

{% endtab %}

{% tab title="Go" %}

{
  "acs_credentials": [
    {
      "acs_credential_id": "99999999-9999-9999-9999-999999999999",
      "acs_user_id": "33333333-3333-3333-3333-333333333333",
      "display_name": "Multi Phone Sync Credential",
      "code": null,
      "acs_system_id": "11111111-1111-1111-1111-111111111111",
      "access_method": "mobile_key",
      "workspace_id": "00000000-0000-0000-0000-000000000000",
      "created_at": "2024-04-12T03:56:22.396Z",
      "is_multi_phone_sync_credential": true,
      # manufacturer-specific metadata
    }
    ...
  ],
  "ok": true
}

{% endtab %} {% endtabs %}