Skip to main content

Claims sources configuration

Sovrin API allows configuring your tenant to fetch claims directly from a compatible claims source and use these claims when issuing credentials. Refer to our Learn tutorials for more information and example configurations.

Access the Claims sources screen by selecting Claims sources from the navigation panel on the left-hand side of the self service portal.

The Claims sources screen enables managing claims sources configured on your tenant:

  • Configure a new Claims Source

  • Update an existing Claims Source

  • Delete an existing Claims Source

Configure claims source​

Perform the following steps to configure a new claims source:

  1. Select Claims sources from the navigation panel on the left-hand side.

The Claims sources screen is displayed, listing all existing claims sources.

  1. Select the CREATE NEW button.

The New claim source form is displayed.

  1. the Name text box to insert a meaningful name for the new claims source.

  2. Use the URL text box to insert the URL of the new claims source.

Important:

  1. The URL must use https and have a valid public top-level domain.

  2. The URL must not contain query parameters. All port and fragment parameters will be dropped.

  3. Unicode will be converted to ASCII.

  4. Use the Authorisation type radio button to select between API key or OAuth client credential.

  5. If API key was selected, use the API key text box to insert your API key.

  6. If OAuth client credential was selected:

a. Use the Client ID text box to insert your client ID for the new claims source token endpoint URL.

b. Use the Client secret text box to insert your client secret for the new claims source token endpoint URL.

c. Use theToken endpoint text box to insert the authentication token endpoint URL for the new claims source.

d. Use the Token endpoint authentication method radio button to select between Client secret basic (your credentials are passed as a base 64 encoded basic token) and Client secret post (your credentials are passed as a request body parameter).

e. Use the optional Audience text box to insert your claims source audience if it is provided by its provider.

  1. Use the Request method radio button to select between GET and POST.

  2. Use the Request parameters text box to map claims to query parameters in the request.

Each parameter must include a mapFrom and/or defaultValue.

Select the LOAD EXAMPLE button to load an example mapping into the text box.

  1. Select the CREATE button to create the new claims source.

Update claims source​

Perform the following steps to update an existing claims source:

  1. Select Claims sources from the navigation panel on the left-hand side.

The Claims sources screen is displayed, listing all existing claims sources.

  1. Select the claims source you wish to update.

The Claims source detail form is displayed.

  1. Perform any required updates.

  2. Select the SAVE button at the bottom of the form to apply your changes.

Delete claims source​

tip

Deleting a claims source is permanent and cannot be reversed.

Perform the following steps to delete an existing claims source:

  1. Select Claims sources from the navigation panel on the left-hand side.

The Claims sources screen is displayed, listing all existing claims sources.

  1. Select the claims source you wish to delete.

The Claims source detail form is displayed.

  1. Select the DELETE button on the bottom part of the form.

The Delete claims source window is displayed.

  1. Select YES, DELETE to delete the claims source.