diff --git a/docs/api/acs/systems/README.md b/docs/api/acs/systems/README.md index ba00b0a0..a8e83651 100644 --- a/docs/api/acs/systems/README.md +++ b/docs/api/acs/systems/README.md @@ -10,7 +10,8 @@ Format: `ID` ID of the `acs_system`. -*** + +--- ### `can_add_acs_users_to_acs_access_groups` @@ -18,7 +19,8 @@ Format: `Boolean` Indicates whether the `acs_system` supports [adding users to access groups](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups#add-an-acs-user-to-an-access-group). See also [Access Group-based Access Control Systems](../../../capability-guides/access-systems/understanding-access-control-system-differences.md#access-group-based-access-control-systems). -*** + +--- ### `can_automate_enrollment` @@ -26,7 +28,8 @@ Format: `Boolean` Indicates whether it is possible to [launch enrollment automations](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/issuing-mobile-credentials-from-an-access-control-system#prepare-the-phones-for-a-user-identity-to-start-receiving-mobile-credentials-using-an-enrollment-aut) for the `acs_system`. -*** + +--- ### `can_create_acs_access_groups` @@ -34,7 +37,8 @@ Format: `Boolean` Indicates whether the `acs_system` supports creating [access groups](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups). See also [Access Group-based Access Control Systems](../../../capability-guides/access-systems/understanding-access-control-system-differences.md#access-group-based-access-control-systems). -*** + +--- ### `can_remove_acs_users_from_acs_access_groups` @@ -42,15 +46,17 @@ Format: `Boolean` Indicates whether the `acs_system` supports [removing users from access groups](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups#remove-an-acs-user-from-an-access-group). See also [Access Group-based Access Control Systems](../../../capability-guides/access-systems/understanding-access-control-system-differences.md#access-group-based-access-control-systems). -*** + +--- ### `connected_account_id` Format: `ID` -ID of the [connected account](../../../core-concepts/connected-accounts/) associated with the `acs_system`. +ID of the [connected account](../../../core-concepts/connected-accounts/README.md) associated with the `acs_system`. + -*** +--- ### `connected_account_ids` @@ -60,9 +66,10 @@ ID of the [connected account](../../../core-concepts/connected-accounts/) associ Format: `List` -IDs of the [connected accounts](../../../core-concepts/connected-accounts/) associated with the `acs_system`. +IDs of the [connected accounts](../../../core-concepts/connected-accounts/README.md) associated with the `acs_system`. -*** + +--- ### `created_at` @@ -70,15 +77,17 @@ Format: `Datetime` Date and time at which the `acs_system` was created. -*** + +--- ### `default_credential_manager_acs_system_id` Format: `ID` -ID of the default credential manager acs\_system for this access control system. +ID of the default credential manager acs_system for this access control system. -*** + +--- ### `errors` @@ -86,7 +95,8 @@ Format: `List` Errors associated with the `acs_system`. -*** + +--- ### `external_type` @@ -95,22 +105,22 @@ Format: `Enum` Brand-specific terminology for the `acs_system` type. Possible enum values: - -* `pti_site` -* `alta_org` -* `salto_ks_site` -* `salto_space_system` -* `brivo_account` -* `hid_credential_manager_organization` -* `visionline_system` -* `assa_abloy_credential_service` -* `latch_building` -* `dormakaba_community_site` -* `legic_connect_credential_service` -* `assa_abloy_vostio` -* `assa_abloy_vostio_credential_service` - -*** +- `pti_site` +- `alta_org` +- `salto_ks_site` +- `salto_space_system` +- `brivo_account` +- `hid_credential_manager_organization` +- `visionline_system` +- `assa_abloy_credential_service` +- `latch_building` +- `dormakaba_community_site` +- `legic_connect_credential_service` +- `assa_abloy_vostio` +- `assa_abloy_vostio_credential_service` + + +--- ### `external_type_display_name` @@ -118,7 +128,8 @@ Format: `String` Display name that corresponds to the brand-specific terminology for the `acs_system` type. -*** + +--- ### `image_alt_text` @@ -126,7 +137,8 @@ Format: `String` Alternative text for the `acs_system` image. -*** + +--- ### `image_url` @@ -134,7 +146,8 @@ Format: `String` URL for the image that represents the `acs_system`. -*** + +--- ### `is_credential_manager` @@ -142,7 +155,8 @@ Format: `Boolean` Indicates if the `acs_system` is a credential manager. -*** + +--- ### `location` @@ -156,7 +170,8 @@ Time zone in which the `acs_system` is located. -*** + +--- ### `name` @@ -164,7 +179,8 @@ Format: `String` Name of the `acs_system`. -*** + +--- ### `system_type` @@ -175,22 +191,22 @@ Name of the `acs_system`. Format: `Enum` Possible enum values: - -* `pti_site` -* `alta_org` -* `salto_ks_site` -* `salto_space_system` -* `brivo_account` -* `hid_credential_manager_organization` -* `visionline_system` -* `assa_abloy_credential_service` -* `latch_building` -* `dormakaba_community_site` -* `legic_connect_credential_service` -* `assa_abloy_vostio` -* `assa_abloy_vostio_credential_service` - -*** +- `pti_site` +- `alta_org` +- `salto_ks_site` +- `salto_space_system` +- `brivo_account` +- `hid_credential_manager_organization` +- `visionline_system` +- `assa_abloy_credential_service` +- `latch_building` +- `dormakaba_community_site` +- `legic_connect_credential_service` +- `assa_abloy_vostio` +- `assa_abloy_vostio_credential_service` + + +--- ### `system_type_display_name` @@ -200,7 +216,8 @@ Possible enum values: Format: `String` -*** + +--- ### `visionline_metadata` @@ -230,7 +247,8 @@ Unique ID assigned by the ASSA ABLOY licensing team that identifies each hotel i -*** + +--- ### `warnings` @@ -238,41 +256,42 @@ Format: `List` Warnings associated with the `acs_system`. -*** + +--- ### `workspace_id` Format: `ID` -ID of the [workspace](../../../core-concepts/workspaces/) that contains the `acs_system`. +ID of the [workspace](../../../core-concepts/workspaces/README.md) that contains the `acs_system`. + -*** +--- ## 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). +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). ## Events ### `acs_system.connected` -An ACS system was connected. +An [ACS system](https://docs.seam.co/latest/capability-guides/access-systems) was connected.
acs_system_id Format: ID -ID of the ACS system. +ID of the [ACS system](https://docs.seam.co/latest/capability-guides/access-systems).
@@ -280,7 +299,7 @@ ID of the ACS system. connected_account_id Format: ID -ID of the connected account. +ID of the [connected account](../../../core-concepts/connected-accounts/README.md). @@ -288,7 +307,7 @@ ID of the connected account. created_at Format: Datetime -Time at which the event was created. +Date and time at which the event was created. @@ -304,15 +323,13 @@ ID of the event. event_type Format: String - -
occurred_at Format: Datetime -Time when the event occurred. +Date and time at which the event occurred.
@@ -320,21 +337,21 @@ Time when the event occurred. workspace_id Format: ID -ID of the [workspace](../../../core-concepts/workspaces/). +ID of the [workspace](../../../core-concepts/workspaces/README.md). -*** +--- ### `acs_system.added` -An ACS system was added. +An [ACS system](https://docs.seam.co/latest/capability-guides/access-systems) was added.
acs_system_id Format: ID -ID of the ACS system. +ID of the [ACS system](https://docs.seam.co/latest/capability-guides/access-systems).
@@ -342,7 +359,7 @@ ID of the ACS system. connected_account_id Format: ID -ID of the connected account. +ID of the [connected account](../../../core-concepts/connected-accounts/README.md). @@ -350,7 +367,7 @@ ID of the connected account. created_at Format: Datetime -Time at which the event was created. +Date and time at which the event was created. @@ -366,15 +383,13 @@ ID of the event. event_type Format: String - -
occurred_at Format: Datetime -Time when the event occurred. +Date and time at which the event occurred.
@@ -382,21 +397,21 @@ Time when the event occurred. workspace_id Format: ID -ID of the [workspace](../../../core-concepts/workspaces/). +ID of the [workspace](../../../core-concepts/workspaces/README.md). -*** +--- ### `acs_system.disconnected` -An ACS system was disconnected. +An [ACS system](https://docs.seam.co/latest/capability-guides/access-systems) was disconnected.
acs_system_id Format: ID -ID of the ACS system. +ID of the [ACS system](https://docs.seam.co/latest/capability-guides/access-systems).
@@ -404,7 +419,7 @@ ID of the ACS system. connected_account_id Format: ID -ID of the connected account. +ID of the [connected account](../../../core-concepts/connected-accounts/README.md). @@ -412,7 +427,7 @@ ID of the connected account. created_at Format: Datetime -Time at which the event was created. +Date and time at which the event was created. @@ -428,15 +443,13 @@ ID of the event. event_type Format: String - -
occurred_at Format: Datetime -Time when the event occurred. +Date and time at which the event occurred.
@@ -444,8 +457,9 @@ Time when the event occurred. workspace_id Format: ID -ID of the [workspace](../../../core-concepts/workspaces/). +ID of the [workspace](../../../core-concepts/workspaces/README.md). -*** +--- + diff --git a/docs/api/user_identities/update-a-user-identity.md b/docs/api/user_identities/update.md similarity index 67% rename from docs/api/user_identities/update-a-user-identity.md rename to docs/api/user_identities/update.md index 28b3332d..a9b53b7d 100644 --- a/docs/api/user_identities/update-a-user-identity.md +++ b/docs/api/user_identities/update.md @@ -4,17 +4,20 @@ PATCH /user_identities/update ⇒ void ``` + + ## Authentication Methods -* API key -* Personal access token\ - Must also include the `seam-workspace` header in the request. +- API key +- Personal access token +
Must also include the `seam-workspace` header in the request. ## Request Parameters ### `email_address` -Type: `string` Required: No +Type: `string` +Required: No Unique email address for the user identity. @@ -22,13 +25,17 @@ Unique email address for the user identity. ### `full_name` -Type: `string` Required: No +Type: `string` +Required: No + + *** ### `phone_number` -Type: `string` Required: No +Type: `string` +Required: No Unique phone number for the user identity in [E.164 format](https://www.itu.int/rec/T-REC-E.164/en) (for example, +15555550100). @@ -36,7 +43,8 @@ Unique phone number for the user identity in [E.164 format](https://www.itu.int/ ### `user_identity_id` -Type: `string` Required: Yes +Type: `string` +Required: Yes ID of the user identity. @@ -44,7 +52,8 @@ ID of the user identity. ### `user_identity_key` -Type: `string` Required: No +Type: `string` +Required: No Unique key for the user identity.