Single Sign-On (SSO)

​

Enable SSO

  https://app.speckle.systems/api/v1/workspaces/{workspace-short-id}/sso/oidc/callback

​

When SSO is enabled

1. Users will see your organization’s SSO option when they are invited to the workspace.
2. Existing workspace members will be prompted to authenticate with SSO the next time they access the workspace.
3. Users with the Guest role can still access the workspace without SSO, since this role is designed for external collaborators.

​

Configure backchannel logout

  https://app.speckle.systems/api/v1/workspaces/{workspace-short-id}/sso/oidc/backchannel-logout

​

Update SSO provider configuration

1. Open the api explorer at https://app.speckle.systems/graphql
2. Query the existing SSO provider details with the query below, it will return the details of the existing provider.

query ($slug: String!) {
  workspaceBySlug(slug: $slug) {
    id
    sso {
      provider {
        id
        clientId
        issuerUrl
        name
      }
    }
  }
}

3. update the provider details with the mutation and the input structure detailed below.

mutation ($input: WorkspaceSsoProviderUpdateInput!) {
  workspaceMutations {
    updateSsoProvider(input: $input)
  }
}

{
  "input": {
    "clientId": "",
    "clientSecret": "",
    "issuerUrl": "",
    "providerId": "",
    "providerName": "",
    "workspaceId": ""
  }
}

4. the sso provider details should be updated if the mutation was successful.

​

FAQ