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

 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.The platform
  1. validates the request.

  2. The platform retrieves the internal role corresponding to the role ID

which is part of the URI schema
  1. in the request.

  2. The platform returns the internal role.

plantuml

Plantumlcloud
toolbarbottom
filenamePlantUML Diagram 1.svg
originalHeight245
datanVRdb4IwFP01ZE8spejiK6JuS9xCdO+m0oveWFpWilv263crzg/UbBklhJyec3rubSHosdoJ65pSBSy5e4OyUsJBECcBZ/0FXzAPjw4QjTiMopB7vN6groQVJU1IKESj3MRo9ypKIOQJ1BYc5qLDnMN7AzqHF6hrsYJE4UoTnIN2YDvcmWm0TI3VNMNZ1O9MZ5Qcc6yEdkNjJdjUKOOZSyXyTXfdtZDmA/WK3guhargwk7Kd7S4zMYai+dJ+/AMes911kznHL9+EiBOjQ6r3DbifYgFT1DCksCvblnrwh4Efv0rPyj6NRfcapc9QUKil+Wyx6tiynYAnVaVokxwa2gVOmKjpMR0nrV/KRoMRvyacUhbU5MuZPzOFseWpQbbXP4zG4/TPesp46hH9z2R4ZsI7JsfONFqh3oBsQZE73PqT3pbPkrYJYRCP24J2X8Aj+KXRH1YtFL1ao6Cjzrw4u9RmYH1CH2srFMpd1+sb5Bk4i7AFz3ZruLrofpviNAxPlM8XPAkXxZ1DPnHQY6Al/Qm+AQ==
compressedtrue
originalWidth354
revision7


Get list of internal roles

Steps

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

.The platform retrieves the organisation to which the requesting application belongs
  1. .

  2. The platform validates the request.

  3. The platform retrieves the internal roles of the organisation.

  4. The platform returns a list of internal roles

 is returned.
plantuml
  1. .

Plantumlcloud
toolbarbottom
filenamePlantUML Diagram 2.svg
originalHeight245
datanVRRb5swEP41aE9MxrRTXwlJtwc2oXbv1RUf5BRjM9tk0379znHTJiTVpmFkWZ/v++67syG7ET6AC/OoM1F9+I7jpCFgVlaZFLdP8klEeP0K8SjzoshlxP2OzAQORt5Q2MOsw7014RuMyMgX1HsM1MEi8hF/zGg6/Irew4CVpsEw3KEJ6BaxD3Y2qrbO8I4Uxe1iu2Xn1NEEJqysU+hqq22MfNbQ7ZZ5t6DsTzIDr3vQHi/ElEq7yzT31rK1WNpRP5OlODzvRj7S79iEQnLEIsi/NOBjQz02ZHDFZgeXSn3Vx7s4/ko9K/vUFr9bUtFDz6ae7a+ETW8tOxBkNU2aDymQ5VOQjIHnqdlUSa8W67u1vEZs2AsZ1pUi3pneuvFUoH3hf1pvNvU/89njqUbxfyKrMxG5EHnrzGw0mR2qBEIXaB9veipfVKkJeVZuUkGHL+AzxtQUL6sBzUtnNfoFvY3s9pLcoosWo689aFKHtvt3gh8wOMI9+mv5pLA9T2Eb81k3gCGfDvHoOyvrPD+Ra8iHI+2KfYUX9Z9DsabsRqBR/LP4Aw==
compressedtrue
originalWidth477
revision3