auth

Changed on

Add an identity provider configuration for a team

post/identity-provider

Request

  • Base URL
    https://api.scalar.com/core
  • URL
    https://api.scalar.com/core/identity-provider
  • Auth
    HTTP bearer

Request body

namestring required
issuerstring

This is the URI that identifies your SAML identity provider. Any assertions must use a matching saml:Issuer attribute.

ssoUrlstring

This URL is used by Scalar to initiate a SAML login.

x509Certstring

The authentication certificate issued by your identity provider

provider'local' | 'google' | 'okta' | 'auth0' | 'azure' | 'one-login' | 'ping-identity' required
signRequestsboolean
consumerOnlyboolean required
createUsersboolean

Response

Default Response

uidstring required
createdAtinteger required
updatedAtinteger required
namestring required
provider'local' | 'google' | 'okta' | 'auth0' | 'azure' | 'one-login' | 'ping-identity' required
createUsersboolean required
signRequestsboolean required
ssoUrlstring required

This URL is used by Scalar to initiate a SAML login.

issuerstring required

This is the URI that identifies your SAML identity provider. Any assertions must use a matching saml:Issuer attribute.

x509Certstring required

The authentication certificate issued by your identity provider

consumerOnlyboolean required

Example response

{
  "uid": "UakgbKJ5m9gl0JDMbcJqL",
  "createdAt": 1735689600,
  "updatedAt": 1735689600
}

Changes

  • 5e4c47d6805bRevision changes
    • info

      the response's property default value unixTimestamp() was removed for the status

    • info

      the response's property default value unixTimestamp() was removed for the status

  • 8dff1e93bc68Revision changes
    • info

      api operation id postidentityProvider removed and replaced with postIdentityProvider