From fac8c2463905f8d2f9fc728a5a3d49e8f618db56 Mon Sep 17 00:00:00 2001 From: Evan Sosenko Date: Thu, 31 Oct 2024 03:16:35 +0000 Subject: [PATCH] Remove api-clients/acs --- docs/api-clients/acs/README.md | 10 - docs/api-clients/acs/access_groups/README.md | 25 - .../api-clients/acs/access_groups/add_user.md | 155 ------ docs/api-clients/acs/access_groups/get.md | 220 --------- docs/api-clients/acs/access_groups/list.md | 242 --------- .../acs/access_groups/list_users.md | 285 ----------- .../acs/access_groups/remove_user.md | 155 ------ docs/api-clients/acs/credentials/README.md | 26 - docs/api-clients/acs/credentials/assign.md | 229 --------- docs/api-clients/acs/credentials/create.md | 463 ------------------ docs/api-clients/acs/credentials/delete.md | 147 ------ docs/api-clients/acs/credentials/get.md | 223 --------- docs/api-clients/acs/credentials/list.md | 258 ---------- .../credentials/list_accessible_entrances.md | 274 ----------- docs/api-clients/acs/credentials/unassign.md | 229 --------- docs/api-clients/acs/credentials/update.md | 158 ------ docs/api-clients/acs/entrances/README.md | 21 - docs/api-clients/acs/entrances/get.md | 261 ---------- docs/api-clients/acs/entrances/list.md | 277 ----------- .../entrances/list_credentials_with_access.md | 287 ----------- docs/api-clients/acs/systems/README.md | 21 - docs/api-clients/acs/systems/get.md | 225 --------- docs/api-clients/acs/systems/list.md | 228 --------- ...mpatible_credential_manager_acs_systems.md | 261 ---------- docs/api-clients/acs/users/README.md | 27 - .../acs/users/add_to_access_group.md | 155 ------ docs/api-clients/acs/users/create.md | 311 ------------ docs/api-clients/acs/users/delete.md | 150 ------ docs/api-clients/acs/users/get.md | 263 ---------- docs/api-clients/acs/users/list.md | 303 ------------ .../acs/users/remove_from_access_group.md | 156 ------ docs/api-clients/acs/users/suspend.md | 150 ------ docs/api-clients/acs/users/unsuspend.md | 150 ------ docs/api-clients/acs/users/update.md | 202 -------- 34 files changed, 6547 deletions(-) delete mode 100644 docs/api-clients/acs/README.md delete mode 100644 docs/api-clients/acs/access_groups/README.md delete mode 100644 docs/api-clients/acs/access_groups/add_user.md delete mode 100644 docs/api-clients/acs/access_groups/get.md delete mode 100644 docs/api-clients/acs/access_groups/list.md delete mode 100644 docs/api-clients/acs/access_groups/list_users.md delete mode 100644 docs/api-clients/acs/access_groups/remove_user.md delete mode 100644 docs/api-clients/acs/credentials/README.md delete mode 100644 docs/api-clients/acs/credentials/assign.md delete mode 100644 docs/api-clients/acs/credentials/create.md delete mode 100644 docs/api-clients/acs/credentials/delete.md delete mode 100644 docs/api-clients/acs/credentials/get.md delete mode 100644 docs/api-clients/acs/credentials/list.md delete mode 100644 docs/api-clients/acs/credentials/list_accessible_entrances.md delete mode 100644 docs/api-clients/acs/credentials/unassign.md delete mode 100644 docs/api-clients/acs/credentials/update.md delete mode 100644 docs/api-clients/acs/entrances/README.md delete mode 100644 docs/api-clients/acs/entrances/get.md delete mode 100644 docs/api-clients/acs/entrances/list.md delete mode 100644 docs/api-clients/acs/entrances/list_credentials_with_access.md delete mode 100644 docs/api-clients/acs/systems/README.md delete mode 100644 docs/api-clients/acs/systems/get.md delete mode 100644 docs/api-clients/acs/systems/list.md delete mode 100644 docs/api-clients/acs/systems/list_compatible_credential_manager_acs_systems.md delete mode 100644 docs/api-clients/acs/users/README.md delete mode 100644 docs/api-clients/acs/users/add_to_access_group.md delete mode 100644 docs/api-clients/acs/users/create.md delete mode 100644 docs/api-clients/acs/users/delete.md delete mode 100644 docs/api-clients/acs/users/get.md delete mode 100644 docs/api-clients/acs/users/list.md delete mode 100644 docs/api-clients/acs/users/remove_from_access_group.md delete mode 100644 docs/api-clients/acs/users/suspend.md delete mode 100644 docs/api-clients/acs/users/unsuspend.md delete mode 100644 docs/api-clients/acs/users/update.md diff --git a/docs/api-clients/acs/README.md b/docs/api-clients/acs/README.md deleted file mode 100644 index 3dbac3da..00000000 --- a/docs/api-clients/acs/README.md +++ /dev/null @@ -1,10 +0,0 @@ ---- -description: Systems for managing and monitoring access to physical spaces ---- - -# Access Control Systems - -In the Seam platform and API, [Access Control Systems](../../products/access-systems/) (ACSs) consist of the following components: - -
ComponentAPI ObjectDescription
Systemacs_systemAn ACS itself. You create users, access groups, and credentials in the context of an acs_system.
Useracs_userA user to whom to grant access to specific physical spaces.
Entranceacs_entranceA secured door, gate, service, or other method of entry.
Access groupacs_access_groupA group that defines the entrances to which a set of users has access, as well as the access schedule for these entrances and users.
Credentialacs_credentialA means by which a user gains access at an entrance, such as access codes, key cards, and mobile passes.
- diff --git a/docs/api-clients/acs/access_groups/README.md b/docs/api-clients/acs/access_groups/README.md deleted file mode 100644 index e5039da3..00000000 --- a/docs/api-clients/acs/access_groups/README.md +++ /dev/null @@ -1,25 +0,0 @@ ---- -description: >- - Groups that define the entrances to which a set of users has access, as well - as the access schedule for these entrances and users ---- - -# Access Groups - -The `acs_access_group` object represents an [access group](../../../products/access-systems/assigning-users-to-access-groups.md) within an [access control system](../../../products/access-systems/). - -## `acs_access_group` Properties - -The `acs_access_group` object has the following properties: - -
PropertyTypeDescription
acs_access_group_idString (UUID)
Required		ID of the access group
acs_system_idString (UUID)
Required		ID of the access control system that contains the access group
workspace_idString (UUID)
Required		ID of the workspace that contains the access group
nameString
Required		Name of the access group
external_typeString
Required		Brand-specific terminology for the access group type
external_type_display_nameString
Required		Display name that corresponds to the brand-specific terminology for the access group type
created_atString
Required		Date and time at which the access group was created
- -## `acs_access_group` Methods - -You can perform the following actions on `acs_access_group` objects: - -* [List access groups](list.md) -* [Get an access group](get.md) -* [Add a user to an access group](add_user.md) -* [Remove a user from an access group](remove_from_access_group.md) -* [List users in an access group](list_users.md) diff --git a/docs/api-clients/acs/access_groups/add_user.md b/docs/api-clients/acs/access_groups/add_user.md deleted file mode 100644 index b7e9c3c8..00000000 --- a/docs/api-clients/acs/access_groups/add_user.md +++ /dev/null @@ -1,155 +0,0 @@ ---- -description: Add a specified ACS user to a specified access group ---- - -# Add a User to an Access Group - -Adds a specified [ACS user](../../../products/access-systems/user-management.md) to a specified [access group](../../../products/access-systems/assigning-users-to-access-groups.md). - -{% swagger src="https://connect.getseam.com/openapi.json" path="/acs/access_groups/add_user" method="post" %} -[https://connect.getseam.com/openapi.json](https://connect.getseam.com/openapi.json) -{% endswagger %} - -## Request - -Specify the desired access group and user by including the corresponding `acs_access_group_id` and `acs_user_id` in the request body. - -### Request Body Parameters - -
ParameterTypeDescription
acs_access_group_idString (UUID)
Required		ID of the desired access group
acs_user_idString (UUID)
Required		ID of the desired user
- -### Sample Request - -{% tabs %} -{% tab title="Python" %} -```python -seam.acs.access_groups.add_user( - acs_access_group_id="44444444-4444-4444-4444-444444444444", - acs_user_id="33333333-3333-3333-3333-333333333333" -) -``` -{% endtab %} - -{% tab title="cURL (bash)" %} -```bash -curl -X 'POST' \ - 'https://connect.getseam.com/acs/access_groups/add_user' \ - -H "Authorization: Bearer ${API_KEY}" \ - -H 'Content-Type: application/json' \ - -d '{ - "acs_access_group_id": "44444444-4444-4444-4444-444444444444", - "acs_user_id": "33333333-3333-3333-3333-333333333333" -}' -``` -{% endtab %} - -{% tab title="JavaScript" %} -```javascript -await seam.acs.access_groups.addUser({ - acs_access_group_id: "44444444-4444-4444-4444-444444444444", - acs_user_id: "33333333-3333-3333-3333-333333333333" -}); -``` -{% endtab %} - -{% tab title="Ruby" %} -```ruby -# Coming soon! -``` -{% endtab %} - -{% tab title="PHP" %} -```php -$seam->acs->access_groups->add_user( - acs_access_group_id: "44444444-4444-4444-4444-444444444444", - acs_user_id: "33333333-3333-3333-3333-333333333333" -); -``` -{% endtab %} - -{% tab title="C#" %} -```csharp -seam.AccessGroupsAcs.AddUser( - acsAccessGroupId: "44444444-4444-4444-4444-444444444444", - acsUserId: "33333333-3333-3333-3333-333333333333" -); -``` -{% endtab %} - -{% tab title="Java" %} -```java -// Coming soon! -``` -{% endtab %} - -{% tab title="Go" %} -```go -add, uErr := client.Acs.AccessGroups.AddUser( - context.Background(), &acs.AccessGroupsAddUserRequest{ - AcsAccessGroupId: "44444444-4444-4444-4444-444444444444", - AcsUserId: "33333333-3333-3333-3333-333333333333", - }, -) -``` -{% endtab %} -{% endtabs %} - -## Response - -Returns a Boolean `ok` status indicator or void. - -### Sample Response - -{% tabs %} -{% tab title="Python" %} -``` -None -``` -{% endtab %} - -{% tab title="cURL (bash)" %} -```json -{ - "ok": true -} -``` -{% endtab %} - -{% tab title="JavaScript" %} -```json -void -``` -{% endtab %} - -{% tab title="Ruby" %} -``` -# Coming soon! -``` -{% endtab %} - -{% tab title="PHP" %} -``` -void -``` -{% endtab %} - -{% tab title="C#" %} -``` -void -``` -{% endtab %} - -{% tab title="Java" %} -```json -// Coming soon! -``` -{% endtab %} - -{% tab title="Go" %} -```json -{ - "ok": true -} -``` -{% endtab %} -{% endtabs %} diff --git a/docs/api-clients/acs/access_groups/get.md b/docs/api-clients/acs/access_groups/get.md deleted file mode 100644 index 2fbb07d0..00000000 --- a/docs/api-clients/acs/access_groups/get.md +++ /dev/null @@ -1,220 +0,0 @@ ---- -description: Get a specified access group ---- - -# Get an Access Group - -Returns a specified [access group](../../../products/access-systems/assigning-users-to-access-groups.md). - -{% swagger src="https://connect.getseam.com/openapi.json" path="/acs/access_groups/get" method="post" %} -[https://connect.getseam.com/openapi.json](https://connect.getseam.com/openapi.json) -{% endswagger %} - -## Request - -Specify the desired access group by including the corresponding `acs_access_group_id` in the request body. - -### Request Body Parameters - -
ParameterTypeDescription
acs_access_group_idString (UUID)
Required		ID of the desired access group
- -### Sample Request - -{% tabs %} -{% tab title="Python" %} -```python -seam.acs.access_groups.get( - acs_access_group_id="44444444-4444-4444-4444-444444444444" -) -``` -{% endtab %} - -{% tab title="cURL (bash)" %} -```bash -# Use GET or POST. -curl -X 'GET' \ - 'https://connect.getseam.com/acs/access_groups/get' \ - -H 'accept: application/json' \ - -H "Authorization: Bearer ${API_KEY}" \ - -H 'Content-Type: application/json' \ - -d '{ - "acs_access_group_id": "44444444-4444-4444-4444-444444444444" -}' -``` -{% endtab %} - -{% tab title="JavaScript" %} -```javascript -await seam.acs.access_groups.get({ - acs_access_group_id: "44444444-4444-4444-4444-444444444444" -}); -``` -{% endtab %} - -{% tab title="Ruby" %} -```ruby -# Coming Soon! -``` -{% endtab %} - -{% tab title="PHP" %} -```php -$seam->acs->access_groups->get( - acs_access_group_id: "44444444-4444-4444-4444-444444444444" -); -``` -{% endtab %} - -{% tab title="C#" %} -```csharp -seam.AccessGroupsAcs.Get( - acsAccessGroupId: "44444444-4444-4444-4444-444444444444" -); -``` -{% endtab %} - -{% tab title="Java" %} -```java -// Coming soon! -``` -{% endtab %} - -{% tab title="Go" %} -```go -acs_access_group, uErr := client.Acs.AccessGroups.Get( - context.Background(), &acs.AccessGroupsGetRequest{ - AcsAccessGroupId: "44444444-4444-4444-4444-444444444444", - }, -) -``` -{% endtab %} -{% endtabs %} - -## Response - -Returns an `acs_access_group` containing the following properties: - -
PropertyDescription
acs_access_group_idID of the access group
nameName of the access group
display_nameDisplay name for the access group
external_typeBrand-specific terminology for the access group type
external_type_display_nameDisplay name that corresponds to the brand-specific terminology for the access group type
acs_system_idID of the access control system that contains the access group
workspace_idID of the workspace that contains the access group
created_atDate and time at which the access group was created
- -### Sample Response - -{% tabs %} -{% tab title="Python" %} -``` -AcsAccessGroup( - acs_access_group_id='44444444-4444-4444-4444-444444444444', - acs_system_id='11111111-1111-1111-1111-111111111111', - workspace_id='00000000-0000-0000-0000-000000000000', - name='Lobby Access', - access_group_type='pti_access_level', - access_group_type_display_name='PTI access level', - external_type='pti_access_level', - external_type_display_name='PTI access level', - created_at='2023-11-30T06:27:15.437Z' -) -``` -{% endtab %} - -{% tab title="cURL (bash)" %} -```json -{ - "acs_access_group": { - "acs_access_group_id": "44444444-4444-4444-4444-444444444444", - "name": "Lobby Access", - "display_name": "Lobby Access", - "access_group_type_display_name": "PTI access level", - "access_group_type": "pti_access_level", - "external_type": "pti_access_level", - "external_type_display_name": "PTI access level", - "acs_system_id": "11111111-1111-1111-1111-111111111111", - "workspace_id": "00000000-0000-0000-0000-000000000000", - "created_at": "2023-11-30T06:27:15.437Z" - }, - "ok": true -} -``` -{% endtab %} - -{% tab title="JavaScript" %} -```json -{ - acs_access_group_id: '44444444-4444-4444-4444-444444444444', - name: 'Lobby Access', - display_name: 'Lobby Access', - access_group_type_display_name: 'PTI access level', - access_group_type: 'pti_access_level', - external_type: 'pti_access_level', - external_type_display_name: 'PTI access level', - acs_system_id: '11111111-1111-1111-1111-111111111111', - workspace_id: '00000000-0000-0000-0000-000000000000', - created_at: '2023-11-30T06:27:15.437Z' -} -``` -{% endtab %} - -{% tab title="Ruby" %} -``` -# Coming Soon! -``` -{% endtab %} - -{% tab title="PHP" %} -```json -{ - "acs_access_group_id": "44444444-4444-4444-4444-444444444444", - "name": "Lobby Access", - "display_name": "Lobby Access", - "access_group_type_display_name": "PTI access level", - "access_group_type": "pti_access_level", - "external_type": "pti_access_level", - "external_type_display_name": "PTI access level", - "acs_system_id": "11111111-1111-1111-1111-111111111111", - "workspace_id": "00000000-0000-0000-0000-000000000000", - "created_at": "2023-11-30T06:27:15.437Z" -} -``` -{% endtab %} - -{% tab title="C#" %} -```json -{ - "acs_access_group_id": "44444444-4444-4444-4444-444444444444", - "name": "Lobby Access", - "display_name": "Lobby Access", - "access_group_type_display_name": "PTI access level", - "access_group_type": "pti_access_level", - "external_type": "pti_access_level", - "external_type_display_name": "PTI access level", - "acs_system_id": "11111111-1111-1111-1111-111111111111", - "workspace_id": "00000000-0000-0000-0000-000000000000", - "created_at": "2023-11-30T06:27:15.437Z" -} -``` -{% endtab %} - -{% tab title="Java" %} -```json -// Coming soon! -``` -{% endtab %} - -{% tab title="Go" %} -```json -{ - "acs_access_group": { - "acs_access_group_id": "44444444-4444-4444-4444-444444444444", - "name": "Lobby Access", - "display_name": "Lobby Access", - "access_group_type_display_name": "PTI access level", - "access_group_type": "pti_access_level", - "external_type": "pti_access_level", - "external_type_display_name": "PTI access level", - "acs_system_id": "11111111-1111-1111-1111-111111111111", - "workspace_id": "00000000-0000-0000-0000-000000000000", - "created_at": "2023-11-30T06:27:15.437Z" - }, - "ok": true -} -``` -{% endtab %} -{% endtabs %} diff --git a/docs/api-clients/acs/access_groups/list.md b/docs/api-clients/acs/access_groups/list.md deleted file mode 100644 index df0c8f2d..00000000 --- a/docs/api-clients/acs/access_groups/list.md +++ /dev/null @@ -1,242 +0,0 @@ ---- -description: Get all access groups ---- - -# List Access Groups - -Returns a list of all [access groups](../../../products/access-systems/assigning-users-to-access-groups.md). - -{% swagger src="https://connect.getseam.com/openapi.json" path="/acs/access_groups/list" method="post" %} -[https://connect.getseam.com/openapi.json](https://connect.getseam.com/openapi.json) -{% endswagger %} - -## Request - -To filter the list of returned access groups by a specific [access control system](../../../products/access-systems/) or [ACS user](../../../products/access-systems/user-management.md), include one or both of the `acs_system_id` or `acs_user_id` parameters, respectively, in the request body. If you omit these parameters, the response includes all access groups in your [workspace](../../../core-concepts/workspaces/). - -### Request Body Parameters - -
ParameterTypeDescription
acs_system_idString (UUID)
Optional		ID of the access control system for which you want to retrieve all access groups
acs_user_idString (UUID)
Optional		ID of the user for which you want to retrieve all access groups
- -### Sample Request - -{% tabs %} -{% tab title="Python" %} -```python -seam.acs.access_groups.list( - acs_system_id="11111111-1111-1111-1111-111111111111", - acs_user_id="33333333-3333-3333-3333-333333333333" -) -``` -{% endtab %} - -{% tab title="cURL (bash)" %} -```bash -# Use GET or POST. -curl -X 'GET' \ - 'https://connect.getseam.com/acs/access_groups/list' \ - -H 'accept: application/json' \ - -H "Authorization: Bearer ${API_KEY}" \ - -H 'Content-Type: application/json' \ - -d '{ - "acs_system_id": "11111111-1111-1111-1111-111111111111", - "acs_user_id": "33333333-3333-3333-3333-333333333333" -}' -``` -{% endtab %} - -{% tab title="JavaScript" %} -```javascript -await seam.acs.access_groups.list({ - acs_system_id: "11111111-1111-1111-1111-111111111111", - acs_user_id: "33333333-3333-3333-3333-333333333333" -}); -``` -{% endtab %} - -{% tab title="Ruby" %} -```ruby -# Coming Soon! -``` -{% endtab %} - -{% tab title="PHP" %} -```php -$seam->acs->access_groups->list( - acs_system_id: "11111111-1111-1111-1111-111111111111", - acs_user_id: "33333333-3333-3333-3333-333333333333" -); -``` -{% endtab %} - -{% tab title="C#" %} -```csharp -seam.AccessGroupsAcs.List( - acsSystemId: "11111111-1111-1111-1111-111111111111", - acsUserId: "33333333-3333-3333-3333-333333333333" -); -``` -{% endtab %} - -{% tab title="Java" %} -```java -// Coming soon! -``` -{% endtab %} - -{% tab title="Go" %} -```go -acs_access_groups, uErr := client.Acs.AccessGroups.List( - context.Background(), &acs.AccessGroupsListRequest{ - AcsSystemId: api.String("11111111-1111-1111-1111-111111111111"), - AcsUserId: api.String("33333333-3333-3333-3333-333333333333"), - }, -) -``` -{% endtab %} -{% endtabs %} - -## Response - -Returns an `acs_access_groups` array, in which each returned `acs_access_group` contains the following properties: - -
PropertyDescription
acs_access_group_idID of the access group
nameName of the access group
display_nameDisplay name for the access group
external_typeBrand-specific terminology for the access group type
external_type_display_nameDisplay name that corresponds to the brand-specific terminology for the access group type
acs_system_idID of the access control system that contains the access group
workspace_idID of the workspace that contains the access group
created_atDate and time at which the access group was created
- -### Sample Response - -{% tabs %} -{% tab title="Python" %} -``` -[ - AcsAccessGroup( - acs_access_group_id='44444444-4444-4444-4444-444444444444', - acs_system_id='11111111-1111-1111-1111-111111111111', - workspace_id='00000000-0000-0000-0000-000000000000', - name='Lobby Access', - access_group_type='pti_access_level', - access_group_type_display_name='PTI access level', - external_type='pti_access_level', - external_type_display_name='PTI access level', - created_at='2023-11-30T06:27:15.437Z' - ), - ... -] -``` -{% endtab %} - -{% tab title="cURL (bash)" %} -```json -{ - "acs_access_groups": [ - { - "acs_access_group_id": "44444444-4444-4444-4444-444444444444", - "name": "Lobby Access", - "display_name": "Lobby Access", - "access_group_type_display_name": "PTI access level", - "access_group_type": "pti_access_level", - "external_type": "pti_access_level", - "external_type_display_name": "PTI access level", - "acs_system_id": "11111111-1111-1111-1111-111111111111", - "workspace_id": "00000000-0000-0000-0000-000000000000", - "created_at": "2023-11-30T06:27:15.437Z" - }, - ... - ], - "ok": true -} -``` -{% endtab %} - -{% tab title="JavaScript" %} -```json -[ - { - acs_access_group_id: '44444444-4444-4444-4444-444444444444', - name: 'Lobby Access', - display_name: 'Lobby Access', - access_group_type_display_name: 'PTI access level', - access_group_type: 'pti_access_level', - external_type: 'pti_access_level', - external_type_display_name: 'PTI access level', - acs_system_id: '11111111-1111-1111-1111-111111111111', - workspace_id: '00000000-0000-0000-0000-000000000000', - created_at: '2023-11-30T06:27:15.437Z' - }, - ... -] -``` -{% endtab %} - -{% tab title="Ruby" %} -``` -# Coming Soon! -``` -{% endtab %} - -{% tab title="PHP" %} -```json -[ - { - "acs_access_group_id": "44444444-4444-4444-4444-444444444444", - "name": "Lobby Access", - "display_name": "Lobby Access", - "access_group_type_display_name": "PTI access level", - "access_group_type": "pti_access_level", - "external_type": "pti_access_level", - "external_type_display_name": "PTI access level", - "acs_system_id": "11111111-1111-1111-1111-111111111111", - "workspace_id": "00000000-0000-0000-0000-000000000000", - "created_at": "2023-11-30T06:27:15.437Z" - }, - ... -] -``` -{% endtab %} - -{% tab title="C#" %} -```json -{ - "acs_access_group_id": "44444444-4444-4444-4444-444444444444", - "name": "Lobby Access", - "display_name": "Lobby Access", - "access_group_type_display_name": "PTI access level", - "access_group_type": "pti_access_level", - "external_type": "pti_access_level", - "external_type_display_name": "PTI access level", - "acs_system_id": "11111111-1111-1111-1111-111111111111", - "workspace_id": "00000000-0000-0000-0000-000000000000", - "created_at": "2023-11-30T06:27:15.437Z" -} -... -``` -{% endtab %} - -{% tab title="Java" %} -```json -// Coming soon! -``` -{% endtab %} - -{% tab title="Go" %} -```json -{ - "acs_access_groups": [ - { - "acs_access_group_id": "44444444-4444-4444-4444-444444444444", - "name": "Lobby Access", - "display_name": "Lobby Access", - "access_group_type_display_name": "PTI access level", - "access_group_type": "pti_access_level", - "external_type": "pti_access_level", - "external_type_display_name": "PTI access level", - "acs_system_id": "11111111-1111-1111-1111-111111111111", - "workspace_id": "00000000-0000-0000-0000-000000000000", - "created_at": "2023-11-30T06:27:15.437Z" - }, - ... - ], - "ok": true -} -``` -{% endtab %} -{% endtabs %} diff --git a/docs/api-clients/acs/access_groups/list_users.md b/docs/api-clients/acs/access_groups/list_users.md deleted file mode 100644 index 2e867f88..00000000 --- a/docs/api-clients/acs/access_groups/list_users.md +++ /dev/null @@ -1,285 +0,0 @@ ---- -description: Get all users for a specified access group ---- - -# List Users in an Access Group - -Returns a list of all [ACS users](../../../products/access-systems/user-management.md) in an [access group](../../../products/access-systems/assigning-users-to-access-groups.md). - -{% swagger src="https://connect.getseam.com/openapi.json" path="/acs/access_groups/list_users" method="post" %} -[https://connect.getseam.com/openapi.json](https://connect.getseam.com/openapi.json) -{% endswagger %} - -## Request - -Specify the access group for which you want to retrieve all users by including the corresponding `acs_access_group_id` in the request body. - -### Request Body Parameters - -
ParameterTypeDescription
acs_access_group_idString (UUID)
Required		ID of the access group for which you want to retrieve all users
- -### Sample Request - -{% tabs %} -{% tab title="Python" %} -```python -seam.acs.access_groups.list_users( - acs_access_group_id="44444444-4444-4444-4444-444444444444" -) -``` -{% endtab %} - -{% tab title="cURL (bash)" %} -```bash -# Use GET or POST. -curl -X 'GET' \ - 'https://connect.getseam.com/acs/access_groups/list_users' \ - -H 'accept: application/json' \ - -H "Authorization: Bearer ${API_KEY}" \ - -H 'Content-Type: application/json' \ - -d '{ - "acs_access_group_id": "44444444-4444-4444-4444-444444444444" -}' -``` -{% endtab %} - -{% tab title="JavaScript" %} -```javascript -await seam.acs.access_groups.list_users({ - acs_access_group_id: "44444444-4444-4444-4444-444444444444" -}); -``` -{% endtab %} - -{% tab title="Ruby" %} -```ruby -# Coming Soon! -``` -{% endtab %} - -{% tab title="PHP" %} -```php -$seam->acs->access_groups->list_users( - acs_access_group_id: "44444444-4444-4444-4444-444444444444" -); -``` -{% endtab %} - -{% tab title="C#" %} -```csharp -seam.AccessGroupsAcs.ListUsers( - acsAccessGroupId: "44444444-4444-4444-4444-444444444444" -); -``` -{% endtab %} - -{% tab title="Java" %} -```java -// Coming soon! -``` -{% endtab %} - -{% tab title="Go" %} -```go -acs_users, uErr := client.Acs.AccessGroups.ListUsers( - context.Background(), &acs.AccessGroupsListUsersRequest{ - AcsAccessGroupId: "44444444-4444-4444-4444-444444444444", - }, -) -``` -{% endtab %} -{% endtabs %} - -## Response - -Returns an `acs_users` array, in which each returned `acs_user` contains the following properties: - -
PropertyDescription
acs_user_idID of the ACS user
display_nameDisplay name for the ACS user
full_nameFull name of the ACS user
emailEmail address of the ACS user (for backward compatibility)
email_addressEmail address of the ACS user
phone_numberPhone number of the ACS user in E.164 format (for example, +15555550100)
acs_system_idID of the access control system that contains the ACS user
workspace_idID of the workspace that contains the ACS user
created_atDate and time at which the ACS user was created
is_suspendedIndicates whether the ACS user is currently suspended
access_schedulestarts_at and ends_at dates/times for the ACS user's access
user_identity_idID of the user identity associated with the ACS user
user_identity_full_nameFull name of the user identity associated with the ACS user
user_identity_email_addressEmail address of the user identity associated with the ACS user
user_identity_phone_numberPhone number of the user identity associated with the ACS user in E.164 format (for example, +15555550100)
- -### Sample Response - -{% tabs %} -{% tab title="Python" %} -``` -[ - AcsUser( - acs_user_id="33333333-3333-3333-3333-333333333333', - display_name='Jane Doe', - full_name='Jane Doe', - email='jane@example.com', - email_address='jane@example.com', - phone_number='+15555550100', - acs_system_id='11111111-1111-1111-1111-111111111111', - workspace_id='00000000-0000-0000-0000-000000000000", - created_at='2024-04-05T07:14:28.531Z', - is_suspended=False, - access_schedule={ - 'starts_at': '2024-03-01T10:40:00.000Z', - 'ends_at': '2024-03-04T10:40:00.000Z' - }, - user_identity_id='22222222-2222-2222-2222-222222222222', - user_identity_full_name='Jane Doe', - user_identity_email_address='jane@example.com', - user_identity_phone_number='+15555550100' - ), - ... -] -``` -{% endtab %} - -{% tab title="cURL (bash)" %} -```json -{ - "acs_users": [ - { - "acs_user_id": "33333333-3333-3333-3333-333333333333", - "display_name": "Jane Doe", - "full_name": "Jane Doe", - "email": "jane@example.com", - "email_address": "jane@example.com", - "phone_number": "+15555550100", - "acs_system_id": "11111111-1111-1111-1111-111111111111", - "workspace_id": "00000000-0000-0000-0000-000000000000", - "created_at": "2024-04-05T07:14:28.531Z", - "is_suspended": false, - "access_schedule": { - "starts_at": "2024-03-01T10:40:00.000Z", - "ends_at": "2024-03-04T10:40:00.000Z" - }, - "user_identity_id": "22222222-2222-2222-2222-222222222222", - "user_identity_full_name": "Jane Doe", - "user_identity_email_address": "jane@example.com", - "user_identity_phone_number": "+15555550100" - }, - ... - ], - "ok": true -} -``` -{% endtab %} - -{% tab title="JavaScript" %} -```json -[ - { - acs_user_id: '33333333-3333-3333-3333-333333333333', - display_name: 'Jane Doe', - full_name: 'Jane Doe', - email: 'jane@example.com', - email_address: 'jane@example.com', - phone_number: '+15555550100', - acs_system_id: '11111111-1111-1111-1111-111111111111', - workspace_id: '00000000-0000-0000-0000-000000000000', - created_at: '2024-04-05T07:14:28.531Z', - is_suspended: false, - access_schedule: { - "starts_at": "2024-03-01T10:40:00.000Z", - "ends_at": "2024-03-04T10:40:00.000Z" - }, - user_identity_id: '22222222-2222-2222-2222-222222222222', - user_identity_full_name: 'Jane Doe', - user_identity_email_address: 'jane@example.com', - user_identity_phone_number: '+15555550100' - }, - ... -] -``` -{% endtab %} - -{% tab title="Ruby" %} -``` -# Coming soon! -``` -{% endtab %} - -{% tab title="PHP" %} -```json -[ - { - "acs_user_id": "33333333-3333-3333-3333-333333333333", - "display_name": "Jane Doe", - "full_name": "Jane Doe", - "email": "jane@example.com", - "email_address": "jane@example.com", - "phone_number": "+15555550100", - "acs_system_id": "11111111-1111-1111-1111-111111111111", - "workspace_id": "00000000-0000-0000-0000-000000000000", - "created_at": "2024-04-05T07:14:28.531Z", - "is_suspended": false, - "access_schedule": { - "starts_at": "2024-03-01T10:40:00.000Z", - "ends_at": "2024-03-04T10:40:00.000Z" - }, - "user_identity_id": "22222222-2222-2222-2222-222222222222", - "user_identity_full_name": "Jane Doe", - "user_identity_email_address": "jane@example.com", - "user_identity_phone_number": "+15555550100" - }, - ... -] -``` -{% endtab %} - -{% tab title="C#" %} -```json -{ - "acs_user_id": "33333333-3333-3333-3333-333333333333", - "display_name": "Jane Doe", - "full_name": "Jane Doe", - "email": "jane@example.com", - "email_address": "jane@example.com", - "phone_number": "+15555550100", - "acs_system_id": "11111111-1111-1111-1111-111111111111", - "workspace_id": "00000000-0000-0000-0000-000000000000", - "created_at": "2024-04-05T07:14:28.531Z", - "is_suspended": false, - "access_schedule": { - "starts_at": "2024-03-01T10:40:00.000Z", - "ends_at": "2024-03-04T10:40:00.000Z" - }, - "user_identity_id": "22222222-2222-2222-2222-222222222222", - "user_identity_full_name": "Jane Doe", - "user_identity_email_address": "jane@example.com", - "user_identity_phone_number": "+15555550100" -} -... -``` -{% endtab %} - -{% tab title="Java" %} -```json -// Coming soon! -``` -{% endtab %} - -{% tab title="Go" %} -```json -{ - "acs_users": [ - { - "acs_user_id": "33333333-3333-3333-3333-333333333333", - "display_name": "Jane Doe", - "full_name": "Jane Doe", - "email": "jane@example.com", - "email_address": "jane@example.com", - "phone_number": "+15555550100", - "acs_system_id": "11111111-1111-1111-1111-111111111111", - "workspace_id": "00000000-0000-0000-0000-000000000000", - "created_at": "2024-04-05T07:14:28.531Z", - "is_suspended": false, - "access_schedule": { - "starts_at": "2024-03-01T10:40:00.000Z", - "ends_at": "2024-03-04T10:40:00.000Z" - }, - "user_identity_id": "22222222-2222-2222-2222-222222222222", - "user_identity_full_name": "Jane Doe", - "user_identity_email_address": "jane@example.com", - "user_identity_phone_number": "+15555550100" - }, - ... - ], - "ok": true -} -``` -{% endtab %} -{% endtabs %} diff --git a/docs/api-clients/acs/access_groups/remove_user.md b/docs/api-clients/acs/access_groups/remove_user.md deleted file mode 100644 index 18e5ff54..00000000 --- a/docs/api-clients/acs/access_groups/remove_user.md +++ /dev/null @@ -1,155 +0,0 @@ ---- -description: Remove a specified ACS user from a specified access group ---- - -# Remove a User from an Access Group - -Removes a specified [ACS user](../../../products/access-systems/user-management.md) from a specified [access group](../../../products/access-systems/assigning-users-to-access-groups.md). - -{% swagger src="https://connect.getseam.com/openapi.json" path="/acs/access_groups/remove_user" method="post" %} -[https://connect.getseam.com/openapi.json](https://connect.getseam.com/openapi.json) -{% endswagger %} - -## Request - -Specify the desired access group and user by including the corresponding `acs_access_group_id` and `acs_user_id` in the request body. - -### Request Body Parameters - -
ParameterTypeDescription
acs_access_group_idString (UUID)
Required		ID of the desired access group
acs_user_idString (UUID)
Required		ID of the desired user
- -### Sample Request - -{% tabs %} -{% tab title="Python" %} -```python -seam.acs.access_groups.remove_user( - acs_access_group_id="44444444-4444-4444-4444-444444444444", - acs_user_id="33333333-3333-3333-3333-333333333333" -) -``` -{% endtab %} - -{% tab title="cURL (bash)" %} -```bash -curl -X 'POST' \ - 'https://connect.getseam.com/acs/access_groups/remove_user' \ - -H "Authorization: Bearer ${API_KEY}" \ - -H 'Content-Type: application/json' \ - -d '{ - "acs_access_group_id": "44444444-4444-4444-4444-444444444444", - "acs_user_id": "33333333-3333-3333-3333-333333333333" -}' -``` -{% endtab %} - -{% tab title="JavaScript" %} -```javascript -await seam.acs.access_groups.removeUser({ - acs_access_group_id: "44444444-4444-4444-4444-444444444444", - acs_user_id: "33333333-3333-3333-3333-333333333333" -}); -``` -{% endtab %} - -{% tab title="Ruby" %} -```ruby -# Coming soon! -``` -{% endtab %} - -{% tab title="PHP" %} -```php -$seam->acs->access_groups->remove_user( - acs_access_group_id: "44444444-4444-4444-4444-444444444444", - acs_user_id: "33333333-3333-3333-3333-333333333333" -); -``` -{% endtab %} - -{% tab title="C#" %} -```csharp -seam.AccessGroupsAcs.RemoveUser( - acsAccessGroupId: "44444444-4444-4444-4444-444444444444", - acsUserId: "33333333-3333-3333-3333-333333333333" -); -``` -{% endtab %} - -{% tab title="Java" %} -```java -// Coming soon! -``` -{% endtab %} - -{% tab title="Go" %} -```go -remove, uErr := client.Acs.AccessGroups.RemoveUser( - context.Background(), &acs.AccessGroupsRemoveUserRequest{ - AcsAccessGroupId: "44444444-4444-4444-4444-444444444444", - AcsUserId: "33333333-3333-3333-3333-333333333333", - }, -) -``` -{% endtab %} -{% endtabs %} - -## Response - -Returns a Boolean `ok` status indicator or void. - -### Sample Response - -{% tabs %} -{% tab title="Python" %} -``` -None -``` -{% endtab %} - -{% tab title="cURL (bash)" %} -```json -{ - "ok": true -} -``` -{% endtab %} - -{% tab title="JavaScript" %} -```json -void -``` -{% endtab %} - -{% tab title="Ruby" %} -``` -# Coming soon! -``` -{% endtab %} - -{% tab title="PHP" %} -``` -void -``` -{% endtab %} - -{% tab title="C#" %} -``` -void -``` -{% endtab %} - -{% tab title="Java" %} -```json -// Coming soon! -``` -{% endtab %} - -{% tab title="Go" %} -```json -{ - "ok": true -} -``` -{% endtab %} -{% endtabs %} diff --git a/docs/api-clients/acs/credentials/README.md b/docs/api-clients/acs/credentials/README.md deleted file mode 100644 index 364adc77..00000000 --- a/docs/api-clients/acs/credentials/README.md +++ /dev/null @@ -1,26 +0,0 @@ ---- -description: Means by which a user gains access at an entrance ---- - -# Credentials - -The `acs_credential` object represents a [credential](../../../capability-guides/access-systems/managing-credentials.md) that enables an [ACS user](../../../products/access-systems/user-management.md) to access one or more [entrances](../../../capability-guides/access-systems/retrieving-entrance-details.md) within an [access control system](../../../products/access-systems/). For each `acs_credential` object, you define the access method. You can also specify additional properties, such as a code. - -## `acs_credential` Properties - -The `acs_credential` object has the following properties: - -
PropertyTypeDescription
acs_credential_idString (UUID)
Required		ID of the credential
acs_user_idString (UUID)
Optional		ID of the user to whom the credential belongs
acs_system_idString (UUID)
Required		ID of the access control system that contains the credential
parent_acs_credential_idString (UUID)
Optional		ID of the parent credential
display_nameString
Optional		Display name that corresponds to the credential type
codeString
Optional		Access (PIN) code for the credential
access_methodEnum (string)
Required		Access method for the credential. Supported values: code, card, mobile_key
external_typeEnum (string)
Optional		Brand-specific terminology for the credential type
Supported values: pti_card, brivo_credential, hid_credential, visionline_card
external_type_display_nameString
Optional		Display name that corresponds to the brand-specific terminology for the credential type
created_atString
Required		Date and time at which the credential was created
workspace_idString (UUID)
Required		ID of the workspace that contains the credential
starts_atString (datetime)
Optional		Date and time at which the credential validity starts, in ISO 8601 format
ends_atString (datetime)
Optional		Date and time at which the credential validity ends, in ISO 8601 format
Must be a time in the future and after starts_at.
is_multi_phone_sync_credentialBoolean
Optional		Indicates whether the credential is a multi-phone sync credential
XXX_metadataObject
Optional		ACS manufacturer-specific metadata for the credential, where XXX is the manufacturer
- -## `acs_credential` Methods - -You can perform the following actions on `acs_credential` objects: - -* [Create a credential for a user](create.md) -* [Assign a credential to a user](assign.md) -* [List credentials](list.md) -* [Get a credential](get.md) -* [Update a credential](update.md) -* [Unassign a credential from a user](unassign.md) -* [Delete a credential](delete.md) -* [List accessible entrances](list\_accessible\_entrances.md) diff --git a/docs/api-clients/acs/credentials/assign.md b/docs/api-clients/acs/credentials/assign.md deleted file mode 100644 index 8d858fa3..00000000 --- a/docs/api-clients/acs/credentials/assign.md +++ /dev/null @@ -1,229 +0,0 @@ ---- -description: Assign a specified credential to a specified ACS user ---- - -# Assign a Credential to a User - -Assigns a specified [credential](../../../capability-guides/access-systems/managing-credentials.md) to a specified [ACS user](../../../products/access-systems/user-management.md). - -{% swagger src="https://connect.getseam.com/openapi.json" path="/acs/credentials/assign" method="post" %} -[https://connect.getseam.com/openapi.json](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" %} -```python -seam.acs.credentials.assign( - acs_user_id="33333333-3333-3333-3333-333333333333", - acs_credential_id="66666666-6666-6666-6666-666666666666" -) -``` -{% endtab %} - -{% tab title="cURL (bash)" %} -```bash -curl -X 'POST' \ - 'https://connect.getseam.com/acs/credentials/assign' \ - -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" %} -```javascript -await seam.acs.credentials.assign({ - acs_user_id: "33333333-3333-3333-3333-333333333333", - acs_credential_id: "66666666-6666-6666-6666-666666666666" -}); -``` -{% endtab %} - -{% tab title="Ruby" %} -```ruby -# Coming soon! -``` -{% endtab %} - -{% tab title="PHP" %} -```php -$seam->acs->credentials->assign( - acs_user_id: "33333333-3333-3333-3333-333333333333", - acs_credential_id: "66666666-6666-6666-6666-66666666" -); -``` -{% endtab %} - -{% tab title="C#" %} -```csharp -seam.CredentialsAcs.Assign( - acsUserId: "33333333-3333-3333-3333-333333333333", - acsCredentialId: "66666666-6666-6666-6666-66666666" -); -``` -{% endtab %} - -{% tab title="Java" %} -```java -// Coming soon! -``` -{% endtab %} - -{% tab title="Go" %} -```go -acs_credential, uErr := client.Acs.Credentials.Assign( - context.Background(), &acs.CredentialsAssignRequest{ - 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](../../../device-and-system-integration-guides/overview.md#access-control-systems). -{% 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)" %} -```json -{ - "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" %} -```json -{ - 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" %} -```json -{ - "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#" %} -```json -{ - "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" %} -```json -// Coming soon! -``` -{% endtab %} - -{% tab title="Go" %} -```json -{ - "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 %} diff --git a/docs/api-clients/acs/credentials/create.md b/docs/api-clients/acs/credentials/create.md deleted file mode 100644 index ed2eb404..00000000 --- a/docs/api-clients/acs/credentials/create.md +++ /dev/null @@ -1,463 +0,0 @@ ---- -description: Create a new credential for a specified ACS user ---- - -# Create a Credential for a User - -Creates a new [credential](../../../capability-guides/access-systems/managing-credentials.md) for a specified [ACS user](../../../products/access-systems/user-management.md). - -{% swagger src="https://connect.getseam.com/openapi.json" path="/acs/credentials/create" method="post" %} -[https://connect.getseam.com/openapi.json](https://connect.getseam.com/openapi.json) -{% endswagger %} - -## Request - -Specify the user to which the new credential belongs and the access method for the new credential by including the corresponding `acs_user_id` and `access_method` in the request body. You can also specify additional parameters, such as a `code` for the credential. Note that the `access_method` determines the additional required and useful parameters. - -### Request Body Parameters - -
ParameterTypeDescription
acs_user_idString (UUID)
Required		ID of the user to whom the new credential belongs
access_methodEnum (string)
Required		Access method for the new credential. Supported values: code, card, mobile_key
codeString
Optional		Access (PIN) code for the new credential
There may be manufacturer-specific code restrictions. For details, see the applicable device or system integration guide.
is_multi_phone_sync_credentialBoolean
Optional		Indicates whether the new credential is a multi-phone sync credential
allowed_acs_entrance_idsArray of strings (UUIDs)
Optional		Set of IDs of the entrances for which the new credential grants access
credential_manager_acs_system_idEnum (string)
Optional		ACS system ID of the credential manager for the new user
XXX_metadataObject
Optional		ACS manufacturer-specific metadata for the new credential, where XXX is the manufacturer
starts_atDatetime
Optional		Date and time at which the validity of the new credential starts, in ISO 8601 format.
ends_atDatetime
Optional		Date and time at which the validity of the new credential ends, in ISO 8601 format.
Must be a time in the future and after starts_at.
- -### Sample Request - -#### PIN Code-Based Credential - -{% tabs %} -{% tab title="Python" %} -```python -seam.acs.credentials.create( - acs_user_id="33333333-3333-3333-3333-333333333333", - access_method="code", - code="824759" -) -``` -{% endtab %} - -{% tab title="cURL (bash)" %} -```bash -curl -X 'POST' \ - 'https://connect.getseam.com/acs/credentials/create' \ - -H 'accept: application/json' \ - -H "Authorization: Bearer ${API_KEY}" \ - -H 'Content-Type: application/json' \ - -d '{ - "acs_user_id": "33333333-3333-3333-3333-333333333333", - "access_method": "code", - "code": "824759" -}' -``` -{% endtab %} - -{% tab title="JavaScript" %} -```javascript -await seam.acs.credentials.create({ - acs_user_id: "33333333-3333-3333-3333-333333333333", - access_method: "code", - code: "824759" -}); -``` -{% endtab %} - -{% tab title="Ruby" %} -```ruby -# Coming soon! -``` -{% endtab %} - -{% tab title="PHP" %} -```php -$seam->acs->credentials->create( - acs_user_id: "33333333-3333-3333-3333-333333333333", - access_method: "code", - code: "824759" -); -``` -{% endtab %} - -{% tab title="C#" %} -```csharp -seam.CredentialsAcs.Create( - acsUserId: "33333333-3333-3333-3333-333333333333", - accessMethod: "code", - code: "824759" -); -``` -{% endtab %} - -{% tab title="Java" %} -```java -// Coming soon! -``` -{% endtab %} - -{% tab title="Go" %} -```go -credential, uErr := client.Acs.Credentials.Create( - context.Background(), &acs.CredentialsCreateRequest{ - AcsUserId: "33333333-3333-3333-3333-333333333333", - AccessMethod: "code", - Code: api.String("824759"), - }, -); -``` -{% endtab %} -{% endtabs %} - -#### Key Card-Based Credential - -{% tabs %} -{% tab title="Python" %} -```python -seam.acs.credentials.create( - acs_user_id="33333333-3333-3333-3333-333333333333", - access_method="card", - code="123456" -) -``` -{% endtab %} - -{% tab title="cURL (bash)" %} -```bash -curl -X 'POST' \ - 'https://connect.getseam.com/acs/credentials/create' \ - -H 'accept: application/json' \ - -H "Authorization: Bearer ${API_KEY}" \ - -H 'Content-Type: application/json' \ - -d '{ - "acs_user_id": "33333333-3333-3333-3333-333333333333", - "access_method": "card", - "code": "123456" -}' -``` -{% endtab %} - -{% tab title="JavaScript" %} -```javascript -await seam.acs.credentials.create({ - acs_user_id: "33333333-3333-3333-3333-333333333333", - access_method: "card", - code: "123456" -}); -``` -{% endtab %} - -{% tab title="Ruby" %} -```ruby -# Coming soon! -``` -{% endtab %} - -{% tab title="PHP" %} -```php -$seam->acs->credentials->create( - acs_user_id: "33333333-3333-3333-3333-333333333333", - access_method: "card", - code: "123456" -); -``` -{% endtab %} - -{% tab title="C#" %} -```csharp -seam.CredentialsAcs.Create( - acsUserId: "33333333-3333-3333-3333-333333333333", - accessMethod: "card", - code: "123456" -); -``` -{% endtab %} - -{% tab title="Java" %} -```java -// Coming soon! -``` -{% endtab %} - -{% tab title="Go" %} -```go -credential, uErr := client.Acs.Credentials.Create( - context.Background(), &acs.CredentialsCreateRequest{ - AcsUserId: "33333333-3333-3333-3333-333333333333", - AccessMethod: "card", - Code: api.String("123456"), - }, -); -``` -{% endtab %} -{% endtabs %} - -#### Seam Mobile Key - -{% hint style="info" %} -This request contains manufacturer-specific metadata that may vary by [manufacturer](../../../device-and-system-integration-guides/overview.md#access-control-systems). -{% endhint %} - -{% tabs %} -{% tab title="Python" %} -```python -seam.acs.credentials.create( - acs_user_id="33333333-3333-3333-3333-333333333333", - allowed_acs_entrance_ids=[ - "55555555-5555-5555-5555-555555555555", - "55555555-5555-5555-5555-000000000000" - ], - credential_manager_acs_system_id="88888888-8888-8888-8888-888888888888", - access_method="mobile_key", - is_multi_phone_sync_credential=True, - starts_at="2024-03-01T10:40:00Z", - ends_at="2024-03-04T10:40:00Z", - # manufacturer-specific metadata -) -``` -{% endtab %} - -{% tab title="cURL (bash)" %} -```bash -curl -X 'POST' \ - 'https://connect.getseam.com/acs/credentials/create' \ - -H 'accept: application/json' \ - -H "Authorization: Bearer ${API_KEY}" \ - -H 'Content-Type: application/json' \ - -d '{ - "acs_user_id": "33333333-3333-3333-3333-333333333333", - "allowed_acs_entrance_ids": [ - "55555555-5555-5555-5555-555555555555", - "55555555-5555-5555-5555-000000000000" - ], - "credential_manager_acs_system_id": "88888888-8888-8888-8888-888888888888", - "access_method": "mobile_key", - "is_multi_phone_sync_credential": true, - "starts_at": "2024-03-01T10:40:00Z", - "ends_at": "2024-03-04T10:40:00Z", - # manufacturer-specific metadata -}' -``` -{% endtab %} - -{% tab title="JavaScript" %} -```javascript -await seam.acs.credentials.create({ - acs_user_id: "33333333-3333-3333-3333-333333333333", - allowed_acs_entrance_ids: [ - "55555555-5555-5555-5555-555555555555", - "55555555-5555-5555-5555-000000000000" - ], - credential_manager_acs_system_id: "88888888-8888-8888-8888-888888888888", - access_method: "mobile_key", - is_multi_phone_sync_credential: true, - starts_at: "2024-03-01T10:40:00Z", - ends_at: "2024-03-04T10:40:00Z", - // manufacturer-specific metadata -}); -``` -{% endtab %} - -{% tab title="Ruby" %} -```ruby -# Coming soon! -``` -{% endtab %} - -{% tab title="PHP" %} -```php -$seam->acs->credentials->create( - acs_user_id: "33333333-3333-3333-3333-333333333333", - allowed_acs_entrance_ids: [ - "55555555-5555-5555-5555-555555555555", - "55555555-5555-5555-5555-000000000000" - ], - credential_manager_acs_system_id: "88888888-8888-8888-8888-888888888888", - access_method: "mobile_key", - is_multi_phone_sync_credential: true, - starts_at: "2024-03-01T10:40:00Z", - ends_at: "2024-03-04T10:40:00Z", - // manufacturer-specific metadata -); -``` -{% endtab %} - -{% tab title="C#" %} -```csharp -seam.CredentialsAcs.Create( - acsUserId: "33333333-3333-3333-3333-333333333333", - allowedAcsEntranceIds: new List - { - "55555555-5555-5555-5555-555555555555", - "55555555-5555-5555-5555-000000000000" - }, - credentialManagerAcsSystemId: "88888888-8888-8888-8888-888888888888", - accessMethod: "mobile_key", - isMultiPhoneSyncCredential: true, - startsAt: "2024-03-01T10:40:00Z", - endsAt: "2024-03-04T10:40:00Z", - // manufacturer-specific metadata -); -``` -{% endtab %} - -{% tab title="Java" %} -```java -// Coming soon! -``` -{% endtab %} - -{% tab title="Go" %} -```go -startsAt, err := time.Parse(time.RFC3339, "2024-03-01T10:40:00Z") -endsAt, err := time.Parse(time.RFC3339, "2024-03-04T10:40:00Z") -if err != nil { - return err -} - -credential, uErr := client.Acs.Credentials.Create( - context.Background(), &acs.CredentialsCreateRequest{ - AcsUserId: "33333333-3333-3333-3333-333333333333", - AllowedAcsEntranceIds: { - "55555555-5555-5555-5555-555555555555", - "55555555-5555-5555-5555-000000000000", - }, - CredentialManagerAcsSystemId: api.String("88888888-8888-8888-8888-888888888888"), - AccessMethod: "mobile_key", - IsMultiPhoneSyncCredential: api.Bool(true), - StartsAt: api.Time(startsAt), - EndsAt: api.Time(endsAt), - // manufacturer-specific metadata - }, -) -``` -{% 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](../../../device-and-system-integration-guides/overview.md#access-control-systems). -{% 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)" %} -```json -{ - "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" %} -```json -{ - 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" %} -```json -{ - "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#" %} -```json -{ - "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" %} -```json -// Coming soon! -``` -{% endtab %} - -{% tab title="Go" %} -```json -{ - "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 %} diff --git a/docs/api-clients/acs/credentials/delete.md b/docs/api-clients/acs/credentials/delete.md deleted file mode 100644 index d75797c1..00000000 --- a/docs/api-clients/acs/credentials/delete.md +++ /dev/null @@ -1,147 +0,0 @@ ---- -description: Delete a specified credential ---- - -# Delete a Credential - -Deletes a specified [credential](../../../capability-guides/access-systems/managing-credentials.md). - -{% swagger src="https://connect.getseam.com/openapi.json" path="/acs/credentials/delete" method="post" %} -[https://connect.getseam.com/openapi.json](https://connect.getseam.com/openapi.json) -{% endswagger %} - -## Request - -Specify the desired credential by including the corresponding `acs_credential_id` in the request body. - -### Request Body Parameters - -
ParameterTypeDescription
acs_credential_idString (UUID)
Required		ID of the desired credential
- -### Sample Request - -{% tabs %} -{% tab title="Python" %} -```python -seam.acs.credentials.delete( - acs_credential_id="66666666-6666-6666-6666-666666666666" -) -``` -{% endtab %} - -{% tab title="cURL (bash)" %} -```bash -curl -X 'POST' \ - 'https://connect.getseam.com/acs/credentials/delete' \ - -H "Authorization: Bearer ${API_KEY}" \ - -H 'Content-Type: application/json' \ - -d '{ - "acs_credential_id": "66666666-6666-6666-6666-666666666666" -}' -``` -{% endtab %} - -{% tab title="JavaScript" %} -```javascript -await seam.acs.credentials.delete({ - acs_credential_id: "66666666-6666-6666-6666-666666666666" -}); -``` -{% endtab %} - -{% tab title="Ruby" %} -```ruby -# Coming soon! -``` -{% endtab %} - -{% tab title="PHP" %} -```php -$seam->acs->credentials->delete( - acs_credential_id: "66666666-6666-6666-6666-66666666" -); -``` -{% endtab %} - -{% tab title="C#" %} -```csharp -seam.CredentialsAcs.Delete( - acsCredentialId: "66666666-6666-6666-6666-66666666" -); -``` -{% endtab %} - -{% tab title="Java" %} -```java -// Coming soon! -``` -{% endtab %} - -{% tab title="Go" %} -```go -_, uErr := client.Acs.Credentials.Delete( - context.Background(), &acs.CredentialsDeleteRequest{ - AcsCredentialId: "66666666-6666-6666-6666-66666666", - }, -) -``` -{% endtab %} -{% endtabs %} - -## Response - -Returns a Boolean `ok` status indicator or void. - -### Sample Response - -{% tabs %} -{% tab title="Python" %} -``` -None -``` -{% endtab %} - -{% tab title="cURL (bash)" %} -```json -{ - "ok": true -} -``` -{% endtab %} - -{% tab title="JavaScript" %} -```json -void -``` -{% endtab %} - -{% tab title="Ruby" %} -``` -# Coming soon! -``` -{% endtab %} - -{% tab title="PHP" %} -``` -void -``` -{% endtab %} - -{% tab title="C#" %} -``` -void -``` -{% endtab %} - -{% tab title="Java" %} -```json -// Coming soon! -``` -{% endtab %} - -{% tab title="Go" %} -```json -void -``` -{% endtab %} -{% endtabs %} diff --git a/docs/api-clients/acs/credentials/get.md b/docs/api-clients/acs/credentials/get.md deleted file mode 100644 index e5780f3a..00000000 --- a/docs/api-clients/acs/credentials/get.md +++ /dev/null @@ -1,223 +0,0 @@ ---- -description: Get a specified credential ---- - -# Get a Credential - -Returns a specified [credential](../../../capability-guides/access-systems/managing-credentials.md). - -{% swagger src="https://connect.getseam.com/openapi.json" path="/acs/credentials/get" method="post" %} -[https://connect.getseam.com/openapi.json](https://connect.getseam.com/openapi.json) -{% endswagger %} - -## Request - -Specify the desired credential by including the corresponding `acs_credential_id` in the request body. - -### Request Body Parameters - -
ParameterTypeDescription
acs_credential_idString (UUID)
Required		ID of the desired credential
- -### Sample Request - -{% tabs %} -{% tab title="Python" %} -```python -seam.acs.credentials.get( - acs_credential_id="66666666-6666-6666-6666-666666666666" -) -``` -{% endtab %} - -{% tab title="cURL (bash)" %} -```bash -curl -X 'POST' \ - 'https://connect.getseam.com/acs/credentials/get' \ - -H "Authorization: Bearer ${API_KEY}" \ - -H 'Content-Type: application/json' \ - -d '{ - "acs_credential_id": "66666666-6666-6666-6666-666666666666" -}' -``` -{% endtab %} - -{% tab title="JavaScript" %} -```javascript -await seam.acs.credentials.get({ - acs_credential_id: "66666666-6666-6666-6666-666666666666" -}); -``` -{% endtab %} - -{% tab title="Ruby" %} -```ruby -# Coming soon! -``` -{% endtab %} - -{% tab title="PHP" %} -```php -$seam->acs->credentials->get( - acs_credential_id: "66666666-6666-6666-6666-66666666" -); -``` -{% endtab %} - -{% tab title="C#" %} -```csharp -seam.CredentialsAcs.Get( - acsCredentialId: "66666666-6666-6666-6666-66666666" -); -``` -{% endtab %} - -{% tab title="Java" %} -```java -// Coming soon! -``` -{% endtab %} - -{% tab title="Go" %} -```go -acs_credential, uErr := client.Acs.Credentials.Get( - context.Background(), &acs.CredentialsGetRequest{ - 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](../../../device-and-system-integration-guides/overview.md#access-control-systems). -{% 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)" %} -```json -{ - "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" %} -```json -{ - 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" %} -```json -{ - "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#" %} -```json -{ - "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" %} -```json -// Coming soon! -``` -{% endtab %} - -{% tab title="Go" %} -```json -{ - "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 %} diff --git a/docs/api-clients/acs/credentials/list.md b/docs/api-clients/acs/credentials/list.md deleted file mode 100644 index fa46b299..00000000 --- a/docs/api-clients/acs/credentials/list.md +++ /dev/null @@ -1,258 +0,0 @@ ---- -description: Get all credentials ---- - -# List Credentials - -Returns a list of all [credentials](../../../capability-guides/access-systems/managing-credentials.md). - -{% swagger src="https://connect.getseam.com/openapi.json" path="/acs/credentials/list" method="post" %} -[https://connect.getseam.com/openapi.json](https://connect.getseam.com/openapi.json) -{% endswagger %} - -## Request - -Filter the list of returned credentials by [ACS user](../../../products/access-systems/user-management.md), [access control system](../../../products/access-systems/), or [user identity](../../user_identities/) 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" %} -```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)" %} -```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" %} -```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" %} -```ruby -# Coming soon! -``` -{% endtab %} - -{% tab title="PHP" %} -```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#" %} -```csharp -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" %} -```java -// Coming soon! -``` -{% endtab %} - -{% tab title="Go" %} -```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 `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](../../../device-and-system-integration-guides/overview.md#access-control-systems). -{% 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)" %} -```json -{ - "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" %} -```json -[ - { - 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" %} -```json -[ - { - "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#" %} -```json -{ - "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" %} -```json -// Coming soon! -``` -{% endtab %} - -{% tab title="Go" %} -```json -{ - "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 %} diff --git a/docs/api-clients/acs/credentials/list_accessible_entrances.md b/docs/api-clients/acs/credentials/list_accessible_entrances.md deleted file mode 100644 index 92bfc7c8..00000000 --- a/docs/api-clients/acs/credentials/list_accessible_entrances.md +++ /dev/null @@ -1,274 +0,0 @@ ---- -description: Get all entrances to which a specified credential grants access ---- - -# List Accessible Entrances - -Returns a list of all [entrances](../entrances/) to which a [credential](./) grants access. - -{% swagger src="https://connect.getseam.com/openapi.json" path="/acs/credentials/list_accessible_entrances" method="post" %} -[https://connect.getseam.com/openapi.json](https://connect.getseam.com/openapi.json) -{% endswagger %} - -## Request - -Specify the credential for which you want to retrieve all accessible entrances by including the corresponding `acs_credential_id` in the request body. - -### Request Body Parameters - -
ParameterTypeDescription
acs_credential_idString (UUID)
Required		ID of the credential for which you want to retrieve all entrances to which this credential grants access
- -### Sample Request - -{% tabs %} -{% tab title="Python" %} -```python -seam.acs.credentials.list_accessible_entrances( - acs_credential_id="66666666-6666-6666-6666-666666666666" -) -``` -{% endtab %} - -{% tab title="cURL (bash)" %} -```bash -# Use GET or POST. -curl -X 'GET' \ - 'https://connect.getseam.com/acs/credentials/list_accessible_entrances' \ - -H 'accept: application/json' \ - -H "Authorization: Bearer ${API_KEY}" \ - -H 'Content-Type: application/json' \ - -d '{ - "acs_credential_id": "66666666-6666-6666-6666-666666666666" -}' -``` -{% endtab %} - -{% tab title="JavaScript" %} -```javascript -await seam.acs.credentials.listAccessibleEntrances({ - acs_credential_id: "66666666-6666-6666-6666-666666666666" -}); -``` -{% endtab %} - -{% tab title="Ruby" %} -```ruby -# Coming Soon! -``` -{% endtab %} - -{% tab title="PHP" %} -```php -$seam->acs->credentials->list_accessible_entrances( - acs_credential_id: "66666666-6666-6666-6666-666666666666" -); -``` -{% endtab %} - -{% tab title="C#" %} -```csharp -seam.CredentialsAcs.ListAccessibleEntrances( - acsCredentialId: "66666666-6666-6666-6666-666666666666" -); -``` -{% endtab %} - -{% tab title="Java" %} -```java -// Coming soon! -``` -{% endtab %} - -{% tab title="Go" %} -```go -acs_entrances, uErr := client.Acs.Credentials.ListAccessibleEntrances( - context.Background(), &acs.CredentialsListAccessibleEntrancesRequest{ - AcsCredentialId: "66666666-6666-6666-6666-666666666666", - }, -) -``` -{% endtab %} -{% endtabs %} - -## Response - -Returns an `acs_entrances` array, in which each returned `acs_entrance` contains the following properties: - -
PropertyDescription
acs_entrance_idID of the entrance
acs_system_idID of the access control system that contains the entrance
workspace_idID of the workspace that contains the user
display_nameDisplay name for the entrance
XXX_metadataACS manufacturer-specific metadata for the entrance, where XXX is the manufacturer
created_atDate and time at which the entrance was created
- -### Sample Response - -{% hint style="info" %} -This response contains manufacturer-specific metadata that may vary by [manufacturer](../../../device-and-system-integration-guides/overview.md#access-control-systems). -{% endhint %} - -{% tabs %} -{% tab title="Python" %} -``` -[ - AcsEntrance( - acs_entrance_id='55555555-5555-5555-5555-555555555555', - acs_system_id='11111111-1111-1111-1111-111111111111', - workspace_id='00000000-0000-0000-0000-000000000000', - visionline_metadata= - profiles=[ - { - 'visionline_door_profile_id': 'Guest Door', - 'visionline_door_profile_type': 'BLE' - } - ], - door_name='Guest Lock 2', - door_category='guest' - }, - latch_metadata=null, - display_name='Guest Lock 2', - created_at='2024-03-26T14:31:18.979Z' - ), - ... -] -``` -{% endtab %} - -{% tab title="cURL (bash)" %} -```json -{ - "acs_entrances": [ - { - "acs_entrance_id": "55555555-5555-5555-5555-555555555555", - "acs_system_id": "11111111-1111-1111-1111-111111111111", - "workspace_id": "00000000-0000-0000-0000-000000000000", - "visionline_metadata": { - "profiles": [ - { - "visionline_door_profile_id": "Guest Door", - "visionline_door_profile_type": "BLE" - } - ], - "door_name": "Guest Lock 2", - "door_category": "guest" - }, - "latch_metadata": null, - "display_name": "Guest Lock 2", - "created_at": "2024-03-26T14:31:18.979Z" - }, - ... - ], - "ok": true -} -``` -{% endtab %} - -{% tab title="JavaScript" %} -```json -[ - { - acs_entrance_id: '55555555-5555-5555-5555-555555555555', - acs_system_id: '11111111-1111-1111-1111-111111111111', - workspace_id: '00000000-0000-0000-0000-000000000000', - visionline_metadata: { - profiles: [ - { - visionline_door_profile_id: 'Guest Door', - visionline_door_profile_type: 'BLE' - } - ], - door_name: 'Guest Lock 2', - door_category: 'guest' - }, - latch_metadata: null, - display_name: 'Guest Lock 2', - created_at: '2024-03-26T14:31:18.979Z' - }, - ... -] -``` -{% endtab %} - -{% tab title="Ruby" %} -``` -# Coming Soon! -``` -{% endtab %} - -{% tab title="PHP" %} -```json -[ - { - "acs_entrance_id": "55555555-5555-5555-5555-555555555555", - "acs_system_id": "11111111-1111-1111-1111-111111111111", - "workspace_id": "00000000-0000-0000-0000-000000000000", - "visionline_metadata": { - "profiles": [ - { - "visionline_door_profile_id": "Guest Door", - "visionline_door_profile_type": "BLE" - } - ], - "door_name": "Guest Lock 2", - "door_category": "guest" - }, - "latch_metadata": null, - "display_name": "Guest Lock 2", - "created_at": "2024-03-26T14:31:18.979Z" - }, - ... -] -``` -{% endtab %} - -{% tab title="C#" %} -```json -{ - "acs_entrance_id": "55555555-5555-5555-5555-555555555555", - "acs_system_id": "11111111-1111-1111-1111-111111111111", - "workspace_id": "00000000-0000-0000-0000-000000000000", - "visionline_metadata": { - "profiles": [ - { - "visionline_door_profile_id": "Guest Door", - "visionline_door_profile_type": "BLE" - } - ], - "door_name": "Guest Lock 2", - "door_category": "guest" - }, - "latch_metadata": null, - "display_name": "Guest Lock 2", - "created_at": "2024-03-26T14:31:18.979Z" -} -... -``` -{% endtab %} - -{% tab title="Java" %} -```json -// Coming soon! -``` -{% endtab %} - -{% tab title="Go" %} -```json -[ - { - "acs_entrance_id": "55555555-5555-5555-5555-555555555555", - "acs_system_id": "11111111-1111-1111-1111-111111111111", - "workspace_id": "00000000-0000-0000-0000-000000000000", - "visionline_metadata": { - "profiles": [ - { - "visionline_door_profile_id": "Guest Door", - "visionline_door_profile_type": "BLE" - } - ], - "door_name": "Guest Lock 2", - "door_category": "guest" - }, - "latch_metadata": null, - "display_name": "Guest Lock 2", - "created_at": "2024-03-26T14:31:18.979Z" - }, - ... -] -``` -{% endtab %} -{% endtabs %} diff --git a/docs/api-clients/acs/credentials/unassign.md b/docs/api-clients/acs/credentials/unassign.md deleted file mode 100644 index 17262f0d..00000000 --- a/docs/api-clients/acs/credentials/unassign.md +++ /dev/null @@ -1,229 +0,0 @@ ---- -description: Unassign a specified credential from a specified ACS user ---- - -# Unassign a Credential from a User - -Unassigns a specified [credential](../../../capability-guides/access-systems/managing-credentials.md) from a specified [ACS user](../../../products/access-systems/user-management.md). - -{% swagger src="https://connect.getseam.com/openapi.json" path="/acs/credentials/unassign" method="post" %} -[https://connect.getseam.com/openapi.json](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" %} -```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)" %} -```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" %} -```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" %} -```ruby -# Coming soon! -``` -{% endtab %} - -{% tab title="PHP" %} -```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#" %} -```csharp -seam.CredentialsAcs.Unassign( - acsUserId: "33333333-3333-3333-3333-333333333333", - acsCredentialId: "66666666-6666-6666-6666-66666666" -); -``` -{% endtab %} - -{% tab title="Java" %} -```java -// Coming soon! -``` -{% endtab %} - -{% tab title="Go" %} -```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](../../../device-and-system-integration-guides/overview.md#access-control-systems). -{% 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)" %} -```json -{ - "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" %} -```json -{ - 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" %} -```json -{ - "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#" %} -```json -{ - "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" %} -```json -// Coming soon! -``` -{% endtab %} - -{% tab title="Go" %} -```json -{ - "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 %} diff --git a/docs/api-clients/acs/credentials/update.md b/docs/api-clients/acs/credentials/update.md deleted file mode 100644 index 55574122..00000000 --- a/docs/api-clients/acs/credentials/update.md +++ /dev/null @@ -1,158 +0,0 @@ ---- -description: Update the code for a specified credential ---- - -# Update a Credential - -Updates the code for a specified [credential](../../../capability-guides/access-systems/managing-credentials.md). - -{% hint style="info" %} -You can only update a credential for [Latch](../../../device-and-system-integration-guides/latch-access-control-system/) or [PTI Storlogix Cloud](../../../device-guides/pti-storlogix-cloud.md). -{% endhint %} - -{% swagger src="https://connect.getseam.com/openapi.json" path="/acs/credentials/update" method="post" %} -[https://connect.getseam.com/openapi.json](https://connect.getseam.com/openapi.json) -{% endswagger %} - -## Request - -Specify the desired credential and updated code by including the corresponding `acs_credential_id` and `code` parameters, respectively, in the request body. - -### Request Body Parameters - -
ParameterTypeDescription
acs_credential_idString (UUID)
Required		ID of the desired credential.
codeString
Optional		Replacement access (PIN) code for the credential.
ends_atDatetime
Optional		Replacement date and time at which the validity of the credential ends, in ISO 8601 format.
Must be a time in the future and after the starts_at value that you set when creating the credential.
- -### Sample Request - -{% tabs %} -{% tab title="Python" %} -```python -seam.acs.credentials.update( - acs_credential_id="66666666-6666-6666-6666-666666666666", - code="7890" -) -``` -{% endtab %} - -{% tab title="cURL (bash)" %} -```bash -curl -X 'POST' \ - "https://connect.getseam.com/acs/credentials/update" \ - -H 'accept: application/json' \ - -H "Authorization: Bearer ${API_KEY}" \ - -H 'Content-Type: application/json' \ - -d '{ - "acs_credential_id": "66666666-6666-6666-6666-666666666666", - "code": "7890" -}' -``` -{% endtab %} - -{% tab title="JavaScript" %} -```javascript -await seam.acs.credentials.update({ - acs_credential_id: "66666666-6666-6666-6666-666666666666", - code: "7890" -}); -``` -{% endtab %} - -{% tab title="Ruby" %} -```ruby -# Coming soon! -``` -{% endtab %} - -{% tab title="PHP" %} -```php -$seam->acs->credentials->update( - acs_credential_id: "66666666-6666-6666-6666-666666666666", - code: "7890" -); -``` -{% endtab %} - -{% tab title="C#" %} -```csharp -seam.CredentialsAcs.Update( - acsCredentialId: "66666666-6666-6666-6666-666666666666", - code: "7890" -); -``` -{% endtab %} - -{% tab title="Java" %} -```java -// Coming soon! -``` -{% endtab %} - -{% tab title="Go" %} -```go -acs_credential, uErr := client.Acs.Credentials.Update( - context.Background(), &acs.CredentialsUpdateRequest{ - AcsCredentialId: api.String("66666666-6666-6666-6666-666666666666"), - Code: "7890", - }, -) -``` -{% endtab %} -{% endtabs %} - -## Response - -Returns a Boolean `ok` status indicator or void. - -### Sample Response - -{% tabs %} -{% tab title="Python" %} -``` -None -``` -{% endtab %} - -{% tab title="cURL (bash)" %} -```json -{ - "ok": true -} -``` -{% endtab %} - -{% tab title="JavaScript" %} -```json -void -``` -{% endtab %} - -{% tab title="Ruby" %} -``` -# Coming soon! -``` -{% endtab %} - -{% tab title="PHP" %} -``` -void -``` -{% endtab %} - -{% tab title="C#" %} -``` -void -``` -{% endtab %} - -{% tab title="Java" %} -```json -// Coming soon! -``` -{% endtab %} - -{% tab title="Go" %} -``` -void -``` -{% endtab %} -{% endtabs %} diff --git a/docs/api-clients/acs/entrances/README.md b/docs/api-clients/acs/entrances/README.md deleted file mode 100644 index e78d44f0..00000000 --- a/docs/api-clients/acs/entrances/README.md +++ /dev/null @@ -1,21 +0,0 @@ ---- -description: Secured doors, gates, services, and other methods of entry ---- - -# Entrances - -The `acs_entrance` object represents an [entrance](../../../capability-guides/access-systems/retrieving-entrance-details.md) within an [access control system](../../../products/access-systems/). - -## `acs_entrance` Properties - -The `acs_entrance` object has the following properties: - -
PropertyTypeDescription
acs_entrance_idString (UUID)
Required		ID of the entrance
display_nameString
Required		Display name for the entrance
acs_system_idString (UUID)
Required		ID of the access control system that contains the entrance
created_atString
Required		Date and time at which the entrance was created
workspace_idString (UUID)
Required		ID of the workspace that contains the entrance
XXX_metadataObject
Optional		ACS manufacturer-specific metadata for the entrance, where XXX is the manufacturer
- -## `acs_entrance` Methods - -You can perform the following actions on `acs_entrance` objects: - -* [List entrances](list.md) -* [Get an entrance](get.md) -* [List credentials with access to an entrance](list_credentials_with_access.md) diff --git a/docs/api-clients/acs/entrances/get.md b/docs/api-clients/acs/entrances/get.md deleted file mode 100644 index f11fa9ca..00000000 --- a/docs/api-clients/acs/entrances/get.md +++ /dev/null @@ -1,261 +0,0 @@ ---- -description: Get a specified entrance ---- - -# Get an Entrance - -Returns a specified [entrance](../../../capability-guides/access-systems/retrieving-entrance-details.md). - -{% swagger src="https://connect.getseam.com/openapi.json" path="/acs/entrances/get" method="post" %} -[https://connect.getseam.com/openapi.json](https://connect.getseam.com/openapi.json) -{% endswagger %} - -## Request - -Specify the desired entrance by including the corresponding `acs_entrance_id` in the request body. - -### Request Body Parameters - -
ParameterTypeDescription
acs_entrance_idString (UUID)
Required		ID of the desired entrance
- -### Sample Request - -{% tabs %} -{% tab title="Python" %} -```python -seam.acs.entrances.get( - acs_entrance_id="55555555-5555-5555-5555-555555555555" -) -``` -{% endtab %} - -{% tab title="cURL (bash)" %} -```bash -# Use GET or POST. -curl -X 'GET' \ - 'https://connect.getseam.com/acs/entrances/get' \ - -H 'accept: application/json' \ - -H "Authorization: Bearer ${API_KEY}" \ - -H 'Content-Type: application/json' \ - -d '{ - "acs_entrance_id": "55555555-5555-5555-5555-555555555555" -}' -``` -{% endtab %} - -{% tab title="JavaScript" %} -```javascript -await seam.acs.entrances.get({ - acs_entrance_id: "55555555-5555-5555-5555-555555555555" -}); -``` -{% endtab %} - -{% tab title="Ruby" %} -```ruby -# Coming Soon! -``` -{% endtab %} - -{% tab title="PHP" %} -```php -$seam->acs->entrances->get( - acs_entrance_id: "55555555-5555-5555-5555-555555555555" -); -``` -{% endtab %} - -{% tab title="C#" %} -```csharp -seam.EntrancesAcs.Get( - acsEntranceId: "55555555-5555-5555-5555-555555555555" -); -``` -{% endtab %} - -{% tab title="Java" %} -```java -// Coming soon! -``` -{% endtab %} - -{% tab title="Go" %} -```go -acs_entrance, uErr := client.Acs.Entrances.Get( - context.Background(), &acs.EntrancesGetRequest{ - AcsEntranceId: "55555555-5555-5555-5555-555555555555", - }, -) -``` -{% endtab %} -{% endtabs %} - -## Response - -Returns an `acs_entrance` containing the following properties: - -
PropertyDescription
acs_entrance_idID of the entrance
acs_system_idID of the access control system that contains the entrance
workspace_idID of the workspace that contains the user
display_nameDisplay name for the entrance
XXX_metadataACS manufacturer-specific metadata for the entrance, where XXX is the manufacturer
created_atDate and time at which the entrance was created
- -### Sample Response - -{% hint style="info" %} -This response contains manufacturer-specific metadata that may vary by [manufacturer](../../../device-and-system-integration-guides/overview.md#access-control-systems). -{% endhint %} - -{% tabs %} -{% tab title="Python" %} -``` -AcsEntrance( - acs_entrance_id: '55555555-5555-5555-5555-555555555555', - acs_system_id: '11111111-1111-1111-1111-111111111111', - workspace_id: '00000000-0000-0000-0000-000000000000', - visionline_metadata: { - profiles: [ - { - visionline_door_profile_id: 'Guest Door', - visionline_door_profile_type: 'BLE' - } - ], - door_name: 'Guest Lock 2', - door_category: 'guest' - }, - latch_metadata: null, - display_name: 'Guest Lock 2', - created_at: '2024-03-26T14:31:18.979Z' -) -``` -{% endtab %} - -{% tab title="cURL (bash)" %} -```json -{ - "acs_entrance": { - "acs_entrance_id": "55555555-5555-5555-5555-555555555555", - "acs_system_id": "11111111-1111-1111-1111-111111111111", - "workspace_id": "00000000-0000-0000-0000-000000000000", - "visionline_metadata": { - "profiles": [ - { - "visionline_door_profile_id": "Guest Door", - "visionline_door_profile_type": "BLE" - } - ], - "door_name": "Guest Lock 2", - "door_category": "guest" - }, - "latch_metadata": null, - "display_name": "Guest Lock 2", - "created_at": "2024-03-26T14:31:18.979Z" - }, - "ok": true -} -``` -{% endtab %} - -{% tab title="JavaScript" %} -```json -{ - acs_entrance_id: '55555555-5555-5555-5555-555555555555', - acs_system_id: '11111111-1111-1111-1111-111111111111', - workspace_id: '00000000-0000-0000-0000-000000000000', - visionline_metadata: { - profiles: [ - { - visionline_door_profile_id: 'Guest Door', - visionline_door_profile_type: 'BLE' - } - ], - door_name: 'Guest Lock 2', - door_category: 'guest' - }, - latch_metadata: null, - display_name: 'Guest Lock 2', - created_at: '2024-03-26T14:31:18.979Z' -} -``` -{% endtab %} - -{% tab title="Ruby" %} -``` -# Coming Soon! -``` -{% endtab %} - -{% tab title="PHP" %} -```json -{ - "acs_entrance_id": "55555555-5555-5555-5555-555555555555", - "acs_system_id": "11111111-1111-1111-1111-111111111111", - "workspace_id": "00000000-0000-0000-0000-000000000000", - "visionline_metadata": { - "profiles": [ - { - "visionline_door_profile_id": "Guest Door", - "visionline_door_profile_type": "BLE" - } - ], - "door_name": "Guest Lock 2", - "door_category": "guest" - }, - "latch_metadata": null, - "display_name": "Guest Lock 2", - "created_at": "2024-03-26T14:31:18.979Z" -} -``` -{% endtab %} - -{% tab title="C#" %} -```json -{ - "acs_entrance_id": "55555555-5555-5555-5555-555555555555", - "acs_system_id": "11111111-1111-1111-1111-111111111111", - "workspace_id": "00000000-0000-0000-0000-000000000000", - "visionline_metadata": { - "profiles": [ - { - "visionline_door_profile_id": "Guest Door", - "visionline_door_profile_type": "BLE" - } - ], - "door_name": "Guest Lock 2", - "door_category": "guest" - }, - "latch_metadata": null, - "display_name": "Guest Lock 2", - "created_at": "2024-03-26T14:31:18.979Z" -} -``` -{% endtab %} - -{% tab title="Java" %} -```json -// Coming soon! -``` -{% endtab %} - -{% tab title="Go" %} -```json -{ - "acs_entrance": { - "acs_entrance_id": "55555555-5555-5555-5555-555555555555", - "acs_system_id": "11111111-1111-1111-1111-111111111111", - "workspace_id": "00000000-0000-0000-0000-000000000000", - "visionline_metadata": { - "profiles": [ - { - "visionline_door_profile_id": "Guest Door", - "visionline_door_profile_type": "BLE" - } - ], - "door_name": "Guest Lock 2", - "door_category": "guest" - }, - "latch_metadata": null, - "display_name": "Guest Lock 2", - "created_at": "2024-03-26T14:31:18.979Z" - }, - "ok": true -} -``` -{% endtab %} -{% endtabs %} diff --git a/docs/api-clients/acs/entrances/list.md b/docs/api-clients/acs/entrances/list.md deleted file mode 100644 index f2953962..00000000 --- a/docs/api-clients/acs/entrances/list.md +++ /dev/null @@ -1,277 +0,0 @@ ---- -description: Get all entrances ---- - -# List Entrances - -Returns a list of all [entrances](../../../capability-guides/access-systems/retrieving-entrance-details.md). - -{% swagger src="https://connect.getseam.com/openapi.json" path="/acs/entrances/list" method="post" %} -[https://connect.getseam.com/openapi.json](https://connect.getseam.com/openapi.json) -{% endswagger %} - -## Request - -To filter the list of returned entrances by a specific [access control system](../../../products/access-systems/), include the `acs_system_id` parameters in the request body. If you omit this parameter, the response includes all entrances in your [workspace](../../../core-concepts/workspaces/). - -### Request Body Parameters - -
ParameterTypeDescription
acs_system_idString (UUID)
Optional		ID of the access control system for which you want to retrieve all entrances
- -### Sample Request - -{% tabs %} -{% tab title="Python" %} -```python -seam.acs.entrances.list( - acs_system_id="11111111-1111-1111-1111-111111111111" -) -``` -{% endtab %} - -{% tab title="cURL (bash)" %} -```bash -# Use GET or POST. -curl -X 'GET' \ - 'https://connect.getseam.com/acs/entrances/list' \ - -H 'accept: application/json' \ - -H "Authorization: Bearer ${API_KEY}" \ - -H 'Content-Type: application/json' \ - -d '{ - "acs_system_id": "11111111-1111-1111-1111-111111111111" -}' -``` -{% endtab %} - -{% tab title="JavaScript" %} -```javascript -await seam.acs.entrances.list({ - acs_system_id: "11111111-1111-1111-1111-111111111111" -}); -``` -{% endtab %} - -{% tab title="Ruby" %} -```ruby -# Coming Soon! -``` -{% endtab %} - -{% tab title="PHP" %} -```php -$seam->acs->entrances->list( - acs_system_id: "11111111-1111-1111-1111-111111111111" -); -``` -{% endtab %} - -{% tab title="C#" %} -```csharp -seam.EntrancesAcs.List( - acsSystemId: "11111111-1111-1111-1111-111111111111" -); -``` -{% endtab %} - -{% tab title="Java" %} -```java -// Coming soon! -``` -{% endtab %} - -{% tab title="Go" %} -```go -acs_entrances, uErr := client.Acs.Entrances.List( - context.Background(), &acs.EntrancesListRequest{ - AcsSystemId: api.String("11111111-1111-1111-1111-111111111111"), - }, -) -``` -{% endtab %} -{% endtabs %} - -## Response - -Returns an `acs_entrances` array, in which each returned `acs_entrance` contains the following properties: - -
PropertyDescription
acs_entrance_idID of the entrance
acs_system_idID of the access control system that contains the entrance
workspace_idID of the workspace that contains the user
display_nameDisplay name for the entrance
XXX_metadataACS manufacturer-specific metadata for the entrance, where XXX is the manufacturer
created_atDate and time at which the entrance was created
- -### Sample Response - -{% hint style="info" %} -This response contains manufacturer-specific metadata that may vary by [manufacturer](../../../device-and-system-integration-guides/overview.md#access-control-systems). -{% endhint %} - -{% tabs %} -{% tab title="Python" %} -``` -[ - AcsEntrance( - acs_entrance_id='55555555-5555-5555-5555-555555555555', - acs_system_id='11111111-1111-1111-1111-111111111111', - workspace_id='00000000-0000-0000-0000-000000000000', - visionline_metadata= - profiles=[ - { - 'visionline_door_profile_id': 'Guest Door', - 'visionline_door_profile_type': 'BLE' - } - ], - door_name='Guest Lock 2', - door_category='guest' - }, - latch_metadata=null, - display_name='Guest Lock 2', - created_at='2024-03-26T14:31:18.979Z' - ), - ... -] -``` -{% endtab %} - -{% tab title="cURL (bash)" %} -```json -{ - "acs_entrances": [ - { - "acs_entrance_id": "55555555-5555-5555-5555-555555555555", - "acs_system_id": "11111111-1111-1111-1111-111111111111", - "workspace_id": "00000000-0000-0000-0000-000000000000", - "visionline_metadata": { - "profiles": [ - { - "visionline_door_profile_id": "Guest Door", - "visionline_door_profile_type": "BLE" - } - ], - "door_name": "Guest Lock 2", - "door_category": "guest" - }, - "latch_metadata": null, - "display_name": "Guest Lock 2", - "created_at": "2024-03-26T14:31:18.979Z" - }, - ... - ], - "ok": true -} -``` -{% endtab %} - -{% tab title="JavaScript" %} -```json -[ - { - acs_entrance_id: '55555555-5555-5555-5555-555555555555', - acs_system_id: '11111111-1111-1111-1111-111111111111', - workspace_id: '00000000-0000-0000-0000-000000000000', - visionline_metadata: { - profiles: [ - { - visionline_door_profile_id: 'Guest Door', - visionline_door_profile_type: 'BLE' - } - ], - door_name: 'Guest Lock 2', - door_category: 'guest' - }, - latch_metadata: null, - display_name: 'Guest Lock 2', - created_at: '2024-03-26T14:31:18.979Z' - }, - ... -] -``` -{% endtab %} - -{% tab title="Ruby" %} -``` -# Coming Soon! -``` -{% endtab %} - -{% tab title="PHP" %} -```json -[ - { - "acs_entrance_id": "55555555-5555-5555-5555-555555555555", - "acs_system_id": "11111111-1111-1111-1111-111111111111", - "workspace_id": "00000000-0000-0000-0000-000000000000", - "visionline_metadata": { - "profiles": [ - { - "visionline_door_profile_id": "Guest Door", - "visionline_door_profile_type": "BLE" - } - ], - "door_name": "Guest Lock 2", - "door_category": "guest" - }, - "latch_metadata": null, - "display_name": "Guest Lock 2", - "created_at": "2024-03-26T14:31:18.979Z" - }, - ... -] -``` -{% endtab %} - -{% tab title="C#" %} -```json -{ - "acs_entrance_id": "55555555-5555-5555-5555-555555555555", - "acs_system_id": "11111111-1111-1111-1111-111111111111", - "workspace_id": "00000000-0000-0000-0000-000000000000", - "visionline_metadata": { - "profiles": [ - { - "visionline_door_profile_id": "Guest Door", - "visionline_door_profile_type": "BLE" - } - ], - "door_name": "Guest Lock 2", - "door_category": "guest" - }, - "latch_metadata": null, - "display_name": "Guest Lock 2", - "created_at": "2024-03-26T14:31:18.979Z" -} -... -``` -{% endtab %} - -{% tab title="Java" %} -```json -// Coming soon! -``` -{% endtab %} - -{% tab title="Go" %} -```json -{ - "acs_entrances": [ - { - "acs_entrance_id": "55555555-5555-5555-5555-555555555555", - "acs_system_id": "11111111-1111-1111-1111-111111111111", - "workspace_id": "00000000-0000-0000-0000-000000000000", - "visionline_metadata": { - "profiles": [ - { - "visionline_door_profile_id": "Guest Door", - "visionline_door_profile_type": "BLE" - } - ], - "door_name": "Guest Lock 2", - "door_category": "guest" - }, - "latch_metadata": null, - "display_name": "Guest Lock 2", - "created_at": "2024-03-26T14:31:18.979Z" - }, - ... - ], - "ok": true -} -``` -{% endtab %} -{% endtabs %} diff --git a/docs/api-clients/acs/entrances/list_credentials_with_access.md b/docs/api-clients/acs/entrances/list_credentials_with_access.md deleted file mode 100644 index 2930cda6..00000000 --- a/docs/api-clients/acs/entrances/list_credentials_with_access.md +++ /dev/null @@ -1,287 +0,0 @@ ---- -description: Get all credentials with access to a specified entrance ---- - -# List Credentials with Access to an Entrance - -Returns a list of all [credentials](../../../capability-guides/access-systems/managing-credentials.md) with access to a specified [entrance](../../../capability-guides/access-systems/retrieving-entrance-details.md). - -{% swagger src="https://connect.getseam.com/openapi.json" path="/acs/entrances/list_credentials_with_access" method="post" %} -[https://connect.getseam.com/openapi.json](https://connect.getseam.com/openapi.json) -{% endswagger %} - -## Request - -Specify the entrance for which you want to retrieve all credentials with access by including the corresponding `acs_entrance_id` in the request body. - -{% hint style="info" %} -You can also use a manufacturer-specific filter for entrances in a [Visionline ACS](../../../device-guides/assa-abloy-visionline-access-control-system-in-development/). For details, see [List All Valid Credentials for a Set of Guest Entrances to Add as Joiners](../../../device-and-system-integration-guides/assa-abloy-visionline-access-control-system-in-development/credential-types/#list-all-valid-credentials-for-a-set-of-guest-entrances-to-add-as-joiners). -{% endhint %} - -### Request Body Parameters - -
ParameterTypeDescription
acs_entrance_idString (UUID)
Required		ID of the entrance for which you want to retrieve all credentials with access
- -### Sample Request - -{% tabs %} -{% tab title="Python" %} -```python -seam.acs.entrances.list_credentials_with_access( - acs_entrance_id="55555555-5555-5555-5555-555555555555" -) -``` -{% endtab %} - -{% tab title="cURL (bash)" %} -```bash -# Use GET or POST. -curl -X 'GET' \ - 'https://connect.getseam.com/acs/entrances/list_credentials_with_access' \ - -H 'accept: application/json' \ - -H "Authorization: Bearer ${API_KEY}" \ - -H 'Content-Type: application/json' \ - -d '{ - "acs_entrance_id": "55555555-5555-5555-5555-555555555555" -}' -``` -{% endtab %} - -{% tab title="JavaScript" %} -```javascript -await seam.acs.entrances.list_credentials_with_access({ - acs_entrance_id: "55555555-5555-5555-5555-555555555555" -}); -``` -{% endtab %} - -{% tab title="Ruby" %} -```ruby -# Coming soon! -``` -{% endtab %} - -{% tab title="PHP" %} -```php -$seam->acs->entrances->list_credentials_with_access( - acs_entrance_id: "55555555-5555-5555-5555-555555555555" -); -``` -{% endtab %} - -{% tab title="C#" %} -```csharp -seam.EntrancesAcs.ListCredentialsWithAccess( - acsEntranceId: "55555555-5555-5555-5555-555555555555" -); -``` -{% endtab %} - -{% tab title="Java" %} -```java -// Coming soon! -``` -{% endtab %} - -{% tab title="Go" %} -```go -acs_users, uErr := client.Acs.Entrances.ListCredentialsWithAccess( - context.Background(), &acs.UsersListRequest{ - AcsEntranceId: api.String("55555555-5555-5555-5555-555555555555") - }, -) -``` -{% endtab %} -{% endtabs %} - -## Response - -Returns an `acs_credentials` array, in which each returned `acs_credential` contains the following properties: - -
PropertyDescription
acs_credential_idID of the credential
acs_user_idID of the user to whom the credential belongs
parent_acs_credential_idID of the parent ACS credential
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
Supported values: pti_card, brivo_credential, hid_credential, visionline_card
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
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
is_multi_phone_sync_credentialIndicates whether the credential is a multi-phone sync credential
XXX_metadataACS manufacturer-specific metadata for the entrance, where XXX is the manufacturer
- -### Sample Response - -{% hint style="info" %} -This response contains manufacturer-specific metadata that may vary by [manufacturer](../../../device-and-system-integration-guides/overview.md#access-control-systems). -{% endhint %} - -{% tabs %} -{% tab title="Python" %} -``` -[ - AcsCredential( - acs_credential_id='77777777-7777-7777-7777-777777777777', - acs_user_id='33333333-3333-3333-3333-333333333333', - parent_acs_credential_id='66666666-6666-6666-6666-666666666666', - display_name='Credential 2', - code=null, - acs_system_id='11111111-1111-1111-1111-111111111111', - access_method='mobile_key', - external_type='visionline_card', - external_type_display_name='Visionline Card', - errors=[], - warnings=[], - workspace_id='00000000-0000-0000-0000-000000000000', - created_at='2024-04-09T14:30:56.343Z', - starts_at='2024-04-09T14:30:55.688Z', - ends_at='2024-03-04T10:40:00.000Z', - is_multi_phone_sync_credential=False, - visionline_metadata={} - ), - ... -] -``` -{% endtab %} - -{% tab title="cURL (bash)" %} -```json -{ - "acs_credentials": [ - { - "acs_credential_id": "77777777-7777-7777-7777-777777777777", - "acs_user_id": "33333333-3333-3333-3333-333333333333", - "parent_acs_credential_id": "66666666-6666-6666-6666-666666666666", - "display_name": "Credential 2", - "code": null, - "acs_system_id": "11111111-1111-1111-1111-111111111111", - "access_method": "mobile_key", - "external_type": "visionline_card", - "external_type_display_name": "Visionline Card", - "errors": [], - "warnings": [], - "workspace_id": "00000000-0000-0000-0000-000000000000", - "created_at": "2024-04-09T14:30:56.343Z", - "starts_at": "2024-04-09T14:30:55.688Z", - "ends_at": "2024-03-04T10:40:00.000Z", - "is_multi_phone_sync_credential": false, - "visionline_metadata": {} - }, - ... - ], - "ok": true -} -``` -{% endtab %} - -{% tab title="JavaScript" %} -```json -[ - { - acs_credential_id: '77777777-7777-7777-7777-777777777777', - acs_user_id: '33333333-3333-3333-3333-333333333333', - parent_acs_credential_id: '66666666-6666-6666-6666-666666666666', - display_name: 'Credential 2', - code: null, - acs_system_id: '11111111-1111-1111-1111-111111111111', - access_method: 'mobile_key', - external_type: 'visionline_card', - external_type_display_name: 'Visionline Card', - errors: [], - warnings: - workspace_id: '00000000-0000-0000-0000-000000000000', - created_at: '2024-04-09T14:30:56.343Z', - starts_at: '2024-04-09T14:30:55.688Z', - ends_at: '2024-03-04T10:40:00.000Z', - is_multi_phone_sync_credential: false, - visionline_metadata: {} - }, - ... -] -``` -{% endtab %} - -{% tab title="Ruby" %} -``` -# Coming Soon! -``` -{% endtab %} - -{% tab title="PHP" %} -```json -[ - { - "acs_credential_id": "77777777-7777-7777-7777-777777777777", - "acs_user_id": "33333333-3333-3333-3333-333333333333", - "parent_acs_credential_id": "66666666-6666-6666-6666-666666666666", - "display_name": "Credential 2", - "code": null, - "acs_system_id": "11111111-1111-1111-1111-111111111111", - "access_method": "mobile_key", - "external_type": "visionline_card", - "external_type_display_name": "Visionline Card", - "errors": [], - "warnings": [], - "workspace_id": "00000000-0000-0000-0000-000000000000", - "created_at": "2024-04-09T14:30:56.343Z", - "starts_at": "2024-04-09T14:30:55.688Z", - "ends_at": "2024-03-04T10:40:00.000Z", - "is_multi_phone_sync_credential": false, - "visionline_metadata": {} - }, - ... -] -``` -{% endtab %} - -{% tab title="C#" %} -```json -{ - "acs_credential_id": "77777777-7777-7777-7777-777777777777", - "acs_user_id": "33333333-3333-3333-3333-333333333333", - "parent_acs_credential_id": "66666666-6666-6666-6666-666666666666", - "display_name": "Credential 2", - "code": null, - "acs_system_id": "11111111-1111-1111-1111-111111111111", - "access_method": "mobile_key", - "external_type": "visionline_card", - "external_type_display_name": "Visionline Card", - "errors": [], - "warnings": [], - "workspace_id": "00000000-0000-0000-0000-000000000000", - "created_at": "2024-04-09T14:30:56.343Z", - "starts_at": "2024-04-09T14:30:55.688Z", - "ends_at": "2024-03-04T10:40:00.000Z", - "is_multi_phone_sync_credential": false, - "visionline_metadata": {} -} -... -``` -{% endtab %} - -{% tab title="Java" %} -```json -// Coming soon! -``` -{% endtab %} - -{% tab title="Go" %} -```json -{ - "acs_credentials": [ - { - "acs_credential_id": "77777777-7777-7777-7777-777777777777", - "acs_user_id": "33333333-3333-3333-3333-333333333333", - "parent_acs_credential_id": "66666666-6666-6666-6666-666666666666", - "display_name": "Credential 2", - "code": null, - "acs_system_id": "11111111-1111-1111-1111-111111111111", - "access_method": "mobile_key", - "external_type": "visionline_card", - "external_type_display_name": "Visionline Card", - "errors": [], - "warnings": [], - "workspace_id": "00000000-0000-0000-0000-000000000000", - "created_at": "2024-04-09T14:30:56.343Z", - "starts_at": "2024-04-09T14:30:55.688Z", - "ends_at": "2024-03-04T10:40:00.000Z", - "is_multi_phone_sync_credential": false, - "visionline_metadata": {} - }, - ... - ], - "ok": true -} -``` -{% endtab %} -{% endtabs %} diff --git a/docs/api-clients/acs/systems/README.md b/docs/api-clients/acs/systems/README.md deleted file mode 100644 index 91a918ab..00000000 --- a/docs/api-clients/acs/systems/README.md +++ /dev/null @@ -1,21 +0,0 @@ ---- -description: Systems for managing and monitoring access to physical spaces ---- - -# Systems - -The `acs_system` object represents an [Access Control System](../../../products/access-systems/) (ACS). - -## `acs_system` Properties - -The `acs_system` object has the following properties: - -
PropertyTypeDescription
acs_system_idString (UUID)
Required		ID of the access control system
external_typeEnum (string)
Required		Brand-specific terminology for the access control system type
external_type_display_nameString
Optional		Display name that corresponds to the brand-specific terminology for the access control system type
nameString
Required		Name of the access control system
created_atString
Required		Date and time at which the access control system was created
workspace_idString (UUID)
Required		ID of the workspace that contains the access control system
connected_account_idsArray of strings (UUIDs)
Required		Array of connected account IDs associated with the access control system
image_urlString
Required		URL for the image that represents the access control system
image_alt_textString
Required		Alternative text for the access control system image
- -## `acs_system` Methods - -You can perform the following actions on `acs_system` objects: - -* [List systems](list.md) -* [Get a system](get.md) -* [List compatible credential manager ACS systems](list\_compatible\_credential\_manager\_acs\_systems.md) diff --git a/docs/api-clients/acs/systems/get.md b/docs/api-clients/acs/systems/get.md deleted file mode 100644 index 2b7c7616..00000000 --- a/docs/api-clients/acs/systems/get.md +++ /dev/null @@ -1,225 +0,0 @@ ---- -description: Get a specified access control system ---- - -# Get a System - -Returns a specified [access control system](../../../products/access-systems/). - -{% swagger src="https://connect.getseam.com/openapi.json" path="/acs/systems/get" method="post" %} -[https://connect.getseam.com/openapi.json](https://connect.getseam.com/openapi.json) -{% endswagger %} - -## Request - -Specify the desired access control system by including the corresponding `acs_system_id` in the request body. - -### Request Body Parameters - -
ParameterTypeDescription
acs_system_idString (UUID)
Required		ID of the desired access control system
- -### Sample Request - -{% tabs %} -{% tab title="Python" %} -```python -seam.acs.systems.get( - acs_system_id="11111111-1111-1111-1111-111111111111" -) -``` -{% endtab %} - -{% tab title="cURL (bash)" %} -```bash -# Use GET or POST. -curl -X 'GET' \ - 'https://connect.getseam.com/acs/systems/get' \ - -H 'accept: application/json' \ - -H "Authorization: Bearer ${API_KEY}" \ - -H 'Content-Type: application/json' \ - -d '{ - "acs_system_id": "11111111-1111-1111-1111-111111111111" -}' -``` -{% endtab %} - -{% tab title="JavaScript" %} -```javascript -await seam.acs.systems.get({ - acs_system_id: "11111111-1111-1111-1111-111111111111" -}); -``` -{% endtab %} - -{% tab title="Ruby" %} -```ruby -# Coming soon! -``` -{% endtab %} - -{% tab title="PHP" %} -```php -$seam->acs->systems->get( - acs_system_id: "11111111-1111-1111-1111-111111111111" -); -``` -{% endtab %} - -{% tab title="C#" %} -```csharp -seam.SystemsAcs.Get( - acsSystemId: "11111111-1111-1111-1111-111111111111" -); -``` -{% endtab %} - -{% tab title="Java" %} -```java -// Coming soon! -``` -{% endtab %} - -{% tab title="Go" %} -```go -acs_system, uErr := client.Acs.Systems.Get( - context.Background(), &acs.SystemsGetRequest{ - AcsSystemId: "11111111-1111-1111-1111-111111111111", - }, -) -``` -{% endtab %} -{% endtabs %} - -## Response - -Returns an `acs_system` containing the following properties: - -
PropertyDescription
acs_system_idID of the access control system
nameName of the access control system
workspace_idID of the workspace that contains the access control system
created_atDate and time at which the access control system was created
external_typeBrand-specific terminology for the access control system type
external_type_display_nameDisplay name that corresponds to the brand-specific terminology for the access control system type
connected_account_idsArray of connected account IDs associated with the access control system
image_urlURL for the image that represents the access control system
image_alt_textAlternative text for the access control system image
- -### Sample Response - -{% tabs %} -{% tab title="Python" %} -``` -AcsSystem( - acs_system_id='11111111-1111-1111-1111-111111111111', - name='Example Inc', - workspace_id='00000000-0000-0000-0000-000000000000', - created_at='2023-11-30T06:27:14.961Z', - external_type='pti_site', - external_type_display_name='PTI site", - connected_account_ids=[ - '11111111-1111-1111-1111-222222222222' - ], - image_url='https://connect.getseam.com/assets/images/acs_systems/pti_site.png', - image_alt_text='PTI site Logo' -) -``` -{% endtab %} - -{% tab title="cURL (bash)" %} -```json -{ - "acs_system": { - "acs_system_id": "11111111-1111-1111-1111-111111111111", - "name": "Example Inc", - "workspace_id": "00000000-0000-0000-0000-000000000000", - "created_at": "2023-11-30T06:27:14.961Z", - "external_type": "pti_site", - "external_type_display_name": "PTI site", - "connected_account_ids": [ - "11111111-1111-1111-1111-222222222222" - ], - "image_url": "https://connect.getseam.com/assets/images/acs_systems/pti_site.png", - "image_alt_text": "PTI site Logo" - }, - "ok": true -} -``` -{% endtab %} - -{% tab title="JavaScript" %} -```json -{ - acs_system_id: '11111111-1111-1111-1111-111111111111', - name: 'Example Inc', - workspace_id: '00000000-0000-0000-0000-000000000000', - created_at: '2023-11-30T06:27:14.961Z', - external_type: 'pti_site', - external_type_display_name: 'PTI site', - connected_account_ids: [ '11111111-1111-1111-1111-222222222222' ], - image_url: 'https://connect.getseam.com/assets/images/acs_systems/pti_site.png', - image_alt_text: 'PTI site Logo' -} -``` -{% endtab %} - -{% tab title="Ruby" %} -``` -# Coming Soon! -``` -{% endtab %} - -{% tab title="PHP" %} -```json -{ - "acs_system_id": "11111111-1111-1111-1111-111111111111", - "name": "Example Inc", - "workspace_id": "00000000-0000-0000-0000-000000000000", - "created_at": "2023-11-30T06:27:14.961Z", - "external_type": "pti_site", - "external_type_display_name": "PTI site", - "connected_account_ids": [ - "11111111-1111-1111-1111-222222222222" - ], - "image_url": "https://connect.getseam.com/assets/images/acs_systems/pti_site.png", - "image_alt_text": "PTI site Logo" -} -``` -{% endtab %} - -{% tab title="C#" %} -```json -{ - "acs_system_id": "11111111-1111-1111-1111-111111111111", - "name": "Example Inc", - "workspace_id": "00000000-0000-0000-0000-000000000000", - "created_at": "2023-11-30T06:27:14.961Z", - "external_type": "pti_site", - "external_type_display_name": "PTI site", - "connected_account_ids": [ - "11111111-1111-1111-1111-222222222222" - ], - "image_url": "https://connect.getseam.com/assets/images/acs_systems/pti_site.png", - "image_alt_text": "PTI site Logo" -} -``` -{% endtab %} - -{% tab title="Java" %} -```json -// Coming soon! -``` -{% endtab %} - -{% tab title="Go" %} -```json -{ - "acs_system": { - "acs_system_id": "11111111-1111-1111-1111-111111111111", - "name": "Example Inc", - "workspace_id": "00000000-0000-0000-0000-000000000000", - "created_at": "2023-11-30T06:27:14.961Z", - "external_type": "pti_site", - "external_type_display_name": "PTI site", - "connected_account_ids": [ - "11111111-1111-1111-1111-222222222222" - ], - "image_url": "https://connect.getseam.com/assets/images/acs_systems/pti_site.png", - "image_alt_text": "PTI site Logo" - }, - "ok": true -} -``` -{% endtab %} -{% endtabs %} diff --git a/docs/api-clients/acs/systems/list.md b/docs/api-clients/acs/systems/list.md deleted file mode 100644 index a3d94ff2..00000000 --- a/docs/api-clients/acs/systems/list.md +++ /dev/null @@ -1,228 +0,0 @@ ---- -description: Get all access control systems ---- - -# List Systems - -Returns a list of all [access control systems](../../../products/access-systems/). - -{% swagger src="https://connect.getseam.com/openapi.json" path="/acs/systems/list" method="post" %} -[https://connect.getseam.com/openapi.json](https://connect.getseam.com/openapi.json) -{% endswagger %} - -## Request - -To filter the list of returned access control systems by a specific [connected account](../../../core-concepts/connected-accounts/) ID, include the `connected_account_id` in the request body. If you omit the `connected_account_id` parameter, the response includes all access control systems connected to your [workspace](../../../core-concepts/workspaces/). - -### Request Body Parameters - -
ParameterTypeDescription
connected_account_idString (UUID)
Optional		ID of the connected account
- -### Sample Request - -{% tabs %} -{% tab title="Python" %} -```python -seam.acs.systems.list() -``` -{% endtab %} - -{% tab title="cURL (bash)" %} -```bash -# Use GET or POST. -curl -X 'GET' \ - 'https://connect.getseam.com/acs/systems/list' \ - -H 'accept: application/json' \ - -H "Authorization: Bearer ${API_KEY}" \ - -H 'Content-Type: application/json' -``` -{% endtab %} - -{% tab title="JavaScript" %} -```javascript -await seam.acs.systems.list(); -``` -{% endtab %} - -{% tab title="Ruby" %} -```ruby -# Coming soon! -``` -{% endtab %} - -{% tab title="PHP" %} -```php -$seam->acs->systems->list(); -``` -{% endtab %} - -{% tab title="C#" %} -```csharp -seam.SystemsAcs.List(); -``` -{% endtab %} - -{% tab title="Java" %} -```java -// Coming soon! -``` -{% endtab %} - -{% tab title="Go" %} -```go -acs_systems, uErr := client.Acs.Systems.List( - context.Background(), &acs.SystemsListRequest{}, -) -``` -{% endtab %} -{% endtabs %} - -## Response - -Returns an `acs_systems` array, in which each returned `acs_system` contains the following properties: - -
PropertyDescription
acs_system_idID of the access control system
nameName of the access control system
workspace_idID of the workspace that contains the access control system
created_atDate and time at which the access control system was created
external_typeBrand-specific terminology for the access control system type
external_type_display_nameDisplay name that corresponds to the brand-specific terminology for the access control system type
connected_account_idsArray of connected account IDs associated with the access control system
image_urlURL for the image that represents the access control system
image_alt_textAlternative text for the access control system image
- -### Sample Response - -{% tabs %} -{% tab title="Python" %} -``` -[ - AcsSystem( - acs_system_id='11111111-1111-1111-1111-111111111111', - name='Example Inc', - workspace_id='00000000-0000-0000-0000-000000000000', - created_at='2023-11-30T06:27:14.961Z', - external_type='pti_site', - external_type_display_name='PTI site", - connected_account_ids=[ - '11111111-1111-1111-1111-222222222222' - ], - image_url='https://connect.getseam.com/assets/images/acs_systems/pti_site.png', - image_alt_text='PTI site Logo' - ), - ... -] -``` -{% endtab %} - -{% tab title="cURL (bash)" %} -```json -{ - "acs_systems": [ - { - "acs_system_id": "11111111-1111-1111-1111-111111111111", - "name": "Example Inc", - "workspace_id": "00000000-0000-0000-0000-000000000000", - "created_at": "2023-11-30T06:27:14.961Z", - "external_type": "pti_site", - "external_type_display_name": "PTI site", - "connected_account_ids": [ - "11111111-1111-1111-1111-222222222222" - ], - "image_url": "https://connect.getseam.com/assets/images/acs_systems/pti_site.png", - "image_alt_text": "PTI site Logo" - }, - ... - ], - "ok": true -} -``` -{% endtab %} - -{% tab title="JavaScript" %} -```json -[ - { - acs_system_id: '11111111-1111-1111-1111-111111111111', - name: 'Example Inc', - workspace_id: '00000000-0000-0000-0000-000000000000', - created_at: '2023-11-30T06:27:14.961Z', - external_type: 'pti_site', - external_type_display_name: 'PTI site', - connected_account_ids: [ '11111111-1111-1111-1111-222222222222' ], - image_url: 'https://connect.getseam.com/assets/images/acs_systems/pti_site.png', - image_alt_text: 'PTI site Logo' - }, - ... -] -``` -{% endtab %} - -{% tab title="Ruby" %} -``` -# Coming soon! -``` -{% endtab %} - -{% tab title="PHP" %} -```json -[ - { - "acs_system_id": "11111111-1111-1111-1111-111111111111", - "name": "Example Inc", - "workspace_id": "00000000-0000-0000-0000-000000000000", - "created_at": "2023-11-30T06:27:14.961Z", - "external_type": "pti_site", - "external_type_display_name": "PTI site", - "connected_account_ids": [ - "11111111-1111-1111-1111-222222222222" - ], - "image_url": "https://connect.getseam.com/assets/images/acs_systems/pti_site.png", - "image_alt_text": "PTI site Logo" - }, - ... -] -``` -{% endtab %} - -{% tab title="C#" %} -```json -{ - "acs_system_id": "11111111-1111-1111-1111-111111111111", - "name": "Example Inc", - "workspace_id": "00000000-0000-0000-0000-000000000000", - "created_at": "2023-11-30T06:27:14.961Z", - "external_type": "pti_site", - "external_type_display_name": "PTI site", - "connected_account_ids": [ - "11111111-1111-1111-1111-222222222222" - ], - "image_url": "https://connect.getseam.com/assets/images/acs_systems/pti_site.png", - "image_alt_text": "PTI site Logo" -} -... -``` -{% endtab %} - -{% tab title="Java" %} -```json -// Coming soon! -``` -{% endtab %} - -{% tab title="Go" %} -```json -{ - "acs_systems": [ - { - "acs_system_id": "11111111-1111-1111-1111-111111111111", - "name": "Example Inc", - "workspace_id": "00000000-0000-0000-0000-000000000000", - "created_at": "2023-11-30T06:27:14.961Z", - "external_type": "pti_site", - "external_type_display_name": "PTI site", - "connected_account_ids": [ - "11111111-1111-1111-1111-222222222222" - ], - "image_url": "https://connect.getseam.com/assets/images/acs_systems/pti_site.png", - "image_alt_text": "PTI site Logo" - }, - ... - ], - "ok": true -} -``` -{% endtab %} -{% endtabs %} diff --git a/docs/api-clients/acs/systems/list_compatible_credential_manager_acs_systems.md b/docs/api-clients/acs/systems/list_compatible_credential_manager_acs_systems.md deleted file mode 100644 index 4ed2696a..00000000 --- a/docs/api-clients/acs/systems/list_compatible_credential_manager_acs_systems.md +++ /dev/null @@ -1,261 +0,0 @@ ---- -description: >- - Get all credential manager ACS systems that are compatible with a specified - ACS ---- - -# List Compatible Credential Manager ACS Systems - -Returns a list of all credential manager ACS systems that are compatible with a specified [access control system](../../../products/access-systems/). - -{% swagger src="https://connect.getseam.com/openapi.json" path="/acs/systems/list_compatible_credential_manager_acs_systems" method="post" %} -[https://connect.getseam.com/openapi.json](https://connect.getseam.com/openapi.json) -{% endswagger %} - -## Request - -Specify the ACS [system](./) for which you want to retrieve all compatible credential manager ACS systems by including the corresponding `acs_system_id` in the request body. - -### Request Body Parameters - -
ParameterTypeDescription
acs_system_idString (UUID)
Required		ID of the ACS system for which you want to retrieve all compatible credential manager ACS systems
- -### Sample Request - -{% tabs %} -{% tab title="Python" %} -```python -seam.acs.systems.list_compatible_credential_manager_acs_systems( - acs_system_id="11111111-1111-1111-1111-111111111111" -) -``` -{% endtab %} - -{% tab title="cURL (bash)" %} -```bash -# Use GET or POST. -curl -X 'GET' \ - 'https://connect.getseam.com/acs/systems/list_compatible_credential_manager_acs_systems' \ - -H 'accept: application/json' \ - -H "Authorization: Bearer ${API_KEY}" \ - -H 'Content-Type: application/json' \ - -d '{ - "acs_system_id": "11111111-1111-1111-1111-111111111111" -}' -``` -{% endtab %} - -{% tab title="JavaScript" %} -```javascript -await seam.acs.systems.listCompatibleCredentialManagerAcsSystems({ - acs_system_id: "11111111-1111-1111-1111-111111111111" -}); -``` -{% endtab %} - -{% tab title="Ruby" %} -```ruby -# Coming soon! -``` -{% endtab %} - -{% tab title="PHP" %} -```php -$seam->acs->systems->list_compatible_credential_manager_acs_systems( - acs_system_id: "11111111-1111-1111-1111-111111111111" -); -``` -{% endtab %} - -{% tab title="C#" %} -```csharp -seam.SystemsAcs.ListCompatibleCredentialManagerAcsSystems( - acsSystemId: "11111111-1111-1111-1111-111111111111" -); -``` -{% endtab %} - -{% tab title="Java" %} -```java -// Coming soon! -``` -{% endtab %} - -{% tab title="Go" %} -```go -credential_manager, uErr := client.Acs.Systems.ListCompatibleCredentialManagerAcsSystems( - context.Background(), &acs.SystemsListCompatibleCredentialManagerAcsSystemsRequest{ - AcsSystemId: "11111111-1111-1111-1111-111111111111", - }, -) -``` -{% endtab %} -{% endtabs %} - -## Response - -Returns an `acs_systems` array of compatible credential managers, in which each returned credential manager is an `acs_system` that contains the following properties: - -
PropertyDescription
acs_system_idID of the credential manager
nameName of the credential manager
workspace_idID of the workspace that contains the credential manager
created_atDate and time at which the credential manager was created
external_typeBrand-specific terminology for the credential manager type
external_type_display_nameDisplay name that corresponds to the brand-specific terminology for the credential manager type
connected_account_idsArray of connected account IDs associated with the credential manager
image_urlURL for the image that represents the credential manager
image_alt_textAlternative text for the credential manager image
- -### Sample Response - -{% tabs %} -{% tab title="Python" %} -``` -[ - AcsSystem( - acs_system_id='88888888-8888-8888-8888-888888888888', - connected_account_ids=[ - '11111111-1111-1111-1111-222222222222' - ], - created_at='2024-03-26T14:32:06.350Z', - external_type='example_credential_service', - external_type_display_name='Example Credential Service', - image_alt_text='Example Credential Service Logo', - image_url='https://connect.getseam.com/_next/image?url=https://connect.getseam.com/assets/images/acs_systems/example_credential_service.png', - name='Example Credential Service', - workspace_id='00000000-0000-0000-0000-000000000000', - can_automate_enrollment=True - ), - ... -] -``` -{% endtab %} - -{% tab title="cURL (bash)" %} -```json -{ - "acs_systems": [ - { - "acs_system_id": "88888888-8888-8888-8888-888888888888", - "name": "Example Credential Service", - "workspace_id": "00000000-0000-0000-0000-000000000000", - "created_at": "2024-03-26T14:32:06.350Z", - "external_type": "example_credential_service", - "external_type_display_name": "Example Credential Service", - "connected_account_ids": [ - "11111111-1111-1111-1111-222222222222" - ], - "image_url": "https://connect.getseam.com/_next/image?url=https://connect.getseam.com/assets/images/acs_systems/example_credential_service.png", - "image_alt_text": "Example Credential Service Logo", - "errors": [], - "warnings": [], - "can_automate_enrollment": true - }, - ... - ], - "ok": true -} -``` -{% endtab %} - -{% tab title="JavaScript" %} -```json -[ - { - acs_system_id: '88888888-8888-8888-8888-888888888888', - name: 'Example Credential Service', - workspace_id: '00000000-0000-0000-0000-000000000000', - created_at: '2024-03-26T14:32:06.350Z', - external_type: 'example_credential_service', - external_type_display_name: 'Example Credential Service', - connected_account_ids: [ - '11111111-1111-1111-1111-222222222222' - ], - image_url: 'https://connect.getseam.com/_next/image?url=https://connect.getseam.com/assets/images/acs_systems/example_credential_service.png', - image_alt_text: 'Example Credential Service Logo', - errors: [], - warnings: [], - can_automate_enrollment: true - }, - ... -] -``` -{% endtab %} - -{% tab title="Ruby" %} -``` -# Coming soon! -``` -{% endtab %} - -{% tab title="PHP" %} -```json -[ - { - "acs_system_id": "88888888-8888-8888-8888-888888888888", - "can_automate_enrollment": true, - "connected_account_ids": [ - "11111111-1111-1111-1111-222222222222" - ], - "created_at": "2024-03-26T14:32:06.350Z", - "errors": [], - "external_type": "example_credential_service", - "external_type_display_name": "Example Credential Service", - "image_alt_text": "Example Credential Service Logo", - "image_url": "https:\/\/connect.getseam.com\/_next\/image?url=https:\/\/connect.getseam.com\/assets\/images\/acs_systems\/example_credential_service.png", - "name": "Example Credential Service", - "warnings": [], - "workspace_id": "00000000-0000-0000-0000-000000000000" - }, - ... -] -``` -{% endtab %} - -{% tab title="C#" %} -```json -{ - "acs_system_id": "88888888-8888-8888-8888-888888888888", - "name": "Example Credential Service", - "workspace_id": "00000000-0000-0000-0000-000000000000", - "created_at": "2024-03-26T14:32:06.350Z", - "external_type": "example_credential_service", - "external_type_display_name": "Example Credential Service", - "connected_account_ids": [ - "11111111-1111-1111-1111-222222222222" - ], - "image_url": "https://connect.getseam.com/_next/image?url=https://connect.getseam.com/assets/images/acs_systems/example_credential_service.png", - "image_alt_text": "Example Credential Service Logo", - "errors": [], - "warnings": [], - "can_automate_enrollment": true -} -... -``` -{% endtab %} - -{% tab title="Java" %} -```json -// Coming soon! -``` -{% endtab %} - -{% tab title="Go" %} -```json -{ - "acs_systems": [ - { - "acs_system_id": "88888888-8888-8888-8888-888888888888", - "name": "Example Credential Service", - "workspace_id": "00000000-0000-0000-0000-000000000000", - "created_at": "2024-03-26T14:32:06.350Z", - "external_type": "example_credential_service", - "external_type_display_name": "Example Credential Service", - "connected_account_ids": [ - "11111111-1111-1111-1111-222222222222" - ], - "image_url": "https://connect.getseam.com/_next/image?url=https://connect.getseam.com/assets/images/acs_systems/example_credential_service.png", - "image_alt_text": "Example Credential Service Logo", - "errors": [], - "warnings": [], - "can_automate_enrollment": true - }, - ... - ], - "ok": true -} -``` -{% endtab %} -{% endtabs %} diff --git a/docs/api-clients/acs/users/README.md b/docs/api-clients/acs/users/README.md deleted file mode 100644 index 303cb76c..00000000 --- a/docs/api-clients/acs/users/README.md +++ /dev/null @@ -1,27 +0,0 @@ ---- -description: ACS users to whom to grant access to specific physical spaces ---- - -# Users - -The `acs_user` object represents a [user](../../../products/access-systems/user-management.md) within an [access control system](../../../products/access-systems/) (ACS). - -## `acs_user` Properties - -The `acs_user` object has the following properties: - -
PropertyTypeDescription
acs_user_idString (UUID)
Required		ID of the user
acs_system_idString (UUID)
Required		ID of the access control system that contains the user
workspace_idString (UUID)
Required		ID of the workspace that contains the user
created_atString
Required		Date and time at which the user was created
display_nameString
Required		Display name for the user
external_typeString
Optional		Brand-specific terminology for the user type
external_type_display_nameString
Optional		Display name that corresponds to the brand-specific terminology for the user type
is_suspendedBoolean
Required		Indicates whether the user is currently suspended
access_scheduleObject
Optional		starts_at and ends_at dates/times for the user's access
user_identity_idString (UUID)
Optional		ID of the user identity associated with the user
user_identity_email_addressString
Optional		Email address of the user identity associated with the user
user_identity_phone_numberString
Optional		Phone number of the user identity associated with the user in E.164 format (for example, +15555550100)
full_nameString
Optional		Full name of the user
email_addressString
Optional		Email address of the user
phone_numberString
Optional		Phone number of the user in E.164 format (for example, +15555550100)
- -## `acs_user` Methods - -You can perform the following actions on `acs_user` objects: - -* [Create a user](create.md) -* [List users](list.md) -* [Get a user](get.md) -* [Update a user](update.md) -* [Suspend a user](suspend.md) -* [Unsuspend a user](unsuspend.md) -* [Delete a user](delete.md) -* [Add a user to an access group](add_to_access_group.md) -* [Remove a user from an access group](remove_from_access_group.md) diff --git a/docs/api-clients/acs/users/add_to_access_group.md b/docs/api-clients/acs/users/add_to_access_group.md deleted file mode 100644 index f56d266f..00000000 --- a/docs/api-clients/acs/users/add_to_access_group.md +++ /dev/null @@ -1,155 +0,0 @@ ---- -description: Add a specified ACS user to a specified access group ---- - -# Add a User to an Access Group - -Adds a specified [ACS user](../../../products/access-systems/user-management.md) to a specified [access group](../../../products/access-systems/assigning-users-to-access-groups.md). - -{% swagger src="https://connect.getseam.com/openapi.json" path="/acs/users/add_to_access_group" method="post" %} -[https://connect.getseam.com/openapi.json](https://connect.getseam.com/openapi.json) -{% endswagger %} - -## Request - -Specify the desired ACS user and access group by including the corresponding `acs_user_id` and `acs_access_group_id` in the request body. - -### Request Body Parameters - -
ParameterTypeDescription
acs_user_idString (UUID)
Required		ID of the desired ACS user
acs_access_group_idString (UUID)
Required		ID of the desired access group
- -### Sample Request - -{% tabs %} -{% tab title="Python" %} -```python -seam.acs.users.add_to_access_group( - acs_user_id="33333333-3333-3333-3333-333333333333", - acs_access_group_id="44444444-4444-4444-4444-444444444444" -) -``` -{% endtab %} - -{% tab title="cURL (bash)" %} -```bash -curl -X 'POST' \ - 'https://connect.getseam.com/acs/users/add_to_access_group' \ - -H "Authorization: Bearer ${API_KEY}" \ - -H 'Content-Type: application/json' \ - -d '{ - "acs_user_id": "33333333-3333-3333-3333-333333333333", - "acs_access_group_id": "44444444-4444-4444-4444-444444444444" -}' -``` -{% endtab %} - -{% tab title="JavaScript" %} -```javascript -await seam.acs.users.addToAccessGroup({ - acs_user_id: "33333333-3333-3333-3333-333333333333", - acs_access_group_id: "44444444-4444-4444-4444-444444444444" -}); -``` -{% endtab %} - -{% tab title="Ruby" %} -```ruby -# Coming soon! -``` -{% endtab %} - -{% tab title="PHP" %} -```php -$seam->acs->users->add_to_access_group( - acs_user_id: "33333333-3333-3333-3333-333333333333", - acs_access_group_id: "44444444-4444-4444-4444-444444444444" -); -``` -{% endtab %} - -{% tab title="C#" %} -```csharp -seam.UsersAcs.AddToAccessGroup( - acsUserId: "33333333-3333-3333-3333-333333333333", - acsAccessGroupId: "44444444-4444-4444-4444-444444444444" -); -``` -{% endtab %} - -{% tab title="Java" %} -```java -// Coming soon! -``` -{% endtab %} - -{% tab title="Go" %} -```go -add, uErr := client.Acs.Users.AddToAccessGroup( - context.Background(), &acs.UsersAddToAccessGroupRequest{ - AcsUserId: "33333333-3333-3333-3333-333333333333", - AcsAccessGroupId: "44444444-4444-4444-4444-444444444444", - }, -) -``` -{% endtab %} -{% endtabs %} - -## Response - -Returns a Boolean `ok` status indicator or void. - -### Sample Response - -{% tabs %} -{% tab title="Python" %} -``` -None -``` -{% endtab %} - -{% tab title="cURL (bash)" %} -```json -{ - "ok": true -} -``` -{% endtab %} - -{% tab title="JavaScript" %} -```json -void -``` -{% endtab %} - -{% tab title="Ruby" %} -``` -# Coming soon! -``` -{% endtab %} - -{% tab title="PHP" %} -``` -void -``` -{% endtab %} - -{% tab title="C#" %} -``` -void -``` -{% endtab %} - -{% tab title="Java" %} -```json -// Coming soon! -``` -{% endtab %} - -{% tab title="Go" %} -```json -{ - "ok": true -} -``` -{% endtab %} -{% endtabs %} diff --git a/docs/api-clients/acs/users/create.md b/docs/api-clients/acs/users/create.md deleted file mode 100644 index b0043f10..00000000 --- a/docs/api-clients/acs/users/create.md +++ /dev/null @@ -1,311 +0,0 @@ ---- -description: Create a new ACS user ---- - -# Create a User - -Creates a new [ACS user](../../../products/access-systems/user-management.md). - -{% swagger src="https://connect.getseam.com/openapi.json" path="/acs/users/create" method="post" %} -[https://connect.getseam.com/openapi.json](https://connect.getseam.com/openapi.json) -{% endswagger %} - -## Request - -Specify the characteristics of the new ACS user by including the corresponding parameters in the request body. Also, include the `acs_system_id` of the [access control system](../../../products/access-systems/) to which you want to add the new ACS user. In addition, you can specify the `acs_access_group_ids` of the [access groups](../../../products/access-systems/assigning-users-to-access-groups.md) to which you want to add the new ACS user, as well as a `user_identity_id` if you want to associate the new ACS user with a [user identity](../../user\_identities/). - -### Request Body Parameters - -
ParameterTypeDescription
acs_system_idString (UUID)
Required		ID of the access control system to which to add the new ACS user.
acs_access_group_idsArray of strings (UUIDs)
Optional		Array of access group IDs to indicate the access groups to which to add the new ACS user.
user_identity_idString (UUID)
Optional		ID of the user identity with which to associate the new ACS user.
full_nameString
Optional		Full name of the new ACS user.
email_addressString
Optional		Email address of the new ACS user.
phone_numberString
Optional		Phone number of the new ACS user in E.164 format (for example, +15555550100).
access_scheduleObject
Optional		starts_at and ends_at timestamps for the new ACS user's access.
If you specify an access_schedule, you must include both starts_at and ends_at. ends_at must be a time in the future and after starts_at.
Only applicable to Salto KS access control systems.
- -### Sample Request - -{% tabs %} -{% tab title="Python" %} -```python -seam.acs.users.create( - acs_system_id="11111111-1111-1111-1111-111111111111", - user_identity_id="22222222-2222-2222-2222-222222222222", - acs_access_group_ids=["44444444-4444-4444-4444-444444444444"], - full_name="Jane Doe", - email_address="jane@example.com", - phone_number="+15555550100", - access_schedule={ - "starts_at": "2024-03-01T10:40:00Z", - "ends_at": "2024-03-04T10:40:00Z" - } -) -``` -{% endtab %} - -{% tab title="cURL (bash)" %} -```bash -curl -X 'POST' \ - 'https://connect.getseam.com/acs/users/create' \ - -H 'accept: application/json' \ - -H "Authorization: Bearer ${API_KEY}" \ - -H 'Content-Type: application/json' \ - -d '{ - "acs_system_id": "11111111-1111-1111-1111-111111111111", - "user_identity_id": "22222222-2222-2222-2222-222222222222", - "acs_access_group_ids": ["44444444-4444-4444-4444-444444444444"], - "full_name": "Jane Doe", - "email_address": "jane@example.com", - "phone_number": "+15555550100", - "access_schedule": { - "starts_at": "2024-03-01T10:40:00Z", - "ends_at": "2024-03-04T10:40:00Z" - } -}' -``` -{% endtab %} - -{% tab title="JavaScript" %} -```javascript -await seam.acs.users.create({ - acs_system_id: "11111111-1111-1111-1111-111111111111", - user_identity_id: "22222222-2222-2222-2222-222222222222", - acs_access_group_ids: ["44444444-4444-4444-4444-444444444444"], - full_name: "Jane Doe", - email_address: "jane@example.com", - phone_number: "+15555550100", - access_schedule: { - "starts_at": "2024-03-01T10:40:00Z", - "ends_at": "2024-03-04T10:40:00Z" - } -}); -``` -{% endtab %} - -{% tab title="Ruby" %} -```ruby -# Coming soon! -``` -{% endtab %} - -{% tab title="PHP" %} -```php -$seam->acs->users->create( - acs_system_id: "11111111-1111-1111-1111-111111111111", - user_identity_id: "22222222-2222-2222-2222-222222222222", - acs_access_group_ids: ["44444444-4444-4444-4444-444444444444"], - full_name: "Jane Doe", - email_address: "jane@example.com", - phone_number: "+15555550100", - access_schedule: array( - "starts_at" => "2024-03-01T10:40:00Z", - "ends_at" => "2024-03-04T10:40:00Z" - ) -); -``` -{% endtab %} - -{% tab title="C#" %} -```csharp -seam.UsersAcs.Create( - acsSystemId: "11111111-1111-1111-1111-111111111111", - userIdentityId: "22222222-2222-2222-2222-222222222222", - acsAccessGroupIds: new List(new string[] {"44444444-4444-4444-4444-444444444444"}), - fullName: "Jane Doe", - emailAddress: "jane@example.com", - phoneNumber: "+15555550100", - accessSchedule: new Dictionary() - { - {"starts_at", "2024-03-01T10:40:00Z"}, - {"ends_at", "2024-03-04T10:40:00Z"} - } -); -``` -{% endtab %} - -{% tab title="Java" %} -```java -// Coming soon! -``` -{% endtab %} - -{% tab title="Go" %} -```go -startsAt, err := time.Parse(time.RFC3339, "2024-03-01T10:40:00Z") -endsAt, err := time.Parse(time.RFC3339, "2024-03-04T10:40:00Z") -if err != nil { - return err -} - -acs_user, uErr := client.Acs.Users.Create( - context.Background(), &acs.UsersCreateRequest{ - AcsSystemId: "11111111-1111-1111-1111-111111111111", - UserIdentityId: api.String("22222222-2222-2222-2222-222222222222"), - AcsAccessGroupIds: []string{"44444444-4444-4444-4444-444444444444"}, - FullName: api.String("Jane Doe"), - EmailAddress: api.String("jane@example.com"), - PhoneNumber: api.String("+15555550100"), - AccessSchedule: &acs.UsersCreateRequestAccessSchedule{ - StartsAt: startsAt, - EndsAt: endsAt, - }, - }, -) -``` -{% endtab %} -{% endtabs %} - -## Response - -Returns an `acs_user` containing the following properties: - -
PropertyDescription
acs_user_idID of the ACS user
display_nameDisplay name for the ACS user
full_nameFull name of the ACS user
emailEmail address of the ACS user (for backward compatibility)
email_addressEmail address of the ACS user
phone_numberPhone number of the ACS user in E.164 format (for example, +15555550100)
acs_system_idID of the access control system that contains the ACS user
workspace_idID of the workspace that contains the ACS user
created_atDate and time at which the ACS user was created
is_suspendedIndicates whether the ACS user is currently suspended
access_schedulestarts_at and ends_at timestamps for the ACS user's access
user_identity_idID of the user identity associated with the ACS user
user_identity_email_addressEmail address of the user identity associated with the ACS user
user_identity_phone_numberPhone number of the user identity associated with the ACS user in E.164 format (for example, +15555550100)
- -### Sample Response - -{% tabs %} -{% tab title="Python" %} -``` -AcsUser( - acs_user_id='33333333-3333-3333-3333-333333333333', - display_name='Jane Doe', - full_name='Jane Doe', - email='jane@example.com', - email_address='jane@example.com', - phone_number='+15555550100', - acs_system_id='11111111-1111-1111-1111-111111111111', - workspace_id='00000000-0000-0000-0000-000000000000', - created_at='2024-04-05T07:14:28.531Z', - is_suspended=False, - access_schedule={ - starts_at='2024-03-01T10:40:00.000Z', - ends_at='2024-03-04T10:40:00.000Z' - }, - user_identity_id='22222222-2222-2222-2222-222222222222' -) -``` -{% endtab %} - -{% tab title="cURL (bash)" %} -```json -{ - "acs_user": { - "acs_user_id": "33333333-3333-3333-3333-333333333333", - "display_name": "Jane Doe", - "full_name": "Jane Doe", - "email": "jane@example.com", - "email_address": "jane@example.com", - "phone_number": "+15555550100", - "acs_system_id": "11111111-1111-1111-1111-111111111111", - "workspace_id": "00000000-0000-0000-0000-000000000000", - "created_at": "2024-04-05T07:14:28.531Z", - "is_suspended": false, - "access_schedule": { - "starts_at": "2024-03-01T10:40:00.000Z", - "ends_at": "2024-03-04T10:40:00.000Z" - }, - "user_identity_id": "22222222-2222-2222-2222-222222222222" - }, - "ok": true -} -``` -{% endtab %} - -{% tab title="JavaScript" %} -```json -{ - acs_user_id: '33333333-3333-3333-3333-333333333333', - display_name: 'Jane Doe', - full_name: 'Jane Doe', - email: 'jane@example.com', - email_address: 'jane@example.com', - phone_number: '+15555550100', - acs_system_id: '11111111-1111-1111-1111-111111111111', - workspace_id: '00000000-0000-0000-0000-000000000000', - created_at: '2024-04-05T07:28:06.012Z', - is_suspended: false, - access_schedule: { - starts_at: '2024-03-01T10:40:00.000Z', - ends_at: '2024-03-04T10:40:00.000Z' - }, - user_identity_id: '22222222-2222-2222-2222-222222222222' -} -``` -{% endtab %} - -{% tab title="Ruby" %} -``` -# Coming soon! -``` -{% endtab %} - -{% tab title="PHP" %} -```json -{ - "acs_user_id": "33333333-3333-3333-3333-333333333333", - "display_name": "Jane Doe", - "full_name": "Jane Doe", - "email": "jane@example.com", - "email_address": "jane@example.com", - "phone_number": "+15555550100", - "acs_system_id": "11111111-1111-1111-1111-111111111111", - "workspace_id": "00000000-0000-0000-0000-000000000000", - "created_at": "2024-04-05T07:14:28.531Z", - "is_suspended": false, - "access_schedule": { - "starts_at": "2024-03-01T10:40:00.000Z", - "ends_at": "2024-03-04T10:40:00.000Z" - }, - "user_identity_id": "22222222-2222-2222-2222-222222222222" -} -``` -{% endtab %} - -{% tab title="C#" %} -```json -{ - "acs_user_id": "33333333-3333-3333-3333-333333333333", - "display_name": "Jane Doe", - "full_name": "Jane Doe", - "email": "jane@example.com", - "email_address": "jane@example.com", - "phone_number": "+15555550100", - "acs_system_id": "11111111-1111-1111-1111-111111111111", - "workspace_id": "00000000-0000-0000-0000-000000000000", - "created_at": "2024-04-05T07:14:28.531Z", - "is_suspended": false, - "access_schedule": { - "starts_at": "2024-03-01T10:40:00.000Z", - "ends_at": "2024-03-04T10:40:00.000Z" - }, - "user_identity_id": "22222222-2222-2222-2222-222222222222" -} -``` -{% endtab %} - -{% tab title="Java" %} -```json -// Coming soon! -``` -{% endtab %} - -{% tab title="Go" %} -```json -{ - "acs_user": { - "acs_user_id": "33333333-3333-3333-3333-333333333333", - "display_name": "Jane Doe", - "full_name": "Jane Doe", - "email": "jane@example.com", - "email_address": "jane@example.com", - "phone_number": "+15555550100", - "acs_system_id": "11111111-1111-1111-1111-111111111111", - "workspace_id": "00000000-0000-0000-0000-000000000000", - "created_at": "2024-04-05T07:57:05.323Z", - "is_suspended": false, - "access_schedule": { - "starts_at": "2024-03-01T10:40:00.000Z", - "ends_at": "2024-03-04T10:40:00.000Z" - }, - "user_identity_id": "22222222-2222-2222-2222-222222222222" - }, - "ok": true -} -``` -{% endtab %} -{% endtabs %} diff --git a/docs/api-clients/acs/users/delete.md b/docs/api-clients/acs/users/delete.md deleted file mode 100644 index 6a4a36a4..00000000 --- a/docs/api-clients/acs/users/delete.md +++ /dev/null @@ -1,150 +0,0 @@ ---- -description: Delete a specified ACS user ---- - -# Delete a User - -Deletes a specified [ACS user](../../../products/access-systems/user-management.md) and invalidates the ACS user's [credentials](../../../capability-guides/access-systems/managing-credentials.md). - -{% swagger src="https://connect.getseam.com/openapi.json" path="/acs/users/delete" method="post" %} -[https://connect.getseam.com/openapi.json](https://connect.getseam.com/openapi.json) -{% endswagger %} - -## Request - -Specify the desired ACS user by including the corresponding `acs_user_id` in the request body. - -### Request Body Parameters - -
ParameterTypeDescription
acs_user_idString (UUID)
Required		ID of the desired ACS user
- -### Sample Request - -{% tabs %} -{% tab title="Python" %} -```python -seam.acs.users.delete( - acs_user_id="33333333-3333-3333-3333-333333333333" -) -``` -{% endtab %} - -{% tab title="cURL (bash)" %} -```bash -curl -X 'POST' \ - 'https://connect.getseam.com/acs/users/delete' \ - -H 'accept: application/json' \ - -H "Authorization: Bearer ${API_KEY}" \ - -H 'Content-Type: application/json' \ - -d '{ - "acs_user_id": "33333333-3333-3333-3333-333333333333" -}' -``` -{% endtab %} - -{% tab title="JavaScript" %} -```javascript -await seam.acs.users.delete({ - acs_user_id: "33333333-3333-3333-3333-333333333333" -}); -``` -{% endtab %} - -{% tab title="Ruby" %} -```ruby -# Coming soon! -``` -{% endtab %} - -{% tab title="PHP" %} -```php -$seam->acs->users->delete( - acs_user_id: "33333333-3333-3333-3333-333333333333" -); -``` -{% endtab %} - -{% tab title="C#" %} -```csharp -seam.UsersAcs.Delete( - acsUserId: "33333333-3333-3333-3333-333333333333" -); -``` -{% endtab %} - -{% tab title="Java" %} -```java -// Coming soon! -``` -{% endtab %} - -{% tab title="Go" %} -```go -deletion, uErr := client.Acs.Users.Delete( - context.Background(), &acs.UsersDeleteRequest{ - AcsUserId: "33333333-3333-3333-3333-333333333333", - }, -) -``` -{% endtab %} -{% endtabs %} - -## Response - -Returns a Boolean `ok` status indicator or void. - -### Sample Response - -{% tabs %} -{% tab title="Python" %} -``` -None -``` -{% endtab %} - -{% tab title="cURL (bash)" %} -```json -{ - "ok": true -} -``` -{% endtab %} - -{% tab title="JavaScript" %} -```json -void -``` -{% endtab %} - -{% tab title="Ruby" %} -``` -# Coming soon! -``` -{% endtab %} - -{% tab title="PHP" %} -``` -void -``` -{% endtab %} - -{% tab title="C#" %} -``` -void -``` -{% endtab %} - -{% tab title="Java" %} -```json -// Coming soon! -``` -{% endtab %} - -{% tab title="Go" %} -```json -{ - "ok": true -} -``` -{% endtab %} -{% endtabs %} diff --git a/docs/api-clients/acs/users/get.md b/docs/api-clients/acs/users/get.md deleted file mode 100644 index 0c0c2a87..00000000 --- a/docs/api-clients/acs/users/get.md +++ /dev/null @@ -1,263 +0,0 @@ ---- -description: Get a specified ACS user ---- - -# Get a User - -Returns a specified [ACS user](../../../products/access-systems/user-management.md). - -{% swagger src="https://connect.getseam.com/openapi.json" path="/acs/users/get" method="post" %} -[https://connect.getseam.com/openapi.json](https://connect.getseam.com/openapi.json) -{% endswagger %} - -## Request - -Specify the desired ACS user by including the corresponding `acs_user_id` in the request body. - -### Request Body Parameters - -
ParameterTypeDescription
acs_user_idString (UUID)
Required		ID of the desired ACS user
- -### Sample Request - -{% tabs %} -{% tab title="Python" %} -```python -seam.acs.users.get( - acs_user_id="33333333-3333-3333-3333-333333333333" -) -``` -{% endtab %} - -{% tab title="cURL (bash)" %} -```bash -# Use GET or POST. -curl -X 'GET' \ - 'https://connect.getseam.com/acs/users/get' \ - -H 'accept: application/json' \ - -H "Authorization: Bearer ${API_KEY}" \ - -H 'Content-Type: application/json' \ - -d '{ - "acs_user_id": "33333333-3333-3333-3333-333333333333" -}' -``` -{% endtab %} - -{% tab title="JavaScript" %} -```javascript -await seam.acs.users.get({ - acs_user_id: "33333333-3333-3333-3333-333333333333" -}); -``` -{% endtab %} - -{% tab title="Ruby" %} -```ruby -# Coming soon! -``` -{% endtab %} - -{% tab title="PHP" %} -```php -$seam->acs->users->get( - acs_user_id: "33333333-3333-3333-3333-333333333333" -); -``` -{% endtab %} - -{% tab title="C#" %} -```csharp -seam.AcsUsers.Get( - acsUserId: "33333333-3333-3333-3333-333333333333" -); -``` -{% endtab %} - -{% tab title="Java" %} -```java -// Coming soon! -``` -{% endtab %} - -{% tab title="Go" %} -```go -acs_user, uErr := client.Acs.Users.Get( - context.Background(), &acs.UsersGetRequest{ - AcsUserId: "33333333-3333-3333-3333-333333333333", - }, -) -``` -{% endtab %} -{% endtabs %} - -## Response - -Returns an `acs_user` containing the following properties: - -
PropertyDescription
acs_user_idID of the ACS user
display_nameDisplay name for the ACS user
full_nameFull name of the ACS user
emailEmail address of the ACS user (for backward compatibility)
email_addressEmail address of the ACS user
phone_numberPhone number of the ACS user in E.164 format (for example, +15555550100)
acs_system_idID of the access control system that contains the ACS user
workspace_idID of the workspace that contains the ACS user
created_atDate and time at which the ACS user was created
is_suspendedIndicates whether the ACS user is currently suspended
access_schedulestarts_at and ends_at dates/times for the ACS user's access
user_identity_idID of the user identity associated with the ACS user
user_identity_email_addressEmail address of the user identity associated with the ACS user
user_identity_phone_numberPhone number of the user identity associated with the ACS user in E.164 format (for example, +15555550100)
- -### Sample Response - -{% tabs %} -{% tab title="Python" %} -``` -AcsUser( - acs_user_id='33333333-3333-3333-3333-333333333333', - display_name='Jane Doe', - full_name='Jane Doe', - email='jane@example.com', - email_address='jane@example.com', - phone_number='+15555550100', - acs_system_id='11111111-1111-1111-1111-111111111111', - workspace_id='00000000-0000-0000-0000-000000000000', - created_at='2024-04-05T07:14:28.531Z', - is_suspended=False, - access_schedule={ - 'starts_at': '2024-03-01T10:40:00.000Z', - 'ends_at': '2024-03-04T10:40:00.000Z' - }, - user_identity_id='22222222-2222-2222-2222-222222222222', - user_identity_email_address='jane@example.com', - user_identity_phone_number='+15555550100' -) -``` -{% endtab %} - -{% tab title="cURL (bash)" %} -```json -{ - "acs_user": { - "acs_user_id": "33333333-3333-3333-3333-333333333333", - "display_name": "Jane Doe", - "full_name": "Jane Doe", - "email": "jane@example.com", - "email_address": "jane@example.com", - "phone_number": "+15555550100", - "acs_system_id": "11111111-1111-1111-1111-111111111111", - "workspace_id": "00000000-0000-0000-0000-000000000000", - "created_at": "2024-04-05T07:14:28.531Z", - "is_suspended": false, - "access_schedule": { - "starts_at": "2024-03-01T10:40:00.000Z", - "ends_at": "2024-03-04T10:40:00.000Z" - }, - "user_identity_id": "22222222-2222-2222-2222-222222222222", - "user_identity_email_address": "jane@example.com", - "user_identity_phone_number": "+15555550100" - }, - "ok": true -} -``` -{% endtab %} - -{% tab title="JavaScript" %} -```json -{ - acs_user_id: '33333333-3333-3333-3333-333333333333', - display_name: 'Jane Doe', - full_name: 'Jane Doe', - email: 'jane@example.com', - email_address: 'jane@example.com', - phone_number: '+15555550100', - acs_system_id: '11111111-1111-1111-1111-111111111111', - workspace_id: '00000000-0000-0000-0000-000000000000', - created_at: '2024-04-05T07:14:28.531Z', - is_suspended: false, - access_schedule: { - "starts_at": "2024-03-01T10:40:00.000Z", - "ends_at": "2024-03-04T10:40:00.000Z" - }, - user_identity_id: '22222222-2222-2222-2222-222222222222', - user_identity_email_address: 'jane@example.com', - user_identity_phone_number: '+15555550100' -} -``` -{% endtab %} - -{% tab title="Ruby" %} -``` -# Coming soon! -``` -{% endtab %} - -{% tab title="PHP" %} -```json -{ - "acs_user_id": "33333333-3333-3333-3333-333333333333", - "display_name": "Jane Doe", - "full_name": "Jane Doe", - "email": "jane@example.com", - "email_address": "jane@example.com", - "phone_number": "+15555550100", - "acs_system_id": "11111111-1111-1111-1111-111111111111", - "workspace_id": "00000000-0000-0000-0000-000000000000", - "created_at": "2024-04-05T07:14:28.531Z", - "is_suspended": false, - "access_schedule": { - "starts_at": "2024-03-01T10:40:00.000Z", - "ends_at": "2024-03-04T10:40:00.000Z" - }, - "user_identity_id": "22222222-2222-2222-2222-222222222222", - "user_identity_email_address": "jane@example.com", - "user_identity_phone_number": "+15555550100" -} -``` -{% endtab %} - -{% tab title="C#" %} -```json -{ - "acs_user_id": "33333333-3333-3333-3333-333333333333", - "display_name": "Jane Doe", - "full_name": "Jane Doe", - "email": "jane@example.com", - "email_address": "jane@example.com", - "phone_number": "+15555550100", - "acs_system_id": "11111111-1111-1111-1111-111111111111", - "workspace_id": "00000000-0000-0000-0000-000000000000", - "created_at": "2024-04-05T07:14:28.531Z", - "is_suspended": false, - "access_schedule": { - "starts_at": "2024-03-01T10:40:00.000Z", - "ends_at": "2024-03-04T10:40:00.000Z" - }, - "user_identity_id": "22222222-2222-2222-2222-222222222222", - "user_identity_email_address": "jane@example.com", - "user_identity_phone_number": "+15555550100" -} -``` -{% endtab %} - -{% tab title="Java" %} -```json -// Coming soon! -``` -{% endtab %} - -{% tab title="Go" %} -```json -{ - "acs_user": { - "acs_user_id": "33333333-3333-3333-3333-333333333333", - "display_name": "Jane Doe", - "full_name": "Jane Doe", - "email": "jane@example.com", - "email_address": "jane@example.com", - "phone_number": "+15555550100", - "acs_system_id": "11111111-1111-1111-1111-111111111111", - "workspace_id": "00000000-0000-0000-0000-000000000000", - "created_at": "2024-04-05T07:14:28.531Z", - "is_suspended": false, - "access_schedule": { - "starts_at": "2024-03-01T10:40:00.000Z", - "ends_at": "2024-03-04T10:40:00.000Z" - }, - "user_identity_id": "22222222-2222-2222-2222-222222222222", - "user_identity_email_address": "jane@example.com", - "user_identity_phone_number": "+15555550100" - }, - "ok": true -} -``` -{% endtab %} -{% endtabs %} diff --git a/docs/api-clients/acs/users/list.md b/docs/api-clients/acs/users/list.md deleted file mode 100644 index 1b29e5c0..00000000 --- a/docs/api-clients/acs/users/list.md +++ /dev/null @@ -1,303 +0,0 @@ ---- -description: Get all ACS users ---- - -# List Users - -Returns a list of all [ACS users](../../../products/access-systems/user-management.md). - -{% swagger src="https://connect.getseam.com/openapi.json" path="/acs/users/list" method="post" %} -[https://connect.getseam.com/openapi.json](https://connect.getseam.com/openapi.json) -{% endswagger %} - -## Request - -To filter the list of returned ACS users by a specific [access control system](../../../products/access-systems/), [user identity](../../user_identities/), user identity phone number, or user identity email address, include one or more of the `acs_system_id`, `user_identity_id`, `user_identity_phone_number`, or `user_identity_email_address` parameters, respectively, in the request body. If you omit these parameters, the response includes all ACS users in your [workspace](../../../core-concepts/workspaces/). - -### Request Body Parameters - -
ParameterTypeDescription
user_identity_idString (UUID)
Optional		ID of the user identity for which you want to retrieve all ACS users
user_identity_phone_numberString
Optional		Phone number of the user identity for which you want to retrieve all ACS users, in E.164 format (for example, +15555550100)
user_identity_email_addressString
Optional		Email address of the user identity for which you want to retrieve all ACS users
acs_system_idString (UUID)
Optional		ID of the access control system for which you want to retrieve all ACS users
- -### Sample Request - -{% tabs %} -{% tab title="Python" %} -```python -seam.acs.users.list( - user_identity_id="22222222-2222-2222-2222-222222222222", - user_identity_phone_number="+15555550100", - user_identity_email_address="jane@example.com", - acs_system_id="11111111-1111-1111-1111-111111111111" -) -``` -{% endtab %} - -{% tab title="cURL (bash)" %} -```bash -# Use GET or POST. -curl -X 'GET' \ - 'https://connect.getseam.com/acs/users/list' \ - -H 'accept: application/json' \ - -H "Authorization: Bearer ${API_KEY}" \ - -H 'Content-Type: application/json' \ - -d '{ - "user_identity_id": "22222222-2222-2222-2222-222222222222", - "user_identity_phone_number": "+15555550100", - "user_identity_email_address": "jane@example.com", - "acs_system_id": "11111111-1111-1111-1111-111111111111" -}' -``` -{% endtab %} - -{% tab title="JavaScript" %} -```javascript -await seam.acs.users.list({ - user_identity_id: "22222222-2222-2222-2222-222222222222", - user_identity_phone_number: "+15555550100", - user_identity_email_address: "jane@example.com", - acs_system_id: "11111111-1111-1111-1111-111111111111" -}); -``` -{% endtab %} - -{% tab title="Ruby" %} -```ruby -# Coming soon! -``` -{% endtab %} - -{% tab title="PHP" %} -```php -$seam->acs->users->list( - user_identity_id: "22222222-2222-2222-2222-222222222222", - user_identity_phone_number: "+15555550100", - user_identity_email_address: "jane@example.com", - acs_system_id: "11111111-1111-1111-1111-111111111111" -); -``` -{% endtab %} - -{% tab title="C#" %} -```csharp -seam.UsersAcs.List( - userIdentityId: "22222222-2222-2222-2222-222222222222", - userIdentityPhoneNumber: "+15555550100", - userIdentityEmailAddress: "jane@example.com", - acsSystemId: "11111111-1111-1111-1111-111111111111" -); -``` -{% endtab %} - -{% tab title="Java" %} -```java -// Coming soon! -``` -{% endtab %} - -{% tab title="Go" %} -```go -acs_users, uErr := client.Acs.Users.List( - context.Background(), &acs.UsersListRequest{ - UserIdentityId: api.String("22222222-2222-2222-2222-222222222222"), - UserIdentityPhoneNumber: api.String("+15555550100"), - UserIdentityEmailAddress: api.String("jane@example.com"), - AcsSystemId: api.String("11111111-1111-1111-1111-111111111111") - }, -) -``` -{% endtab %} -{% endtabs %} - -## Response - -Returns an `acs_users` array, in which each returned `acs_user` contains the following properties: - -
PropertyDescription
acs_user_idID of the ACS user
display_nameDisplay name for the ACS user
full_nameFull name of the ACS user
emailEmail address of the ACS user (for backward compatibility)
email_addressEmail address of the ACS user
phone_numberPhone number of the ACS user in E.164 format (for example, +15555550100)
acs_system_idID of the access control system that contains the ACS user
workspace_idID of the workspace that contains the ACS user
created_atDate and time at which the ACS user was created
is_suspendedIndicates whether the ACS user is currently suspended
access_schedulestarts_at and ends_at dates/times for the ACS user's access
user_identity_idID of the user identity associated with the ACS user
user_identity_full_nameFull name of the user identity associated with the ACS user
user_identity_email_addressEmail address of the user identity associated with the ACS user
user_identity_phone_numberPhone number of the user identity associated with the ACS user in E.164 format (for example, +15555550100)
- -### Sample Response - -{% tabs %} -{% tab title="Python" %} -``` -[ - AcsUser( - acs_user_id="33333333-3333-3333-3333-333333333333', - display_name='Jane Doe', - full_name='Jane Doe', - email='jane@example.com', - email_address='jane@example.com', - phone_number='+15555550100', - acs_system_id='11111111-1111-1111-1111-111111111111', - workspace_id='00000000-0000-0000-0000-000000000000", - created_at='2024-04-05T07:14:28.531Z', - is_suspended=False, - access_schedule={ - 'starts_at': '2024-03-01T10:40:00.000Z', - 'ends_at': '2024-03-04T10:40:00.000Z' - }, - user_identity_id='22222222-2222-2222-2222-222222222222', - user_identity_full_name='Jane Doe', - user_identity_email_address='jane@example.com', - user_identity_phone_number='+15555550100' - ), - ... -] -``` -{% endtab %} - -{% tab title="cURL (bash)" %} -```json -{ - "acs_users": [ - { - "acs_user_id": "33333333-3333-3333-3333-333333333333", - "display_name": "Jane Doe", - "full_name": "Jane Doe", - "email": "jane@example.com", - "email_address": "jane@example.com", - "phone_number": "+15555550100", - "acs_system_id": "11111111-1111-1111-1111-111111111111", - "workspace_id": "00000000-0000-0000-0000-000000000000", - "created_at": "2024-04-05T07:14:28.531Z", - "is_suspended": false, - "access_schedule": { - "starts_at": "2024-03-01T10:40:00.000Z", - "ends_at": "2024-03-04T10:40:00.000Z" - }, - "user_identity_id": "22222222-2222-2222-2222-222222222222", - "user_identity_full_name": "Jane Doe", - "user_identity_email_address": "jane@example.com", - "user_identity_phone_number": "+15555550100" - }, - ... - ], - "ok": true -} -``` -{% endtab %} - -{% tab title="JavaScript" %} -```json -[ - { - acs_user_id: '33333333-3333-3333-3333-333333333333', - display_name: 'Jane Doe', - full_name: 'Jane Doe', - email: 'jane@example.com', - email_address: 'jane@example.com', - phone_number: '+15555550100', - acs_system_id: '11111111-1111-1111-1111-111111111111', - workspace_id: '00000000-0000-0000-0000-000000000000', - created_at: '2024-04-05T07:14:28.531Z', - is_suspended: false, - access_schedule: { - "starts_at": "2024-03-01T10:40:00.000Z", - "ends_at": "2024-03-04T10:40:00.000Z" - }, - user_identity_id: '22222222-2222-2222-2222-222222222222', - user_identity_full_name: 'Jane Doe', - user_identity_email_address: 'jane@example.com', - user_identity_phone_number: '+15555550100' - }, - ... -] -``` -{% endtab %} - -{% tab title="Ruby" %} -``` -# Coming soon! -``` -{% endtab %} - -{% tab title="PHP" %} -```json -[ - { - "acs_user_id": "33333333-3333-3333-3333-333333333333", - "display_name": "Jane Doe", - "full_name": "Jane Doe", - "email": "jane@example.com", - "email_address": "jane@example.com", - "phone_number": "+15555550100", - "acs_system_id": "11111111-1111-1111-1111-111111111111", - "workspace_id": "00000000-0000-0000-0000-000000000000", - "created_at": "2024-04-05T07:14:28.531Z", - "is_suspended": false, - "access_schedule": { - "starts_at": "2024-03-01T10:40:00.000Z", - "ends_at": "2024-03-04T10:40:00.000Z" - }, - "user_identity_id": "22222222-2222-2222-2222-222222222222", - "user_identity_full_name": "Jane Doe", - "user_identity_email_address": "jane@example.com", - "user_identity_phone_number": "+15555550100" - }, - ... -] -``` -{% endtab %} - -{% tab title="C#" %} -```json -{ - "acs_user_id": "33333333-3333-3333-3333-333333333333", - "display_name": "Jane Doe", - "full_name": "Jane Doe", - "email": "jane@example.com", - "email_address": "jane@example.com", - "phone_number": "+15555550100", - "acs_system_id": "11111111-1111-1111-1111-111111111111", - "workspace_id": "00000000-0000-0000-0000-000000000000", - "created_at": "2024-04-05T07:14:28.531Z", - "is_suspended": false, - "access_schedule": { - "starts_at": "2024-03-01T10:40:00.000Z", - "ends_at": "2024-03-04T10:40:00.000Z" - }, - "user_identity_id": "22222222-2222-2222-2222-222222222222", - "user_identity_full_name": "Jane Doe", - "user_identity_email_address": "jane@example.com", - "user_identity_phone_number": "+15555550100" -} -... -``` -{% endtab %} - -{% tab title="Java" %} -```json -// Coming soon! -``` -{% endtab %} - -{% tab title="Go" %} -```json -{ - "acs_users": [ - { - "acs_user_id": "33333333-3333-3333-3333-333333333333", - "display_name": "Jane Doe", - "full_name": "Jane Doe", - "email": "jane@example.com", - "email_address": "jane@example.com", - "phone_number": "+15555550100", - "acs_system_id": "11111111-1111-1111-1111-111111111111", - "workspace_id": "00000000-0000-0000-0000-000000000000", - "created_at": "2024-04-05T07:14:28.531Z", - "is_suspended": false, - "access_schedule": { - "starts_at": "2024-03-01T10:40:00.000Z", - "ends_at": "2024-03-04T10:40:00.000Z" - }, - "user_identity_id": "22222222-2222-2222-2222-222222222222", - "user_identity_full_name": "Jane Doe", - "user_identity_email_address": "jane@example.com", - "user_identity_phone_number": "+15555550100" - }, - ... - ], - "ok": true -} -``` -{% endtab %} -{% endtabs %} diff --git a/docs/api-clients/acs/users/remove_from_access_group.md b/docs/api-clients/acs/users/remove_from_access_group.md deleted file mode 100644 index cd7d465a..00000000 --- a/docs/api-clients/acs/users/remove_from_access_group.md +++ /dev/null @@ -1,156 +0,0 @@ ---- -description: Remove a specified ACS user from a specified access group ---- - -# Remove a User from an Access Group - -Removes a specified [ACS user](../../../products/access-systems/user-management.md) from a specified [access group](../../../products/access-systems/assigning-users-to-access-groups.md). - -{% swagger src="https://connect.getseam.com/openapi.json" path="/acs/users/remove_from_access_group" method="post" %} -[https://connect.getseam.com/openapi.json](https://connect.getseam.com/openapi.json) -{% endswagger %} - -## Request - -Specify the desired ACS user and access group by including the corresponding `acs_user_id` and `acs_access_group_id` in the request body. - -### Request Body Parameters - -
ParameterTypeDescription
acs_user_idString (UUID)
Required		ID of the desired ACS user
acs_access_group_idString (UUID)
Required		ID of the desired access group
- -### Sample Request - -{% tabs %} -{% tab title="Python" %} -```python -seam.acs.users.remove_from_access_group( - acs_user_id="33333333-3333-3333-3333-333333333333", - acs_access_group_id="44444444-4444-4444-4444-444444444444" -) -``` -{% endtab %} - -{% tab title="cURL (bash)" %} -```bash -curl -X 'POST' \ - 'https://connect.getseam.com/acs/users/remove_from_access_group' \ - -H 'accept: */*' \ - -H "Authorization: Bearer ${API_KEY}" \ - -H 'Content-Type: application/json' \ - -d '{ - "acs_user_id": "33333333-3333-3333-3333-333333333333", - "acs_access_group_id": "44444444-4444-4444-4444-444444444444" -}' -``` -{% endtab %} - -{% tab title="JavaScript" %} -```javascript -await seam.acs.users.removeFromAccessGroup({ - acs_user_id: "33333333-3333-3333-3333-333333333333", - acs_access_group_id: "44444444-4444-4444-4444-444444444444" -}); -``` -{% endtab %} - -{% tab title="Ruby" %} -```ruby -# Coming soon! -``` -{% endtab %} - -{% tab title="PHP" %} -```php -$seam->acs->users->remove_from_access_group( - acs_user_id: "33333333-3333-3333-3333-333333333333", - acs_access_group_id: "44444444-4444-4444-4444-444444444444" -); -``` -{% endtab %} - -{% tab title="C#" %} -```csharp -seam.UsersAcs.RemoveFromAccessGroup( - acsUserId: "33333333-3333-3333-3333-333333333333", - acsAccessGroupId: "44444444-4444-4444-4444-444444444444" -); -``` -{% endtab %} - -{% tab title="Java" %} -```java -// Coming soon! -``` -{% endtab %} - -{% tab title="Go" %} -```go -remove, uErr := client.Acs.Users.RemoveFromAccessGroup( - context.Background(), &acs.UsersRemoveFromAccessGroupRequest{ - AcsUserId: "33333333-3333-3333-3333-333333333333", - AcsAccessGroupId: "44444444-4444-4444-4444-444444444444", - }, -) -``` -{% endtab %} -{% endtabs %} - -## Response - -Returns a Boolean `ok` status indicator or void. - -### Sample Response - -{% tabs %} -{% tab title="Python" %} -``` -None -``` -{% endtab %} - -{% tab title="cURL (bash)" %} -```json -{ - "ok": true -} -``` -{% endtab %} - -{% tab title="JavaScript" %} -```json -void -``` -{% endtab %} - -{% tab title="Ruby" %} -``` -# Coming soon! -``` -{% endtab %} - -{% tab title="PHP" %} -``` -void -``` -{% endtab %} - -{% tab title="C#" %} -``` -void -``` -{% endtab %} - -{% tab title="Java" %} -```json -// Coming soon! -``` -{% endtab %} - -{% tab title="Go" %} -```json -{ - "ok": true -} -``` -{% endtab %} -{% endtabs %} diff --git a/docs/api-clients/acs/users/suspend.md b/docs/api-clients/acs/users/suspend.md deleted file mode 100644 index 16f742ef..00000000 --- a/docs/api-clients/acs/users/suspend.md +++ /dev/null @@ -1,150 +0,0 @@ ---- -description: Suspend a specified ACS user ---- - -# Suspend a User - -[Suspends](../../../products/access-systems/suspending-and-unsuspending-users.md#suspend-an-acs-user) a specified [ACS user](../../../products/access-systems/user-management.md). Suspending an ACS user revokes their access temporarily. To restore an ACS user's access, you can [unsuspend](unsuspend.md) them. - -{% swagger src="https://connect.getseam.com/openapi.json" path="/acs/users/suspend" method="post" %} -[https://connect.getseam.com/openapi.json](https://connect.getseam.com/openapi.json) -{% endswagger %} - -## Request - -Specify the desired ACS user by including the corresponding `acs_user_id` in the request body. - -### Request Body Parameters - -
ParameterTypeDescription
acs_user_idString (UUID)
Required		ID of the desired ACS user
- -### Sample Request - -{% tabs %} -{% tab title="Python" %} -```python -seam.acs.users.suspend( - acs_user_id="33333333-3333-3333-3333-333333333333" -) -``` -{% endtab %} - -{% tab title="cURL (bash)" %} -```bash -curl -X 'POST' \ - 'https://connect.getseam.com/acs/users/suspend' \ - -H 'accept: application/json' \ - -H "Authorization: Bearer ${API_KEY}" \ - -H 'Content-Type: application/json' \ - -d '{ - "acs_user_id": "33333333-3333-3333-3333-333333333333" -}' -``` -{% endtab %} - -{% tab title="JavaScript" %} -```javascript -await seam.acs.users.suspend({ - acs_user_id: "33333333-3333-3333-3333-333333333333" -}); -``` -{% endtab %} - -{% tab title="Ruby" %} -```ruby -# Coming soon! -``` -{% endtab %} - -{% tab title="PHP" %} -```php -$seam->acs->users->suspend( - acs_user_id: "33333333-3333-3333-3333-333333333333" -); -``` -{% endtab %} - -{% tab title="C#" %} -```csharp -seam.UsersAcs.Suspend( - acsUserId: "33333333-3333-3333-3333-333333333333", -); -``` -{% endtab %} - -{% tab title="Java" %} -```java -// Coming soon! -``` -{% endtab %} - -{% tab title="Go" %} -```go -suspend, uErr := client.Acs.Users.Suspend( - context.Background(), &acs.UsersSuspendRequest{ - AcsUserId: "33333333-3333-3333-3333-333333333333", - }, -); -``` -{% endtab %} -{% endtabs %} - -## Response - -Returns a Boolean `ok` status indicator or void. - -### Sample Response - -{% tabs %} -{% tab title="Python" %} -``` -None -``` -{% endtab %} - -{% tab title="cURL (bash)" %} -```json -{ - "ok": true -} -``` -{% endtab %} - -{% tab title="JavaScript" %} -```json -void -``` -{% endtab %} - -{% tab title="Ruby" %} -``` -# Coming soon! -``` -{% endtab %} - -{% tab title="PHP" %} -``` -void -``` -{% endtab %} - -{% tab title="C#" %} -``` -void -``` -{% endtab %} - -{% tab title="Java" %} -```json -// Coming soon! -``` -{% endtab %} - -{% tab title="Go" %} -```json -{ - "ok": true -} -``` -{% endtab %} -{% endtabs %} diff --git a/docs/api-clients/acs/users/unsuspend.md b/docs/api-clients/acs/users/unsuspend.md deleted file mode 100644 index 21f1bfb0..00000000 --- a/docs/api-clients/acs/users/unsuspend.md +++ /dev/null @@ -1,150 +0,0 @@ ---- -description: Unsuspend a specified ACS user ---- - -# Unsuspend a User - -[Unsuspends](../../../products/access-systems/suspending-and-unsuspending-users.md#unsuspend-an-acs-user) a specified suspended [ACS user](../../../products/access-systems/user-management.md). While [suspending an ACS user](suspend.md) revokes their access temporarily, unsuspending the ACS user restores their access. - -{% swagger src="https://connect.getseam.com/openapi.json" path="/acs/users/unsuspend" method="post" %} -[https://connect.getseam.com/openapi.json](https://connect.getseam.com/openapi.json) -{% endswagger %} - -## Request - -Specify the desired ACS user by including the corresponding `acs_user_id` in the request body. - -### Request Body Parameters - -
ParameterTypeDescription
acs_user_idString (UUID)
Required		ID of the desired ACS user
- -### Sample Request - -{% tabs %} -{% tab title="Python" %} -```python -seam.acs.users.unsuspend( - acs_user_id="33333333-3333-3333-3333-333333333333" -) -``` -{% endtab %} - -{% tab title="cURL (bash)" %} -```bash -curl -X 'POST' \ - 'https://connect.getseam.com/acs/users/unsuspend' \ - -H 'accept: application/json' \ - -H "Authorization: Bearer ${API_KEY}" \ - -H 'Content-Type: application/json' \ - -d '{ - "acs_user_id": "33333333-3333-3333-3333-333333333333" -}' -``` -{% endtab %} - -{% tab title="JavaScript" %} -```javascript -await seam.acs.users.unsuspend({ - acs_user_id: "33333333-3333-3333-3333-333333333333" -}); -``` -{% endtab %} - -{% tab title="Ruby" %} -```ruby -# Coming soon! -``` -{% endtab %} - -{% tab title="PHP" %} -```php -$seam->acs->users->unsuspend( - acs_user_id: "33333333-3333-3333-3333-333333333333" -); -``` -{% endtab %} - -{% tab title="C#" %} -```csharp -seam.UsersAcs.Unsuspend( - acsUserId: "33333333-3333-3333-3333-333333333333" -); -``` -{% endtab %} - -{% tab title="Java" %} -```java -// Coming soon! -``` -{% endtab %} - -{% tab title="Go" %} -```go -unsuspend, uErr := client.Acs.Users.Unsuspend( - context.Background(), &acs.UsersUnsuspendRequest{ - AcsUserId: "33333333-3333-3333-3333-333333333333", - }, -); -``` -{% endtab %} -{% endtabs %} - -## Response - -Returns a Boolean `ok` status indicator or void. - -### Sample Response - -{% tabs %} -{% tab title="Python" %} -``` -None -``` -{% endtab %} - -{% tab title="cURL (bash)" %} -```json -{ - "ok": true -} -``` -{% endtab %} - -{% tab title="JavaScript" %} -```json -void -``` -{% endtab %} - -{% tab title="Ruby" %} -``` -# Coming soon! -``` -{% endtab %} - -{% tab title="PHP" %} -``` -void -``` -{% endtab %} - -{% tab title="C#" %} -``` -void -``` -{% endtab %} - -{% tab title="Java" %} -```json -// Coming soon! -``` -{% endtab %} - -{% tab title="Go" %} -```json -{ - "ok": true -} -``` -{% endtab %} -{% endtabs %} diff --git a/docs/api-clients/acs/users/update.md b/docs/api-clients/acs/users/update.md deleted file mode 100644 index 1adf9b4e..00000000 --- a/docs/api-clients/acs/users/update.md +++ /dev/null @@ -1,202 +0,0 @@ ---- -description: Update the properties of a specified ACS user ---- - -# Update a User - -Updates any of the following properties of a specified [ACS user](../../../products/access-systems/user-management.md): - -* `full_name` -* `email_address` -* `phone_number` -* `access_schedule` - -{% swagger src="https://connect.getseam.com/openapi.json" path="/acs/users/update" method="post" %} -[https://connect.getseam.com/openapi.json](https://connect.getseam.com/openapi.json) -{% endswagger %} - -## Request - -Specify the desired ACS user by including the corresponding `acs_user_id` in the request body. In addition, in the request body, include the properties that you want to update, along with the desired replacement values. - -### Request Body Parameters - -
ParameterTypeDescription
acs_user_idString (UUID)
Required		ID of the desired ACS user.
full_nameString
Optional		Replacement full name for the ACS user.
email_addressString
Optional		Replacement email address for the ACS user.
phone_numberString
Optional		Replacement phone number for the ACS user in E.164 format (for example, +15555550100).
access_scheduleObject
Optional		Replacement starts_at and ends_at dates/times for the ACS user's access.
If you specify an access_schedule, you must include both starts_at and ends_at. ends_at must be a time in the future and after starts_at.
Only applicable to Salto KS access control systems.
- -### Sample Request - -{% tabs %} -{% tab title="Python" %} -```python -seam.acs.users.update( - acs_user_id="33333333-3333-3333-3333-333333333333", - full_name="Jack Doe", - email_address="jack@example.com", - phone_number="+15555550101", - access_schedule={ - "starts_at": "2024-04-01T10:40:00Z", - "ends_at": "2024-04-04T10:40:00Z" - } -) -``` -{% endtab %} - -{% tab title="cURL (bash)" %} -```bash -curl -X 'POST' \ - "https://connect.getseam.com/acs/users/update" \ - -H 'accept: application/json' \ - -H "Authorization: Bearer ${API_KEY}" \ - -H 'Content-Type: application/json' \ - -d '{ - "acs_user_id": "33333333-3333-3333-3333-333333333333", - "full_name": "Jack Doe", - "email_address": "jack@example.com", - "phone_number": "+15555550101", - "access_schedule": { - "starts_at": "2024-04-01T10:40:00Z", - "ends_at": "2024-04-04T10:40:00Z" - } -}' -``` -{% endtab %} - -{% tab title="JavaScript" %} -```javascript -await seam.acs.users.update({ - acs_user_id: "33333333-3333-3333-3333-333333333333", - full_name: "Jack Doe", - email_address: "jack@example.com", - phone_number: "+15555550101", - access_schedule: { - "starts_at": "2024-04-01T10:40:00Z", - "ends_at": "2024-04-04T10:40:00Z" - } -}); -``` -{% endtab %} - -{% tab title="Ruby" %} -```ruby -# Coming soon! -``` -{% endtab %} - -{% tab title="PHP" %} -```php -$seam->acs->users->update( - acs_user_id: "33333333-3333-3333-3333-333333333333", - full_name: "Jack Doe", - email_address: "jack@example.com", - phone_number: "+15555550101", - access_schedule: array( - "starts_at" => "2024-04-01T10:40:00Z", - "ends_at" => "2024-04-04T10:40:00Z" - ) -); -``` -{% endtab %} - -{% tab title="C#" %} -```csharp -seam.UsersAcs.Update( - acsUserId: "33333333-3333-3333-3333-333333333333", - fullName: "Jack Doe", - emailAddress: "jack@example.com", - phoneNumber: "+15555550101", - accessSchedule: new Dictionary() - { - {"starts_at", "2024-04-01T10:40:00Z"}, - {"ends_at", "2024-04-04T10:40:00Z"} - } -); -``` -{% endtab %} - -{% tab title="Java" %} -```java -// Coming soon! -``` -{% endtab %} - -{% tab title="Go" %} -```go -startsAt, err := time.Parse(time.RFC3339, "2024-04-01T10:40:00Z") -endsAt, err := time.Parse(time.RFC3339, "2024-04-04T10:40:00Z") -if err != nil { - return err -} - -acs_user, uErr := client.Acs.Users.Update( - context.Background(), &acs.UsersUpdateRequest{ - AcsUserId: "33333333-3333-3333-3333-333333333333", - FullName: api.String("Jack Doe"), - EmailAddress: api.String("jack@example.com"), - PhoneNumber: api.String("+15555550101"), - AccessSchedule: &acs.UsersCreateRequestAccessSchedule{ - StartsAt: startsAt, - EndsAt: endsAt, - }, - }, -) -``` -{% endtab %} -{% endtabs %} - -## Response - -Returns a Boolean `ok` status indicator or void. - -### Sample Response - -{% tabs %} -{% tab title="Python" %} -``` -None -``` -{% endtab %} - -{% tab title="cURL (bash)" %} -```json -{ - "ok": true -} -``` -{% endtab %} - -{% tab title="JavaScript" %} -```json -void -``` -{% endtab %} - -{% tab title="Ruby" %} -``` -# Coming soon! -``` -{% endtab %} - -{% tab title="PHP" %} -``` -void -``` -{% endtab %} - -{% tab title="C#" %} -``` -void -``` -{% endtab %} - -{% tab title="Java" %} -```json -// Coming soon! -``` -{% endtab %} - -{% tab title="Go" %} -``` -void -``` -{% endtab %} -{% endtabs %}