From 5695ba413999b7836dda3464bc57de36b5afff2b Mon Sep 17 00:00:00 2001 From: Seam Bot Date: Mon, 19 Aug 2024 12:41:32 +0000 Subject: [PATCH] ci: Generate docs --- docs/api/acs/systems/get.md | 29 ++++++ docs/api/acs/systems/list.md | 91 +++++++++---------- ...mpatible_credential_manager_acs_systems.md | 29 ++++++ docs/sdk/javascript/acs/systems/get.md | 3 + ...mpatible_credential_manager_acs_systems.md | 3 + 5 files changed, 105 insertions(+), 50 deletions(-) create mode 100644 docs/api/acs/systems/get.md create mode 100644 docs/api/acs/systems/list_compatible_credential_manager_acs_systems.md create mode 100644 docs/sdk/javascript/acs/systems/get.md create mode 100644 docs/sdk/javascript/acs/systems/list_compatible_credential_manager_acs_systems.md diff --git a/docs/api/acs/systems/get.md b/docs/api/acs/systems/get.md new file mode 100644 index 00000000..228e7174 --- /dev/null +++ b/docs/api/acs/systems/get.md @@ -0,0 +1,29 @@ +# + +``` +POST /acs/systems/get ⇒ { ... } +``` + + + +*Return Type: void* + +{% tabs %} + {% tab title="No samples available" %} + ``` + No sample requests available. + ``` + {% endtab %} +{% endtabs %} + +## Request Parameters + +### `acs_system_id` + +*Type:* `` +*Required:* Yes + + + +--- + diff --git a/docs/api/acs/systems/list.md b/docs/api/acs/systems/list.md index cd291245..0f16445e 100644 --- a/docs/api/acs/systems/list.md +++ b/docs/api/acs/systems/list.md @@ -1,60 +1,16 @@ # List ACS Systems +``` +POST /acs/systems/list ⇒ { acs_systems } +``` + Returns a list of all [access control systems](../../../capability-guides/access-systems.md). To filter the list of returned access control systems by a specific connected account 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. - -### Request Parameters - -**connected_account_id** -*Type:* `` -*Required:* No - -ID of the connected account by which to filter the list of returned access control systems. - -### Response Properties - -**acs_system_id** -ID of the `acs_system`. -**can_add_acs_users_to_acs_access_groups** -Indicates whether the `acs_system` supports [adding users to access groups](../../../capability-guides/access-systems/assigning-users-to-access-groups#add-an-acs-user-to-an-access-group.md). See also [Access Group-based Access Control Systems](../../../capability-guides/access-systems/understanding-access-control-system-differences#access-group-based-access-control-systems.md). -**can_automate_enrollment** -Indicates whether it is possible to [launch enrollment automations](../../../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.md) for the `acs_system`. -**can_create_acs_access_groups** -Indicates whether the `acs_system` supports creating [access groups](../../../capability-guides/access-systems/assigning-users-to-access-groups.md). See also [Access Group-based Access Control Systems](../../../capability-guides/access-systems/understanding-access-control-system-differences#access-group-based-access-control-systems.md). -**can_remove_acs_users_from_acs_access_groups** -Indicates whether the `acs_system` supports [removing users from access groups](../../../capability-guides/access-systems/assigning-users-to-access-groups#remove-an-acs-user-from-an-access-group.md). See also [Access Group-based Access Control Systems](../../../capability-guides/access-systems/understanding-access-control-system-differences#access-group-based-access-control-systems.md). -**connected_account_ids** -IDs of the [connected accounts](../../../core-concepts/connected-accounts.md) associated with the `acs_system`. -**created_at** -Date and time at which the `acs_system` was created. -**errors** -Errors associated with the `acs_system`. -**external_type** -Brand-specific terminology for the `acs_system` type. -**external_type_display_name** -Display name that corresponds to the brand-specific terminology for the `acs_system` type. -**image_alt_text** -Alternative text for the `acs_system` image. -**image_url** -URL for the image that represents the `acs_system`. -**name** -Name of the `acs_system`. -**system_type** - -**system_type_display_name** - -**visionline_metadata** - -**warnings** - -**workspace_id** -ID of the [workspace](../../../core-concepts/workspaces.md) that contains the `acs_system`. - -## Samples +*Return Type: [acs_system](../README.md)* {% tabs %} {% tab title="JavaScript" %} @@ -76,7 +32,19 @@ ID of the [workspace](../../../core-concepts/workspaces.md) that contains the `a ### Response ```python - AcsSystems(0={"acs_system_id":"8d7e0b3a-b889-49a7-9164-4b71a0506a33"}) + [AcsSystem(acs_system_id="8d7e0b3a-b889-49a7-9164-4b71a0506a33")] + ``` + {% endtab %} + {% tab title="Ruby" %} + ### Request + ```ruby + seam.acs.systems.list(connected_account_id: "8d7e0b3a-b889-49a7-9164-4b71a0506a33") + ``` + + ### Response + ```ruby + [] ``` {% endtab %} {% tab title="PHP" %} @@ -88,6 +56,29 @@ ID of the [workspace](../../../core-concepts/workspaces.md) that contains the `a ### Response ```php [{"acs_system_id":"8d7e0b3a-b889-49a7-9164-4b71a0506a33"}] + ``` + {% endtab %} + {% tab title="Seam CLI" %} + ### Request + ```seam_cli + seam acs systems list --connected_account_id "8d7e0b3a-b889-49a7-9164-4b71a0506a33" + ``` + + ### Response + ```seam_cli + [{"acs_system_id":"8d7e0b3a-b889-49a7-9164-4b71a0506a33"}] ``` {% endtab %} {% endtabs %} + +## Request Parameters + +### `connected_account_id` + +*Type:* `` +*Required:* No + +ID of the connected account by which to filter the list of returned access control systems. + +--- + diff --git a/docs/api/acs/systems/list_compatible_credential_manager_acs_systems.md b/docs/api/acs/systems/list_compatible_credential_manager_acs_systems.md new file mode 100644 index 00000000..900cf524 --- /dev/null +++ b/docs/api/acs/systems/list_compatible_credential_manager_acs_systems.md @@ -0,0 +1,29 @@ +# + +``` +POST /acs/systems/list_compatible_credential_manager_acs_systems ⇒ { ... } +``` + + + +*Return Type: void* + +{% tabs %} + {% tab title="No samples available" %} + ``` + No sample requests available. + ``` + {% endtab %} +{% endtabs %} + +## Request Parameters + +### `acs_system_id` + +*Type:* `` +*Required:* Yes + + + +--- + diff --git a/docs/sdk/javascript/acs/systems/get.md b/docs/sdk/javascript/acs/systems/get.md new file mode 100644 index 00000000..2c2a87cb --- /dev/null +++ b/docs/sdk/javascript/acs/systems/get.md @@ -0,0 +1,3 @@ +# + + diff --git a/docs/sdk/javascript/acs/systems/list_compatible_credential_manager_acs_systems.md b/docs/sdk/javascript/acs/systems/list_compatible_credential_manager_acs_systems.md new file mode 100644 index 00000000..2c2a87cb --- /dev/null +++ b/docs/sdk/javascript/acs/systems/list_compatible_credential_manager_acs_systems.md @@ -0,0 +1,3 @@ +# + +