Skip to content

Commit

Permalink
Tables removed
Browse files Browse the repository at this point in the history
  • Loading branch information
@mastafit
mastafit committed Aug 5, 2024
1 parent a8d14ad commit ae9f331
Show file tree
Hide file tree
Showing 2 changed files with 58 additions and 156 deletions.
151 changes: 44 additions & 107 deletions docs/api/acs/systems/list.md
View file
Original file line number Diff line number Diff line change
@@ -1,11 +1,3 @@
---
description: "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."
---

# List ACS Systems

Returns a list of all [access control systems](../../../capability-guides/access-systems.md).
Expand All @@ -14,108 +6,53 @@ To filter the list of returned access control systems by a specific connected ac
`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 and Response

<table>
<thead>
<tr>
<th>Parameter</th>
<th width='112.33333333333331'>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><code>connected_account_id</code></td>
<td>String (UUID)<br /><em>Optional</em></td>
<td>ID of the connected account by which to filter the list of returned access control systems.</td>
</tr>
</tbody>
</table>
### 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

<table>
<thead>
<tr>
<th width="310">Property</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><code>acs_system_id</code></td>
<td>ID of the `acs_system`.</td>
</tr>
<tr>
<td><code>can_add_acs_users_to_acs_access_groups</code></td>
<td>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).</td>
</tr>
<tr>
<td><code>can_automate_enrollment</code></td>
<td>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`.</td>
</tr>
<tr>
<td><code>can_create_acs_access_groups</code></td>
<td>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).</td>
</tr>
<tr>
<td><code>can_remove_acs_users_from_acs_access_groups</code></td>
<td>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).</td>
</tr>
<tr>
<td><code>connected_account_ids</code></td>
<td>IDs of the [connected accounts](../../../core-concepts/connected-accounts.md) associated with the `acs_system`.</td>
</tr>
<tr>
<td><code>created_at</code></td>
<td>Date and time at which the `acs_system` was created.</td>
</tr>
<tr>
<td><code>errors</code></td>
<td>Errors associated with the `acs_system`.</td>
</tr>
<tr>
<td><code>external_type</code></td>
<td>Brand-specific terminology for the `acs_system` type.</td>
</tr>
<tr>
<td><code>external_type_display_name</code></td>
<td>Display name that corresponds to the brand-specific terminology for the `acs_system` type.</td>
</tr>
<tr>
<td><code>image_alt_text</code></td>
<td>Alternative text for the `acs_system` image.</td>
</tr>
<tr>
<td><code>image_url</code></td>
<td>URL for the image that represents the `acs_system`.</td>
</tr>
<tr>
<td><code>name</code></td>
<td>Name of the `acs_system`.</td>
</tr>
<tr>
<td><code>system_type</code></td>
<td></td>
</tr>
<tr>
<td><code>system_type_display_name</code></td>
<td></td>
</tr>
<tr>
<td><code>visionline_metadata</code></td>
<td></td>
</tr>
<tr>
<td><code>warnings</code></td>
<td></td>
</tr>
<tr>
<td><code>workspace_id</code></td>
<td>ID of the [workspace](../../../core-concepts/workspaces.md) that contains the `acs_system`.</td>
</tr>
</tbody>
</table>
**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

Expand Down
63 changes: 14 additions & 49 deletions src/layouts/api-reference.hbs
View file
Original file line number Diff line number Diff line change
@@ -1,59 +1,24 @@
---
description: "{{{description}}}"
---

# {{title}}

{{{description}}}

### Request and Response

<table>
<thead>
<tr>
<th>Parameter</th>
<th width='112.33333333333331'>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
{{#each request.parameters}}
<tr>
<td><code>{{this.name}}</code></td>
<td>String (UUID)<br /><em>{{#if
this.required
}}Required{{else}}Optional{{/if}}</em></td>
<td>{{this.description}}</td>
</tr>
{{else}}
<tr>
<td colspan='3'>No parameters available.</td>
</tr>
{{/each}}
</tbody>
</table>
### Request Parameters

{{#each request.parameters}}
**{{this.name}}**
*Type:* `{{this.type}}`
*Required:* {{#if this.required}}Yes{{else}}No{{/if}}

{{this.description}}
{{/each}}

<table>
<thead>
<tr>
<th width="310">Property</th>
<th>Description</th>
</tr>
</thead>
<tbody>
{{#each response.properties}}
<tr>
<td><code>{{this.name}}</code></td>
<td>{{this.description}}</td>
</tr>
{{else}}
<tr>
<td colspan="2">No properties available.</td>
</tr>
{{/each}}
</tbody>
</table>
### Response Properties

{{#each response.properties}}
**{{this.name}}**
{{this.description}}
{{/each}}

## Samples

Expand Down

0 comments on commit ae9f331

Please sign in to comment.