REremote-com
SSO Configuration

Show the current SSO Configuration

Shows the current SSO Configuration for the company.

Authentication

This endpoint accepts any one of the following token types:

  • Company-scoped access token (OAuth2AuthorizationCode) — obtained by a company manager through the Authorization Code flow or the Refresh Token flow. See Authentication for partners.
  • Company-scoped access token (assertion) (OAuth2CompanyManagerAssertion) — obtained through the urn:ietf:params:oauth:grant-type:jwt-bearer grant for a company manager. See OAuth Assertion.
  • Customer API token (CustomerAPIToken) — generated by the customer on their Integration Settings page, with the scopes they choose there. See Authorization for customers.

Scopes

Any one of the scopes in a token type's row is enough. all:read and all:write work too.

Token typeCategoryRead only ScopeWrite only Scope (read access implicit)
Company-scoped access tokenManage company resources (company_admin)View SSO configuration (sso_configuration:read)Manage SSO (sso_configuration:write)
Company-scoped access token (assertion)Manage company resources (company_admin)View SSO configuration (sso_configuration:read)Manage SSO (sso_configuration:write)
Customer API tokenManage company resources (company_admin)View SSO configuration (sso_configuration:read)Manage SSO (sso_configuration:write)
get/v1/sso-configuration

Request

  • Base URL
    https://gateway.remote.com
  • URL
    https://gateway.remote.com/v1/sso-configuration
  • Auth
    • OAuth 2
      Authorization code: /auth/oauth2/authorize
      Token URL: /auth/oauth2/token scopes: https://gateway.remote.com/company.manage
    • or OAuth 2
      Authorization code: /auth/oauth2/authorize
      Token URL: /auth/oauth2/token scopes: sso_configuration:read
    • or OAuth 2
      Authorization code: /auth/oauth2/authorize
      Token URL: /auth/oauth2/token scopes: all:read
    • or OAuth 2
      Authorization code: /auth/oauth2/authorize
      Token URL: /auth/oauth2/token scopes: all:write
    • or OAuth 2
      Client credentials
      Token URL: /auth/oauth2/token scopes: sso_configuration:read
    • or OAuth 2
      Client credentials
      Token URL: /auth/oauth2/token scopes: all:read
    • or OAuth 2
      Client credentials
      Token URL: /auth/oauth2/token scopes: all:write
    • or HTTP bearer

Response

Success

Example response

{
  "data": {
    "audience_uri": "urn:auth:remote-sso:89c4fbb2-some-id-8e4b-280f8795bbd8",
    "domain": "yourcompanydomain1.com,yourcompanydomain2.com",
    "identity_provider_url": "https://someproviderurl.com/",
    "sso_url": "https://remote-sso.com/login/callback?connection=89c4fbb2-some-id-8e4b-280f8795bbd8"
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.