Skip to content

Latest commit

 

History

History
229 lines (200 loc) · 8.27 KB

unassign-a-credential-from-a-user.md

File metadata and controls

229 lines (200 loc) · 8.27 KB
Raw
description
Unassign a specified credential from a specified ACS user

Unassign a Credential from a User

Unassigns a specified credential from a specified ACS user.

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

Request

Specify the desired user and credential by including the corresponding acs_user_id and acs_credential_id in the request body.

Request Body Parameters

ParameterTypeDescription
acs_user_idString (UUID)
Required		ID of the desired user
acs_credential_idString (UUID)
Required		ID of the desired credential

Sample Request

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

seam.acs.credentials.unassign(
  acs_user_id="33333333-3333-3333-3333-333333333333",
  acs_credential_id="66666666-6666-6666-6666-666666666666"
)

{% endtab %}

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

curl -X 'POST' \
  'https://connect.getseam.com/acs/credentials/unassign' \
  -H "Authorization: Bearer ${API_KEY}" \
  -H 'Content-Type: application/json' \
  -d '{
  "acs_user_id": "33333333-3333-3333-3333-333333333333",
  "acs_credential_id": "66666666-6666-6666-6666-666666666666"
}'

{% endtab %}

{% tab title="JavaScript" %}

await seam.acs.credentials.unassign({
  acs_user_id: "33333333-3333-3333-3333-333333333333",
  acs_credential_id: "66666666-6666-6666-6666-666666666666"
});

{% endtab %}

{% tab title="Ruby" %}

# Coming soon!

{% endtab %}

{% tab title="PHP" %}

$seam->acs->credentials->unassign(
  acs_user_id: "33333333-3333-3333-3333-333333333333",
  acs_credential_id: "66666666-6666-6666-6666-66666666"
);

{% endtab %}

{% tab title="C#" %}

seam.CredentialsAcs.Unassign(
  acsUserId: "33333333-3333-3333-3333-333333333333",
  acsCredentialId: "66666666-6666-6666-6666-66666666"
);

{% endtab %}

{% tab title="Java" %}

// Coming soon!

{% endtab %}

{% tab title="Go" %}

acs_credential, uErr := client.Acs.Credentials.Unassign(
  context.Background(), &acs.CredentialsUnassignRequest{
    AcsUserId: "33333333-3333-3333-3333-333333333333",
    AcsCredentialId: "66666666-6666-6666-6666-66666666",
  },
)

{% endtab %} {% endtabs %}

Response

Returns an acs_credential containing 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_credential": {
    "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_credential": {
    "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 %}