Configuring SSO

  1. Select Application Configuration > Configuration > Environment > Global Settings. The Global Settings Card screen is displayed.
  2. Click Configure SSO. The Configure SSO window is displayed.
  3. Specify this information:
    Entity ID

    The URI that identifies the application. Typically, this is the API URL with /session/sso appended to the end. A custom entity ID is also supported, provided the specified value is a valid URI.

    Metadata Type
    The type of metadata provided by the identity provider. Possible values:
    • Single IDP: Metadata contains information for a single identity provider.
    • Multiple IDPs and/or SPs: Metadata contains information for multiple identity providers and/or service providers.
    Metadata Location
    The location from which the identity provider metadata is obtained.
    Identity Provider
    The entity ID of the identity provider contained within the metadata.
    Expiration Claim
    The name of the claim in the SAML response that specifies the duration of an SSO session before expiration. If no value is provided for the specified claim, or if the claim cannot be found in the SAML response, the session expires eight hours after the initial login.
    Store Name
    The name of the certificate store. Possible values:
    • Auth Root
    • Certificate Authority
    • My
    • Root
    • Trusted People
    • Trusted Publisher
    Store Location
    The location of the certificate store. Possible values:
    • Current User
    • Local Machine
    Find Type

    The method used to identify the certificate within the selected certificate store. Possible values:

    • Thumbprint
    • Subject Name
    • Subject Distinguished Name
    • Serial Number
    • Subject Key Identifier
    Find Value
    The value used with selected Find Type to locate the certificate.
    From
    The claim returned by the identity provider that is used as the source value for user mapping.
    To
    The login field to which the selected claim is mapped.
  4. Click OK.
Note: The changes to these options take effect only after the API is restarted.