Skip to main content

Onboard Organisations

Onboard Organisations within the Centralized Directory of your ecosystem.

There are three main steps involved when onboarding an organisation to Connect

  • when using the UI, these run as a single guided wizard flow:

  1. Include the Organisation in the Connect's Centralized Directory.

  2. Delegate organisation management to an Organisation Administrator.

  3. Assign the Domains and the Roles that this Trust Framework Participant is allowed to have.

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.

Onboarding runs as a single guided wizard, launched from one + New Organisation button - there is no need to visit separate pages for each step:

  1. Select the Organisations button in the top navigation and + New Organisation.

  2. Complete the Organisation step of the wizard, filling in the organisation's business details and saving to create the Organisation.

  3. Complete the Organisation Administrator step of the wizard to delegate organisation management to an Organisation Administrator.

  4. Complete the Domains & Roles step of the wizard to set the Domains and Roles that this Trust Framework Participant is allowed to have.

Configuring the organisation as an Authority is not part of this wizard - it is configured separately from the organisation's Authorities tab once the organisation has been created.

Onboard Organisation Using APIs​

  1. 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.

  2. Create an organisation using the POST /organisations endpoint.

  3. Set a Domain for the organisation using the POST /organisations/OrganisationId/authoritydomainclaims endpoint.

  4. Set a Role for the organisation using the POST/organisations/OrganisationId/authorityclaims endpoint.

  5. Delegate Organisation Administration.

note

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.

Next Steps​

  1. Delegate Organisation Administration.
  2. Assign Domains.
  3. Assign Roles to Organisations.
Open Book IconTABLE OF CONTENT