Sign in
SSO

Generate SSO Link

This endpoint generates a single sign on link that authorizes the recipient on their credential.

The code expires after used once.

post/v1/sso/generate_link

Request body

credential_idstring

The unique ID of the credential. If you supply your own internal ID as a license_id, you should use that.

recipient_idstring

The recipient's user ID as defined by your organization. If more than one credential exists for your organization for this student, we give the link to their last (most recent) credential.

recipient_emailstring

The recipient's email address. If more than one credential exists in your organization for this student, we give a link to their last (most recent) credential.

wallet_viewboolean

If multiple credentials belonging to the recipient requested for this organization and the wallet view flag is set true, we provide a link to the recipients credential wallet.

group_idstring

The group that a credential belongs to. If more than one credential exists for your group for this student, we give the link to their last (most recent) credential.

redirect_tostring

If the code is wrong, we will redirect student back to this link by default we use your registered url.

embedboolean

If the embed flag is set to true, we provide a link to the recipient's credential wallet embed page. This is only supported with wallet view.

Response

OK

linkstring

Changes

Changed in 1 of the 30 revisions of this API.23

  • db5960c9410923See the full diff
    • ●

      deleted the header request parameter Authorization

      request-parameter-removed

    • ●

      removed the request property credential_id (string optional) - The unique ID of the credential. If you supply your own internal ID as a license_id you should use that.

      request-property-removed

    • ○

      api operation id Generating Link removed and replaced with Generate SSO Link

      api-operation-id-removed

    • ○

      the endpoint scheme security ApiKeyAuth was added to the API

      api-security-added

    • ○

      added the new optional request property credential_id

      new-optional-request-property

    This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog