Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

Version 1 Current »

Functions available for external roles:


Create external role

Steps

  1. Submit a request in accordance with the details in Create external role.

  2. The platform validates the request by verifying, among other things:

    1. that the role name is unique in the organisation.

  3. The platform creates the validated external role.

  4. The platform returns the created ExternalRole.


Update external role

Steps

  1. Submit a request in accordance with the details in Update external role.

  2. The platform validates the request by verifying, among other things:

    1. that the role belongs to the organisation associated with the application key.

    2. that the role name is unique within the organisation.

  3. The platform updates the validated external role.

  4. The platform returns the updated ExternalRole.


Get external role

Steps

  1. Submit a request in accordance with the details in Get external role.

  2. The platform validates the request.

  3. The platform retrieves the external role.

  4. The platform returns the ExternalRole.


Get list of external roles

Steps

  1. Submit a request in accordance with the details in Get external roles.

  2. The platform validates the request.

  3. The platform retrieves all external roles that belong to the organisation.

  4. The platform returns a list of ExternalRoles.


  • No labels