Skip to main content

Create a new set of SAML provider credentials for SSO​

Create a new set of SAML provider credentials for your organization to use with SSO.

Header Parameters
  • SlashID-OrgID string required

    The organization ID

    Example: af5fbd30-7ce7-4548-8b30-4cd59cb2aba1
  • SlashID-Required-Consistency string

    Possible values: [local_region, all_regions]

    Default value: local_region

    The consistency level required for this request. If the consistency level is not achieved within the timeout, the request will fail with a 408 Request Timeout error. 408 Request Timeout error indicates that request was not handled within the timeout, but it may still be handled after request timeout. Allowed values: * local_region: Wait while the request executes in the local region. * all_regions: Wait while the request executes across all regions. You can learn more about our replication model on our Cross-region Replication Model page.

  • SlashID-Required-Consistency-Timeout integer

    Possible values: >= 1 and <= 120

    Default value: 30

    The maximum amount of seconds to wait for the requested consistency level to be achieved. If the consistency level is not achieved within this time, the request will fail with a 408 Request Timeout error. 408 Request Timeout error indicates that request was not handled within the timeout, but it may still be handled after request timeout. You can learn more about our replication model on our Cross-region Replication Model page.

Request Body
  • label string

    A friendly free-form label to help you identify this set of SAML provider credentials.

  • idp_metadata_url string required

    The SAML IdP's metadata URL.

  • email_claims string[]

    Possible values: <= 3

    The names of the claims in the SAML response containing the users' email addresses. The first match is added to the person's set of handles.

  • enable_in_slashid_oidc_authz_server boolean

    Indicates whether these credentials can be used for SSO authentication during an OIDC flow in which SlashID acts as the Authorization Server.

Responses

OK

Schema
  • meta object
  • pagination object
  • limit integer
  • offset integer
  • total_count int64
  • errors object[]
  • httpcode integer
  • message string
  • result object

    A SAML provider credential

  • id string
  • label string

    A friendly free-form label to help you identify this set of SAML provider credentials.

  • idp_metadata_url string

    The SAML IdP's metadata URL.

  • email_claims string[]

    Possible values: <= 3

    The names of the claims in the SAML response containing the users' email addresses. The first match is added to the person's set of handles.

  • enable_in_slashid_oidc_authz_server boolean

    Indicates whether these credentials can be used for SSO authentication during an OIDC flow in which SlashID acts as the Authorization Server.