Onboard Organisations
Onboard Organisations within the Centralized Directory of your ecosystem.
There are three main steps involved when onboarding an organisation to Connect:
-
Include the Organisation in the Connect's Centralized Directory.
-
Set the Domains and the Roles that this Trust Framework Participant is allowed to have.
-
Delegate organisation management to an Organisation Administrator.
Organisations can be onboarded in two ways:
-
Adding organisations using the platform's UI - recommended if you have a small number of institutions to add or small changes to be made.
-
Adding organisations using the platform's APIs - add or update a **large number of organisations **programmatically.
Prerequisites
- Super User or a Data Administrator access to the platform
Onboard Organisation Using UI
Adding or updating organisations using the Platform UI is recommended if you have a small number of institutions to add or small changes to be made.
-
Create an Organisation.
-
Select the Organisations button in the top navigation and + New Organisation.
-
Fill in the necessary details and save.
-
-
Set an Authority for the newly created organisation.
-
Set the Domains for the organisation.
-
Set the organisation's Roles.
Onboard Organisation Using APIs
-
Get an Access Token.
The access token enables you to authenticate your client application with the Raidiam's authorisation server.
Use the issued access token in all of the subsequent requests while onboarding an organisation to the Directory.
-
Create an organisation using the POST /organisations endpoint.
-
Set a Domain for the organisation using the POST /organisations/OrganisationId/authoritydomainclaims endpoint.
-
Set a Role for the organisation using the POST/organisations/OrganisationId/authorityclaims endpoint.
It's possible to integrate the Directory Platform with an external data source, leveraging the Platform's APIs
If you wish this integration to be commissioned by Raidiam please Raise a JIRA Service Ticket with the technical documentation of this External Data Source so this can be evaluated by the Raidiam Product Team.