diff --git a/docs/api/acs/systems/README.md b/docs/api/acs/systems/README.md index 634b3b50..41e0eecf 100644 --- a/docs/api/acs/systems/README.md +++ b/docs/api/acs/systems/README.md @@ -1,10 +1,12 @@ -# `acs_system` +# Seam Connect + +## `acs_system` Represents an [access control system](https://docs.seam.co/latest/capability-guides/access-systems). -## Properties +### Properties -### `acs_system_id` +#### `acs_system_id` Format: `ID` @@ -13,7 +15,7 @@ ID of the `acs_system`. --- -### `can_add_acs_users_to_acs_access_groups` +#### `can_add_acs_users_to_acs_access_groups` Format: `Boolean` @@ -22,7 +24,7 @@ Indicates whether the `acs_system` supports [adding users to access groups](http --- -### `can_automate_enrollment` +#### `can_automate_enrollment` Format: `Boolean` @@ -31,7 +33,7 @@ Indicates whether it is possible to [launch enrollment automations](https://docs --- -### `can_create_acs_access_groups` +#### `can_create_acs_access_groups` Format: `Boolean` @@ -40,7 +42,7 @@ Indicates whether the `acs_system` supports creating [access groups](https://doc --- -### `can_remove_acs_users_from_acs_access_groups` +#### `can_remove_acs_users_from_acs_access_groups` Format: `Boolean` @@ -49,7 +51,7 @@ Indicates whether the `acs_system` supports [removing users from access groups]( --- -### `connected_account_ids` +#### `connected_account_ids` Format: `List` @@ -58,7 +60,7 @@ IDs of the [connected accounts](../../../core-concepts/connected-accounts/README --- -### `created_at` +#### `created_at` Format: `Datetime` @@ -67,7 +69,7 @@ Date and time at which the `acs_system` was created. --- -### `default_credential_manager_acs_system_id` +#### `default_credential_manager_acs_system_id` Format: `ID` @@ -76,7 +78,7 @@ ID of the default credential manager acs_system for this access control system. --- -### `errors` +#### `errors` Format: `List` @@ -85,7 +87,7 @@ Errors associated with the `acs_system`. --- -### `external_type` +#### `external_type` Format: `Enum` @@ -105,7 +107,7 @@ Possible enum values: --- -### `external_type_display_name` +#### `external_type_display_name` Format: `String` @@ -114,7 +116,7 @@ Display name that corresponds to the brand-specific terminology for the `acs_sys --- -### `image_alt_text` +#### `image_alt_text` Format: `String` @@ -123,7 +125,7 @@ Alternative text for the `acs_system` image. --- -### `image_url` +#### `image_url` Format: `String` @@ -132,7 +134,7 @@ URL for the image that represents the `acs_system`. --- -### `is_credential_manager` +#### `is_credential_manager` Format: `Boolean` @@ -141,7 +143,7 @@ Indicates if the `acs_system` is a credential manager. --- -### `name` +#### `name` Format: `String` @@ -150,7 +152,7 @@ Name of the `acs_system`. --- -### `system_type` +#### `system_type` {% hint style="warning" %} **Deprecated**. Use `external_type`. @@ -172,7 +174,7 @@ Possible enum values: --- -### `system_type_display_name` +#### `system_type_display_name` {% hint style="warning" %} **Deprecated**. Use `external_type_display_name`. @@ -183,7 +185,7 @@ Format: `String` --- -### `visionline_metadata` +#### `visionline_metadata` Format: `Object` @@ -202,7 +204,7 @@ Unique ID assigned by the ASSA ABLOY licensing team that identifies each hotel i --- -### `warnings` +#### `warnings` Format: `List` @@ -211,7 +213,7 @@ Warnings associated with the `acs_system`. --- -### `workspace_id` +#### `workspace_id` Format: `ID` @@ -220,15 +222,15 @@ ID of the [workspace](../../../core-concepts/workspaces/README.md) that contains --- -# Endpoints +## Endpoints -## [`/acs/systems/get`](./get.md) +### [`/acs/systems/get`](./get.md) Returns a specified [access control system](https://docs.seam.co/latest/capability-guides/access-systems). -## [`/acs/systems/list`](./list.md) +### [`/acs/systems/list`](./list.md) Returns a list of all [access control systems](https://docs.seam.co/latest/capability-guides/access-systems). -## [`/acs/systems/list_compatible_credential_manager_acs_systems`](./list_compatible_credential_manager_acs_systems.md) +### [`/acs/systems/list_compatible_credential_manager_acs_systems`](./list_compatible_credential_manager_acs_systems.md) Returns a list of all credential manager ACS systems that are compatible with a specified [access control system](https://docs.seam.co/latest/capability-guides/access-systems).