> For the complete documentation index, see [llms.txt](https://docs.archisketch.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.archisketch.com/guide/dev-en/api-sdk/api-integration/sso-integration.md).

# SSO Integration Guide

By using Archisketch SSO (Single Sign-On), users can log in to the dashboard using the partner's own authentication system. In this method, the partner server issues a verification token, and Archisketch verifies it with the partner server.

***

{% stepper %}
{% step %}

#### 1. Accessing the Archisketch Enterprise Service

After signing a contract with Archisketch, please log in to the Archisketch Enterprise Service. Go to **Settings > Enterprise Settings > Developer Settings**, and click the **'View/Update'** button.

<figure><img src="/files/zp9rBTQtV0kKdXFvyIfe" alt=""><figcaption></figcaption></figure>

| **Field**                 | **Description**                                                                                         | **Required** | **Example**                            |
| ------------------------- | ------------------------------------------------------------------------------------------------------- | ------------ | -------------------------------------- |
| Verification URL          | The verification URL of the partner authentication server (Only GET method is supported)                | Y            | `https://your-service.com/oauth2/user` |
| Email Key                 | The email field name in the verification API response (maps to Archisketch `email`)                     | Y            | `email`                                |
| Name Key                  | The name field name in the verification API response (maps to Archisketch `name`)                       | Y            | `name`                                 |
| UID Key                   | The unique user ID field name in the verification API response (maps to Archisketch `uid`)              | N            | `id`                                   |
| Avatar Key                | The avatar image URL field name in the verification API response (maps to Archisketch `avatarImage`)    | N            | `profileImageUrl`                      |
| Use GET with Bearer Token | Verification token delivery method. true: Authorization header Bearer, false: Query Parameter (Default) | N            | `false`                                |
| Request Param Key         | The Query Parameter name to use when `Use GET with Bearer Token` is false                               | N            | `token`                                |

{% hint style="info" %}
Depending on the configuration, Archisketch delivers the token in one of two ways when calling the partner's verification server:

* **Query Parameter Method** (Default): `GET {verificationUrl}?{paramKey}={verifyToken}`
* **Bearer Token Method**: `GET {verificationUrl}` with header `Authorization: Bearer {verifyToken}`
  {% endhint %}
  {% endstep %}

{% step %}

#### 2. Checking the Integration Flow

<figure><img src="/files/MDjZHydnOeoIppLg5w4d" alt=""><figcaption></figcaption></figure>

1. The user logs in to the partner's service.
2. The partner server generates a `verifyToken` and calls the Archisketch Login API.
3. Archisketch passes the `verifyToken` to the registered Verification URL to verify user information.
4. Upon successful verification, Archisketch creates (new) or updates (existing) the user and returns tokens.
5. You can authenticate into the dashboard using the issued tokens.
   {% endstep %}

{% step %}

#### 3. Redirecting to the Dashboard

You can redirect directly to the dashboard for authentication using the issued tokens.

```
https://{enterprise-subdomain}.archisketch.com/auth/sign-in?access_token={accessToken}&refresh_token={refreshToken}
```

{% endstep %}
{% endstepper %}

{% hint style="warning" %}
If you have any questions or feedback regarding the SSO integration, please reach out via our [Integration/Development Inquiry](https://www.archisketch.com/ko/enterprisetrial/).
{% endhint %}