Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Internal roles are intended for users in the owner's organisation.

Info

Currently, it is not possible to create internal roles through the API. An administrator must sign in to the Lequinox console and create an internal role there, but you can still list available internal roles via the API.

 

Functions available for internal roles:

Table of Contents
maxLevel2
minLevel2


Get internal role

Steps

  1. Submit a request in accordance with the details in Get internal role.
  2. The platform retrieves the organisation to which the requesting application belongs.
  3. The platform validates the request.
  4. The platform retrieves the internal role corresponding to the role ID which is part of the URI schema.Internal role is
  5. returnedThe platform returns the internal role.


Plantuml




Get list of internal roles

Steps

  1. Submit a request in accordance with the details in Get internal roles.
  2. The platform retrieves the organisation to which the requesting application belongs.
  3. The platform validates the request.
  4. The platform retrieves internal roles of the organisation.
  5. The list of internal roles is returned.


Plantuml