From 23b24995b7affde1e938351595ae19146ac8fecf Mon Sep 17 00:00:00 2001 From: Deborah Femia Date: Sat, 18 Jan 2025 04:50:11 +0000 Subject: [PATCH] GITBOOK-526: Reorg Salto KS setup instructions --- .../user_identities/update-a-user-identity.md | 2 + .../salto-ks-setup-instructions.md | 48 +++++++++++++------ docs/device-guides/salto-locks.md | 36 ++++++++++---- 3 files changed, 62 insertions(+), 24 deletions(-) create mode 100644 docs/api/user_identities/update-a-user-identity.md diff --git a/docs/api/user_identities/update-a-user-identity.md b/docs/api/user_identities/update-a-user-identity.md new file mode 100644 index 00000000..50d02a02 --- /dev/null +++ b/docs/api/user_identities/update-a-user-identity.md @@ -0,0 +1,2 @@ +# Update a User Identity + diff --git a/docs/device-and-system-integration-guides/salto-ks-access-control-system/salto-ks-setup-instructions.md b/docs/device-and-system-integration-guides/salto-ks-access-control-system/salto-ks-setup-instructions.md index b5f48d3e..36f8ead2 100644 --- a/docs/device-and-system-integration-guides/salto-ks-access-control-system/salto-ks-setup-instructions.md +++ b/docs/device-and-system-integration-guides/salto-ks-access-control-system/salto-ks-setup-instructions.md @@ -1,25 +1,43 @@ +--- +description: Learn how to connect your Salto KS access control system to Seam. +--- + # Salto KS Setup Instructions -To connect the Salto KS ACS to Seam: +This topic describes how to connect your Salto KS sites to Seam. -1. Create a [Connect Webview](../../core-concepts/connect-webviews/), including `salto_ks` in the set of [`accepted_providers`](../../api-clients/connect_webviews/#connect_webview-properties). -2. Display the Connect Webview and perform the following steps: - * If the Connect Webview displays multiple brand options, select **Salto KS**. - * In the **Enter your credentials** dialog, type your username and password for the Salto KS web app. +## Prerequisites - Note the following restrictions: +Note the following requirements before connecting your Salto KS access control system to Seam: - * You must use a Salto KS production environment account to connect to Seam. You cannot use "Accept Environment" credentials.\ - To confirm that your Salto KS account is a production environment account, note the Salto KS dashboard URL. Make sure that the subdomain within this URL is `app`, for example, `https://app.saltoks.com`. +### Site Admin - A subdomain of `app-accept`, for example, `https://app-accept.saltoks.com`, indicates an "Accept Environment" that you cannot connect to Seam. - * You must use a Salto KS web app user account that has "Site Admin" rights. - * Select the Salto KS sites that you want to integrate with Seam. +You must use a Salto KS web app user account that has "Site Admin" rights. - {% hint style="success" %} - Make sure that your installer has released your Salto KS sites. Seam cannot perform actions on unreleased Salto KS sites. - {% endhint %} - * Confirm that you will allow Seam to add the requisite admin user to your Salto KS site for the integration with Seam, click **Allow and Continue**. +### Salto KS Production Environment + +You must use a Salto KS production environment account to connect to Seam. You cannot use "Accept Environment" credentials. + +To confirm that your Salto KS account is a production environment account, note the Salto KS dashboard URL. Make sure that the subdomain within this URL is `app`, for example, `https://app.saltoks.com`. + +A subdomain of `app-accept`, for example, `https://app-accept.saltoks.com`, indicates an "Accept Environment" that you cannot connect to Seam. + +### Released Salto KS Sites + +Make sure that your installer has released your Salto KS sites. Seam cannot perform actions on unreleased Salto KS sites. + +*** + +## Setup Process + +To connect the Salto KS ACS to Seam: + +1. Create a [Connect Webview](../../core-concepts/connect-webviews/), including `salto_ks` in the set of [`accepted_providers`](../../api-clients/connect_webviews/#connect_webview-properties). +2. Display the Connect Webview and perform the following steps: + 1. If the Connect Webview displays multiple brand options, select **Salto KS**. + 2. In the **Enter your credentials** dialog, type your username and password for the Salto KS web app. + 3. Select the Salto KS sites that you want to integrate with Seam. + 4. Confirm that you will allow Seam to add the requisite admin user to your Salto KS site for the integration with Seam, click **Allow and Continue**. {% hint style="warning" %} Do not suspend or remove the Seam Integration admin user from your Salto KS site. diff --git a/docs/device-guides/salto-locks.md b/docs/device-guides/salto-locks.md index bb83a537..668c8da1 100644 --- a/docs/device-guides/salto-locks.md +++ b/docs/device-guides/salto-locks.md @@ -42,18 +42,36 @@ To create a [Connect Webview](../core-concepts/connect-webviews/) that enables y ## Setup Instructions -To control Salto KS devices using Seam, you must prompt owners of these devices to perform the following steps: +This section describes how to connect your Salto KS devices to Seam. + +### Prerequisites + +Note the following requirements before connecting your Salto KS access control system to Seam: + +#### Site Admin + +You must use a Salto KS web app user account that has "Site Admin" rights. + +#### Salto KS Production Environment + +You must use a Salto KS production environment account to connect to Seam. You cannot use "Accept Environment" credentials. -1. Create an account in the [Salto KS app](https://app.saltoks.com/) if you have not done so already.\ - You must use a Salto KS production environment account to connect to Seam. You cannot use "Accept Environment" credentials.\ - To confirm that your Salto KS account is a production environment account, note the Salto KS dashboard URL. Make sure that the subdomain within this URL is `app`, for example, `https://app.saltoks.com`. +To confirm that your Salto KS account is a production environment account, note the Salto KS dashboard URL. Make sure that the subdomain within this URL is `app`, for example, `https://app.saltoks.com`. - A subdomain of `app-accept`, for example, `https://app-accept.saltoks.com`, indicates an "Accept Environment" that you cannot connect to Seam. -2. In the Salto KS app, add your Salto KS devices. +A subdomain of `app-accept`, for example, `https://app-accept.saltoks.com`, indicates an "Accept Environment" that you cannot connect to Seam. + +#### Released Salto KS Sites + +Make sure that your installer has released your Salto KS sites. Seam cannot perform actions on unreleased Salto KS sites. + +*** + +### Setup Process + +To control Salto KS devices using Seam, you must prompt owners of these devices to perform the following steps: - {% hint style="success" %} - Make sure that your installer has released your Salto KS site. Seam cannot perform actions on unreleased Salto KS sites. - {% endhint %} +1. Create an account in the [Salto KS app](https://app.saltoks.com/) if you have not done so already. +2. In the Salto KS app, add your Salto KS devices. 3. Note your login credentials for the Salto KS app, and use these credentials to log in to the [Seam Connect Webview](../core-concepts/connect-webviews/) to add your devices to Seam. * During the Connect Webview process, click **Allow and Continue** to confirm that you will allow Seam to add the requisite admin user to your Salto KS site for the integration with Seam.