Skip to content

Commit

Permalink
revert acs paths
Browse files Browse the repository at this point in the history
  • Loading branch information
mikewuu committed Aug 20, 2024
1 parent 197d46d commit 05f5224
Show file tree
Hide file tree
Showing 11 changed files with 89 additions and 89 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ Once you have [created credentials](../managing-credentials.md), you can retriev

## List Entrances Associated with a Credential

To [list the entrances to which a specific credential grants access](../../../api-clients/acs/credentials/list-accessible-entrances.md), use `list_accessible_entrances` and provide the `acs_credential_id`.
To [list the entrances to which a specific credential grants access](../../../api-clients/access-control-systems/credentials/list-accessible-entrances.md), use `list_accessible_entrances` and provide the `acs_credential_id`.

{% tabs %}
{% tab title="Python" %}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,13 +4,13 @@ description: Learn how to list and get information about your ACS systems.

# Retrieving ACS System Details

You can list details for all the ACSs in your [workspace](../../core-concepts/workspaces/) or get these details for a specific ACS. Note that Seam represents the ACS as an [`acs_system`](../../api-clients/acs/systems/) resource. When you want to [create ACS users](../../products/access-systems/user-management.md#create-a-user) for your ACS, you must first obtain the ID of the `acs_system` for which you want to create these users.
You can list details for all the ACSs in your [workspace](../../core-concepts/workspaces/) or get these details for a specific ACS. Note that Seam represents the ACS as an [`acs_system`](../../api-clients/access-control-systems/systems/) resource. When you want to [create ACS users](../../products/access-systems/user-management.md#create-a-user) for your ACS, you must first obtain the ID of the `acs_system` for which you want to create these users.

***

## List ACS Systems

You can [list all `acs_system` resources](../../api-clients/acs/systems/list-systems.md) in your workspace. Note the `acs_system_id` in the response.
You can [list all `acs_system` resources](../../api-clients/access-control-systems/systems/list-systems.md) in your workspace. Note the `acs_system_id` in the response.

{% tabs %}
{% tab title="Python" %}
Expand Down Expand Up @@ -184,7 +184,7 @@ acs_systems, uErr := client.Acs.Systems.List(

## Get an ACS System

You can [get the details of a specific `acs_system`](../../api-clients/acs/systems/get-system.md) in your workspace. These details include the `acs_system_id`, date and time at which the `acs_system` was created in Seam, the name and type of the `acs_system`, and so on.
You can [get the details of a specific `acs_system`](../../api-clients/access-control-systems/systems/get-system.md) in your workspace. These details include the `acs_system_id`, date and time at which the `acs_system` was created in Seam, the name and type of the `acs_system`, and so on.

{% tabs %}
{% tab title="Python" %}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ In an ACS, an entrance is a secured door, gate, zone, or other method of entry.

## List All Entrances

You can [list all `acs_entrance` resources](../../api-clients/acs/entrances/list-entrances.md) in your workspace. Note that entrance details include manufacturer-specific metadata that may vary by [manufacturer](../../device-and-system-integration-guides/overview.md#access-control-systems).
You can [list all `acs_entrance` resources](../../api-clients/access-control-systems/entrances/list-entrances.md) in your workspace. Note that entrance details include manufacturer-specific metadata that may vary by [manufacturer](../../device-and-system-integration-guides/overview.md#access-control-systems).

{% tabs %}
{% tab title="Python" %}
Expand Down Expand Up @@ -202,7 +202,7 @@ acs_entrances, uErr := client.Acs.Entrances.List(

## List Entrances in an ACS

To list all `acs_entrance`s in a specific ACS, include the `acs_system_id` filter in the [List Entrances](../../api-clients/acs/entrances/list-entrances.md) request. Note that entrance details include manufacturer-specific metadata that may vary by [manufacturer](../../device-and-system-integration-guides/overview.md#access-control-systems).
To list all `acs_entrance`s in a specific ACS, include the `acs_system_id` filter in the [List Entrances](../../api-clients/access-control-systems/entrances/list-entrances.md) request. Note that entrance details include manufacturer-specific metadata that may vary by [manufacturer](../../device-and-system-integration-guides/overview.md#access-control-systems).

{% tabs %}
{% tab title="Python" %}
Expand Down Expand Up @@ -400,7 +400,7 @@ acs_entrances, uErr := client.Acs.Entrances.List(

## List Credentials Associated with an Entrance

To [list the credentials that grant access to a specific entrance](../../api-clients/acs/entrances/list-credentials-with-access-to-an-entrance.md), use `list_credentials_with_access` method for the `acs_entrance` object and provide the `acs_entrance_id`.
To [list the credentials that grant access to a specific entrance](../../api-clients/access-control-systems/entrances/list-credentials-with-access-to-an-entrance.md), use `list_credentials_with_access` method for the `acs_entrance` object and provide the `acs_entrance_id`.

{% tabs %}
{% tab title="Python" %}
Expand Down Expand Up @@ -634,13 +634,13 @@ This response contains manufacturer-specific metadata that may vary by [manufact

## List Entrances Associated with a Credential

To [list the entrances to which a specific credential grants access](../../api-clients/acs/credentials/list-accessible-entrances.md), use `list_accessible_entrances` method for the `acs_credential` object and provide the `acs_credential_id`. For details, see [Managing Credentials](managing-credentials.md#list-entrances-associated-with-a-credential).
To [list the entrances to which a specific credential grants access](../../api-clients/access-control-systems/credentials/list-accessible-entrances.md), use `list_accessible_entrances` method for the `acs_credential` object and provide the `acs_credential_id`. For details, see [Managing Credentials](managing-credentials.md#list-entrances-associated-with-a-credential).

***

## Get an Entrance

You can [get the details of a specific `acs_entrance`](../../api-clients/acs/entrances/get-an-entrance.md). Note that entrance details include manufacturer-specific metadata that may vary by [manufacturer](../../device-and-system-integration-guides/overview.md#access-control-systems).
You can [get the details of a specific `acs_entrance`](../../api-clients/access-control-systems/entrances/get-an-entrance.md). Note that entrance details include manufacturer-specific metadata that may vary by [manufacturer](../../device-and-system-integration-guides/overview.md#access-control-systems).

{% tabs %}
{% tab title="Python" %}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -54,18 +54,18 @@ The following process describes the configuration steps for your application to

Depending on the access method and specific ACS, your application can also configure additional credential properties. For more information about manufacturer-specific variations, see the [system integration guide](../../device-and-system-integration-guides/overview.md#access-control-systems) for your ACS.

You can also perform other management actions, as needed, such as [adding ACS users to](../../products/access-systems/assigning-users-to-access-groups.md#add-an-acs-user-to-an-access-group) and [removing ACS users from access groups](../../products/access-systems/assigning-users-to-access-groups.md#remove-an-acs-user-from-an-access-group), [assigning](assigning-credentials-to-users.md#assign-a-credential-to-a-user) and [unassigning](assigning-credentials-to-users.md#unassign-a-credential-from-a-user) existing credentials, [suspending](../../products/access-systems/suspending-and-unsuspending-users.md#suspend-an-acs-user) and [unsuspending](../../products/access-systems/suspending-and-unsuspending-users.md#unsuspend-an-acs-user) ACS users, [updating ACS users](../../products/access-systems/user-management.md#update-a-user) and [credentials](../../api-clients/acs/credentials/update-a-credential.md), and [deleting ACS users](../../products/access-systems/user-management.md#delete-a-user) and [credentials](managing-credentials.md#delete-a-credential).
You can also perform other management actions, as needed, such as [adding ACS users to](../../products/access-systems/assigning-users-to-access-groups.md#add-an-acs-user-to-an-access-group) and [removing ACS users from access groups](../../products/access-systems/assigning-users-to-access-groups.md#remove-an-acs-user-from-an-access-group), [assigning](assigning-credentials-to-users.md#assign-a-credential-to-a-user) and [unassigning](assigning-credentials-to-users.md#unassign-a-credential-from-a-user) existing credentials, [suspending](../../products/access-systems/suspending-and-unsuspending-users.md#suspend-an-acs-user) and [unsuspending](../../products/access-systems/suspending-and-unsuspending-users.md#unsuspend-an-acs-user) ACS users, [updating ACS users](../../products/access-systems/user-management.md#update-a-user) and [credentials](../../api-clients/access-control-systems/credentials/update-a-credential.md), and [deleting ACS users](../../products/access-systems/user-management.md#delete-a-user) and [credentials](managing-credentials.md#delete-a-credential).

### Credential-based Access Control Systems

In a credential-based ACS, the [`acs_credential`](../../api-clients/acs/credentials/) resource contains the list of entrances to which the credential grants access. The `acs_credential` also contains the schedule that specifies when this access is valid. You specify each schedule by configuring a `starts_at` and `ends_at` date and time.
In a credential-based ACS, the [`acs_credential`](../../api-clients/access-control-systems/credentials/) resource contains the list of entrances to which the credential grants access. The `acs_credential` also contains the schedule that specifies when this access is valid. You specify each schedule by configuring a `starts_at` and `ends_at` date and time.

<figure><img src="../../.gitbook/assets/acs-arch-credential-based.png" alt="Seam resource relationships for a credential-based ACS"><figcaption><p>Seam resource relationships for a credential-based ACS</p></figcaption></figure>

The following process describes the configuration steps for your application to grant access in a credential-based ACS:

1. When the ACS connects to Seam, Seam automatically creates the [`acs_system`](../../api-clients/acs/systems/). Seam also syncs the entrances from the connected ACS as `acs_entrance` resources. Note that because Seam automatically syncs these entrance resources from the ACS, you cannot create, edit, or delete them using the Seam API.
2. Your application [creates](../../products/access-systems/user-management.md#create-a-user) an [`acs_user`](../../api-clients/acs/users/) for each user within this ACS. Each `acs_user` is configured with a set of attributes, such their name, email address, and phone number, as applicable.\
1. When the ACS connects to Seam, Seam automatically creates the [`acs_system`](../../api-clients/access-control-systems/systems/). Seam also syncs the entrances from the connected ACS as `acs_entrance` resources. Note that because Seam automatically syncs these entrance resources from the ACS, you cannot create, edit, or delete them using the Seam API.
2. Your application [creates](../../products/access-systems/user-management.md#create-a-user) an [`acs_user`](../../api-clients/access-control-systems/users/) for each user within this ACS. Each `acs_user` is configured with a set of attributes, such their name, email address, and phone number, as applicable.\
If you need to grant a single application user access to multiple ACSs—for example, if an application user needs access to multiple buildings, each of which uses a separate ACS—you can use Seam [user identities](../../api-clients/user-identities/) to link `acs_user`s in different `acs_system`s.
3. Your application [creates](managing-credentials.md#create-a-credential-for-a-user) `acs_credential`s with the following attributes:

Expand All @@ -76,7 +76,7 @@ The following process describes the configuration steps for your application to

Depending on the access method and specific ACS, your application can also configure additional credential properties. For more information about manufacturer-specific variations, see the [system integration guide](../../device-and-system-integration-guides/overview.md#access-control-systems) for your ACS.

You can also perform other management actions, as needed, such as [assigning](assigning-credentials-to-users.md#assign-a-credential-to-a-user) and [unassigning](assigning-credentials-to-users.md#unassign-a-credential-from-a-user) existing credentials, [suspending](../../products/access-systems/suspending-and-unsuspending-users.md#suspend-an-acs-user) and [unsuspending](../../products/access-systems/suspending-and-unsuspending-users.md#unsuspend-an-acs-user) ACS users, [updating ACS users](../../products/access-systems/user-management.md#update-a-user) and [credentials](../../api-clients/acs/credentials/update-a-credential.md), and [deleting ACS users](../../products/access-systems/user-management.md#delete-a-user) and [credentials](managing-credentials.md#delete-a-credential).
You can also perform other management actions, as needed, such as [assigning](assigning-credentials-to-users.md#assign-a-credential-to-a-user) and [unassigning](assigning-credentials-to-users.md#unassign-a-credential-from-a-user) existing credentials, [suspending](../../products/access-systems/suspending-and-unsuspending-users.md#suspend-an-acs-user) and [unsuspending](../../products/access-systems/suspending-and-unsuspending-users.md#unsuspend-an-acs-user) ACS users, [updating ACS users](../../products/access-systems/user-management.md#update-a-user) and [credentials](../../api-clients/access-control-systems/credentials/update-a-credential.md), and [deleting ACS users](../../products/access-systems/user-management.md#delete-a-user) and [credentials](managing-credentials.md#delete-a-credential).

***

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ The following diagram shows the Seam resources for a Latch ACS and the relations

The following table provides a brief description of each of the Seam resources for the Latch ACS:

<table><thead><tr><th width="233">Seam Resource</th><th>Description</th></tr></thead><tbody><tr><td><picture><source srcset="../../.gitbook/assets/acs-user_dark.png" media="(prefers-color-scheme: dark)"><img src="../../.gitbook/assets/acs-user_light.png" alt="" data-size="line"></picture> <a href="../../api-clients/acs/users/"><code>acs_user</code></a></td><td>Individual who has been granted access to specific entrance within a building. A user could be a resident or temporary guest.</td></tr><tr><td><picture><source srcset="../../.gitbook/assets/acs-entrance_dark.png" media="(prefers-color-scheme: dark)"><img src="../../.gitbook/assets/acs-entrance_light.png" alt="" data-size="line"></picture> <a href="../../api-clients/acs/entrances/"><code>acs_entrance</code></a></td><td>Physical points of entry within a property that are secured with Latch's smart access devices.</td></tr><tr><td><picture><source srcset="../../.gitbook/assets/acs-credential_latch_dark.png" media="(prefers-color-scheme: dark)"><img src="../../.gitbook/assets/acs-credential_latch_light.png" alt="" data-size="line"></picture> <a href="../../api-clients/acs/credentials/"><code>acs_credential</code></a></td><td>PIN codes or mobile keys. You can only assign one entrance to a key code-based credential. You can assign multiple entrances to mobile keys.</td></tr></tbody></table>
<table><thead><tr><th width="233">Seam Resource</th><th>Description</th></tr></thead><tbody><tr><td><picture><source srcset="../../.gitbook/assets/acs-user_dark.png" media="(prefers-color-scheme: dark)"><img src="../../.gitbook/assets/acs-user_light.png" alt="" data-size="line"></picture> <a href="../../api-clients/access-control-systems/users/"><code>acs_user</code></a></td><td>Individual who has been granted access to specific entrance within a building. A user could be a resident or temporary guest.</td></tr><tr><td><picture><source srcset="../../.gitbook/assets/acs-entrance_dark.png" media="(prefers-color-scheme: dark)"><img src="../../.gitbook/assets/acs-entrance_light.png" alt="" data-size="line"></picture> <a href="../../api-clients/access-control-systems/entrances/"><code>acs_entrance</code></a></td><td>Physical points of entry within a property that are secured with Latch's smart access devices.</td></tr><tr><td><picture><source srcset="../../.gitbook/assets/acs-credential_latch_dark.png" media="(prefers-color-scheme: dark)"><img src="../../.gitbook/assets/acs-credential_latch_light.png" alt="" data-size="line"></picture> <a href="../../api-clients/access-control-systems/credentials/"><code>acs_credential</code></a></td><td>PIN codes or mobile keys. You can only assign one entrance to a key code-based credential. You can assign multiple entrances to mobile keys.</td></tr></tbody></table>

For more information about managing your Latch ACS through Seam, see [Credential-based Access Control Systems](../../capability-guides/access-systems/understanding-access-control-system-differences.md#credential-based-access-control-systems) and [Access Control Systems](../../products/access-systems/).

Expand Down
Loading

0 comments on commit 05f5224

Please sign in to comment.