Configuration

Pre-requisite: Configuration

As a pre-requisite for Archisketch Single-Sign On integration, the partner enterprise need to register configuration on Archisketch dahsboard.


Proceed to https://{replace-with-your-enterprise-domain}.archisketch.com> [Settings] > [Customizations] > [OAuth Config] and configure the fields below.

Field

Description

Required

Example

Verification URL

Verification URL of partner enterprise
(Only supports GET Http method)

O

"https://partner-enterprise.server/sso/verify"

Use GET with Bearer Token

Method for passing the verification token to verificationUrl

  • *True**: As Bearer token In Authorization Header
  • *False**: In Request Parameter (Default)

X

False

Request Param Key

Request Parameter name for verification token in case useBearerTokenForVerification is false

X

"token"

UID Key

Key for unique ID of Verification API Response of the partner enterprise (mapped to Archisketch User's uid)

X

"id"

Email Key

Key for user email in Verification API Response of the partner enterprise (mapped to Archisketch User's email)

O

"email"

Name Key

Key for user name in Verification API Response of the partner enterprise (mapped to Archisketch User's name)

O

"name"

Avatar Key

Key for URL of the user's avatar image in Verification API Response of the partner enterprise (mapped to Archisketch User's avatarImage)

X

"avatarImage"