Sign in
SSOReadyService

Exchanges a SAML access code for details about your user's SAML login details.

post/v1/saml/redeem

Request body

samlAccessCodestring

The SAML access code to redeem.

Response

OK

emailstring

The user's email address.

statestring

The state you provided when getting a SAML initiation URL, if any.

If your user logged in to your product using Identity Provider-initiated SAML (e.g. they clicked on your app inside their corporate Okta dashboard), then state will be empty.

SSOReady validates the authenticity of non-empty state values. You do not need to implement your own CSRF on top of it, but doing so anyway will have no bad consequences.

attributesobject

Arbitrary key-value pairs the Identity Provider included about the user.

Typically, these attributes are used to pass along the user's first/last name, or whether they should be considered an admin within their company.

organizationIdstring

The ID of the organization this user belongs to.

organizationExternalIdstring

The externalId, if any, of the organization this user belongs to.

samlFlowIdstring

A unique identifier of this particular SAML login. It is not a secret. You can safely log it.

SSOReady maintains an audit log of every SAML login. Use this SAML flow ID to find this login in the audit logs.

Changes

Changed in 1 of the 7 revisions of this API.2

  • 516b78b641b82See the full diff
    • ○

      api operation id RedeemSAMLAccessCode removed and replaced with SSOReadyService_RedeemSAMLAccessCode

      api-operation-id-removed

    • ○

      api tag saml removed

      api-tag-removed