diff --git a/docs/api/_report.md b/docs/api/_report.md index 1890e3cc..a5a4cab0 100644 --- a/docs/api/_report.md +++ b/docs/api/_report.md @@ -7,6 +7,8 @@ - `/access_codes` - `/access_codes/simulate` - `/access_codes/unmanaged` +- `/acs/encoders` +- `/acs/encoders/simulate` - `/action_attempts` - `/client_sessions` - `/connect_webviews` @@ -106,8 +108,6 @@ These items are intentionally undocumented. - `/acs/credential_pools`: No undocumented message provided - `/acs/credential_provisioning_automations`: No undocumented message provided - `/acs/credentials/unmanaged`: No undocumented message provided -- `/acs/encoders`: No undocumented message provided -- `/acs/encoders/simulate`: No undocumented message provided - `/acs/users/unmanaged`: No undocumented message provided ### Resource properties @@ -125,13 +125,6 @@ These items are intentionally undocumented. - `/acs/credentials/create_offline_code`: Unreleased. - `/acs/credentials/unmanaged/get`: No unmanaged credentials are currently implemented. - `/acs/credentials/unmanaged/list`: No unmanaged credentials are currently implemented. -- `/acs/encoders/encode_credential`: Encoders are in alpha. -- `/acs/encoders/list`: Encoders are in alpha. -- `/acs/encoders/scan_credential`: Encoders are in alpha. -- `/acs/encoders/simulate/next_credential_encode_will_fail`: Encoder simulations are in alpha. -- `/acs/encoders/simulate/next_credential_encode_will_succeed`: Encoder simulations are in alpha. -- `/acs/encoders/simulate/next_credential_scan_will_fail`: Encoder simulations are in alpha. -- `/acs/encoders/simulate/next_credential_scan_will_succeed`: Encoder simulations are in alpha. - `/acs/users/unmanaged/get`: No unmanaged users are currently implemented. - `/acs/users/unmanaged/list`: No unmanaged users are currently implemented. - `/devices/delete`: Deleting a device is no longer supported and will be removed. @@ -341,13 +334,6 @@ Items that are intentionally undocumented are not included in this section. - `/access_codes/unmanaged/update` - `/acs/credential_pools/list` - `/acs/credential_provisioning_automations/launch` -- `/acs/encoders/encode_credential` -- `/acs/encoders/list` -- `/acs/encoders/scan_credential` -- `/acs/encoders/simulate/next_credential_encode_will_fail` -- `/acs/encoders/simulate/next_credential_encode_will_succeed` -- `/acs/encoders/simulate/next_credential_scan_will_fail` -- `/acs/encoders/simulate/next_credential_scan_will_succeed` - `/acs/entrances/grant_access` - `/acs/users/unmanaged/get` - `/acs/users/unmanaged/list` @@ -519,9 +505,6 @@ Items that are intentionally undocumented are not included in this section. - `credential_manager_acs_system_id` - `credential_manager_acs_user_id` - `user_identity_id` -- `/acs/encoders/simulate/next_credential_encode_will_succeed` - - `acs_encoder_id` - - `scenario` - `/acs/entrances/get` - `acs_entrance_id` - `/acs/entrances/grant_access` diff --git a/docs/api/acs/access_groups/README.md b/docs/api/acs/access_groups/README.md index c89a930a..e7ef7bb0 100644 --- a/docs/api/acs/access_groups/README.md +++ b/docs/api/acs/access_groups/README.md @@ -149,3 +149,72 @@ Returns a list of all [ACS users](https://docs.seam.co/latest/capability-guides/ ### [`/acs/access_groups/remove_user`](./remove_user.md) Removes a specified [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) from a specified [access group](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups). + +## Events + +### `acs_access_group.deleted` + +An ACS access group was deleted. + +
+ +acs_access_group_id Format: ID + +
+ +
+ +acs_system_id Format: ID + +ID of the [ACS system](https://docs.seam.co/latest/capability-guides/access-systems). + +
+ +
+ +connected_account_id Format: ID + +ID of the [connected account](../../../core-concepts/connected-accounts/README.md). + +
+ +
+ +created_at Format: Datetime + +Date and time at which the event was created. + +
+ +
+ +event_id Format: ID + +ID of the event. + +
+ +
+ +event_type Format: String + +
+ +
+ +occurred_at Format: Datetime + +Date and time at which the event occurred. + +
+ +
+ +workspace_id Format: ID + +ID of the [workspace](../../../core-concepts/workspaces/README.md). + +
+ +--- + diff --git a/docs/api/acs/credentials/README.md b/docs/api/acs/credentials/README.md index f384bda3..aaf8a958 100644 --- a/docs/api/acs/credentials/README.md +++ b/docs/api/acs/credentials/README.md @@ -319,7 +319,7 @@ Updates the code and ends at date and time for a specified [credential](../../.. ### `acs_credential.deleted` -An ACS credential was deleted. +An [ACS credential](../../../capability-guides/access-systems/managing-credentials.md) was deleted.
@@ -331,7 +331,7 @@ An ACS credential was deleted. acs_system_id Format: ID -ID of the ACS system. +ID of the [ACS system](https://docs.seam.co/latest/capability-guides/access-systems).
@@ -339,7 +339,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). @@ -347,7 +347,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. @@ -369,7 +369,7 @@ ID of the event. occurred_at Format: Datetime -Time when the event occurred. +Date and time at which the event occurred. @@ -385,7 +385,7 @@ ID of the [workspace](../../../core-concepts/workspaces/README.md). ### `acs_credential.issued` -An ACS credential was issued. +An [ACS credential](../../../capability-guides/access-systems/managing-credentials.md) was issued.
@@ -397,7 +397,7 @@ An ACS credential was issued. acs_system_id Format: ID -ID of the ACS system. +ID of the [ACS system](https://docs.seam.co/latest/capability-guides/access-systems).
@@ -405,7 +405,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). @@ -413,7 +413,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. @@ -435,7 +435,7 @@ ID of the event. occurred_at Format: Datetime -Time when the event occurred. +Date and time at which the event occurred. diff --git a/docs/api/acs/systems/README.md b/docs/api/acs/systems/README.md index 03d2a549..a8e83651 100644 --- a/docs/api/acs/systems/README.md +++ b/docs/api/acs/systems/README.md @@ -285,13 +285,13 @@ Returns a list of all credential manager ACS systems that are compatible with a ### `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).
@@ -299,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). @@ -307,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. @@ -329,7 +329,7 @@ ID of the event. occurred_at Format: Datetime -Time when the event occurred. +Date and time at which the event occurred. @@ -345,13 +345,13 @@ 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).
@@ -359,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). @@ -367,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. @@ -389,7 +389,7 @@ ID of the event. occurred_at Format: Datetime -Time when the event occurred. +Date and time at which the event occurred. @@ -405,13 +405,13 @@ 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).
@@ -419,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). @@ -427,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. @@ -449,7 +449,7 @@ ID of the event. occurred_at Format: Datetime -Time when the event occurred. +Date and time at which the event occurred. diff --git a/docs/api/acs/users/README.md b/docs/api/acs/users/README.md index a3e6193a..81c99800 100644 --- a/docs/api/acs/users/README.md +++ b/docs/api/acs/users/README.md @@ -255,13 +255,13 @@ Updates the properties of a specified [ACS user](https://docs.seam.co/latest/cap ### `acs_user.deleted` -An ACS user was deleted. +An [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) was deleted.
acs_system_id Format: ID -ID of the ACS system. +ID of the [ACS system](https://docs.seam.co/latest/capability-guides/access-systems).
@@ -275,7 +275,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). @@ -283,7 +283,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. @@ -305,7 +305,7 @@ ID of the event. occurred_at Format: Datetime -Time when the event occurred. +Date and time at which the event occurred. diff --git a/docs/api/user_identities/enrollment_automations/README.md b/docs/api/user_identities/enrollment_automations/README.md index adcd733a..3b7d6f88 100644 --- a/docs/api/user_identities/enrollment_automations/README.md +++ b/docs/api/user_identities/enrollment_automations/README.md @@ -68,13 +68,13 @@ Returns a list of all [enrollment automations](https://docs.seam.co/latest/capab ### `enrollment_automation.deleted` -An enrollment automation was deleted. +An [enrollment automation](../../../capability-guides/mobile-access/issuing-mobile-credentials-from-an-access-control-system.md#prepare-the-phones-for-a-user-identity-to-start-receiving-mobile-credentials-using-an-enrollment-aut) was deleted.
created_at Format: Datetime -Time at which the event was created. +Date and time at which the event was created.
@@ -82,7 +82,7 @@ Time at which the event was created. enrollment_automation_id Format: ID -ID of the enrollment automation. +ID of the [enrollment automation](../../../capability-guides/mobile-access/issuing-mobile-credentials-from-an-access-control-system.md#prepare-the-phones-for-a-user-identity-to-start-receiving-mobile-credentials-using-an-enrollment-aut). @@ -104,7 +104,7 @@ ID of the event. occurred_at Format: Datetime -Time when the event occurred. +Date and time at which the event occurred.