Trust Provider Management¶
Trust Providers are authoritative sources that can respond to requests to pass onboarding rules as well as provide Data Bundles.
The list of all available Trust Providers can be accessed by clicking [Trust Providers] under the [Tenants] tab of the sidebar.
Viewing All Trust Providers¶
The initial Trust Providers page displays a list of all of the Trust Providers that have been created for your instance of CitizenOne.
From this page, you are able to filter the displayed list of Trust Providers by their name, click on a Trust Provider in the list for a more detailed view, or create a new Trust Provider.
If you have only been granted “READ” access to Trust Providers, you will not be able to create new Trust Providers, nor will you be able to modify existing Trust Providers.
Creating Trust Providers¶
When you’ve determined that a new Trust Provider is needed, you can click the [+ Create] button in the top right of the Trust Providers listing page.
This will bring you to a new view where you will be asked to fill out only the vital information needed to create the Trust Provider. Any fields not seen here will be configurable after the Trust Provider has successfully been created.
The general fields for a Trust Provider are:
Name: The name of the trust provider
Description: The optional description of the trust provider
Level of Assurance: The level of assurance this trust provider provides (https://www.tbs-sct.gc.ca/pol/doc-eng.aspx?id=30678§ion=html)
Clicking the [Cancel] button will not save any changes you made to the form, and you will be taken back to the Trust Provider listing page.
Clicking the [Create] button will then attempt to make a new Trust Provider, and you will be taken to the new Trust Provider’s details page.
Viewing and Editing a Trust Provider¶
When you click on or create a Trust Provider, you will be taken to a view with multiple tabs. Each tab contains information that you can fill out to help define and customize your Trust Provider.
Clicking on these tabs changes the view so if you are editing any forms on a page, ensure that you save any changes, or they will be lost on navigation.
Trust Providers General Tab¶
The General tab of a Trust Provider contains the basic details that define the Trust Provider itself.
The general fields for a Trust Provider are:
Name: The name of the trust provider
Description: The optional description of the trust provider
Level of Assurance: The level of assurance this trust provider provides (https://www.tbs-sct.gc.ca/pol/doc-eng.aspx?id=30678§ion=html)
Clicking the [Edit] button will enable the fields in the view for change. Ensure your changes are saved before navigating away from the page.
Trust Providers Onbaording Tab¶
The Onboarding tab of a Trust Provider specifies how CitizenOne connects to a Trust Provider to onboard a citizen.
The onboarding fields for a Trust Provider are:
Base Url: The base url for onboarding to the Trust Provider
Onboarding Path: The api path for sending the onboarding data from the form
Onboarding Form: The NoCode form for onboarding
Arguments (e.g., Argument 1, Argument 2) - Arguments to send to the onboarding form
Note: To add more arguments you can click the [+ Add Argument] button below the last argument.
Clicking the [Edit] button will enable the fields in the view for change. Ensure your changes are saved before navigating away from the page.
Trust Providers Rules Tab¶
The Rules tab of a Trust Provider specifies the Rules that this Trust Provider can fullfill.
You can assign Rules to a Trust Provider by selecting a Rule from the dropdown and entering a description.
Note: To add more Rules you can click the [+ Add Rule] button below the last rule.
Clicking the [Edit] button will enable the fields in the view for change. Ensure your changes are saved before navigating away from the page.
Trust Providers Providing Bundles Tab¶
The Providing Bundles tab of a Trust Provider specifies the Data Bundles that this Trust Provider can publish to subscribing services.
Notes:
If you would like to publish changes about your users, such as when their address or email changes, add those here.
Data Bundles are encrypted if public key is provided on the policy.
A more technical description can be found here: Data Bundles.
The data bundle fields for a Trust Provider are:
Data Bundle Type: The type of updates to push to clients. Subscribing services will reference this type.
Notify Url: The url (must be https) to push data bundles to.
Notes:
Clicking the [Eye] button will present you with the schema of the data bundle or allow you to define it if it hasn’t been defined yet.
The notifiy url must be of type HTTPS.
Currently you can only add one bundle for a particular type.
Clicking the [Edit] button will enable the fields in the view for change. Ensure your changes are saved before navigating away from the page.
Removing a Trust Provider¶
When you are on the General tab, click the [Edit] button.
Clicking the [Delete Provider] button will remove the Trust Provider from CitizenOne. When deleting a Trust Provider you must accept a confirmation asking whether you want to delete the Trust Provider.