Versions Compared

Old Version 1

changes.mady.by.user Technical writer

Saved on

compared with

New Version Current

changes.mady.by.user Technical writer

Saved on

Key

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

Functions available for external roles:

Table of Contents
maxLevel2
minLevel2

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.

Plantumlcloud
toolbarbottom
filenamePlantUML Diagram 1.svg
originalHeight245
datanVRdb4IwFP01ZE8spejiKwJmD2whc++m0os2lpaV4sx+/W6t8wM1W0YJIafnnnvuvYVgRDrLjO0bGZDk4R2aVjILQZwElIwXdEEcnB0hXHEYRSF1eLcRqmWGNbjBoWa9tDOt7CtrAJFnkFuwomID5hw+elAVvEDXsRUkUqwUwhUoC2bAfdO94qk2CncoicaD7RKdi0q0TNmpNhxMqqV2zKVk1WaYd824/hRqhe81kx1ciXHud4dpZlqjNVfaj35AY7K/7jLn4ss1IaLIGJC6QwMeC1FDIRRM0ezK+FKP+jBx69fQi7LPbeG9Ftx5qNHUUu881p5atg+gSdtKHJIVGqdAEWMdPoo88XopySYZvRVYoBehUJcSd2ZqbZpzgfIQ/5TlefrnePR4rhH9T2R6IUIHIqfO9EoKtQHuQVZZsXUn3ZdPEt+EMIhzX9D+C0gNeA7scNSKSXw1WsJAoHTx5XV4CcaZdM62TAq+b3x3h+xzOa5d3055mFOchuFZXH7F43BV3SXk/AYjAorjr+Ab
compressedtrue
originalWidth369
revision3

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.

Plantumlcloud
toolbarbottom
filenamePlantUML Diagram 2.svg
originalHeight245
datanVRdb4IwFP01ZE8spejiK4JmD24hc3s2Hb1gY2lZKc7s1+/WOj9As2WUEHJ6zum5t4VgRFrLjO1qGZDk7hXqRjILQZwElIxXdEUcnB0hHHEYRSF1eLsRqmGG1TjBoWSdtHOt7DOrAZFHkFuwomA95hI+OlAFPEHbsgoSKSqFcAHKgulxX3SneKqNwhlKonFvOsfkohANU3aqDQeTaqkd812yYtNfd824/hSqwveSyRYGZpz72f4yc60xmivtxz+gMdlfN5lL8eWaEFFk9EjtoQH3C1HCQiiYYtjK+FKP/jBx41fpRdnnsfBeC+4ylBjqXe881pxathfQpGkkbpIVGneBIsZafCxmifdLSTbJ6DXhArMIhb6UuDNTalOfG+QH/UM2m6V/1mPGc4/ofybTCxPaMzl1plNSqA1wD7LCiq076b58kvgmhEE88wXtv4C3hnsO7HCrFZP4arSEnkHu9PlQnoNxIV2yLZOC7xvf3iD7tRzXrq8vedinOA3DgY5fVXAY1HkJueTBiIDi+FP4Bg==
compressedtrue
originalWidth387
revision3

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.

Plantumlcloud
toolbarbottom
filenamePlantUML Diagram 3.svg
originalHeight245
datanVRdb4IwFP01ZE8spejiKyJuD24hundT6UUbS8va4sx+/W7F+QGaLaOEkNN7zj333kIwINYx45pKBiR5eIeqlsxBECcBJcMlXRIPT04QrjiMopB63G6FqplhFW5wKFkj3VQr98YqQOQF5A6cKFgncgEfDagCXsFatoZEirVCuADlwHRi57pRPNVG4Q4l0bCznaNzUYiaKTfWhoNJtdQ+ciVZse3m3TCuP4Va43vJpIWeGOftbjfNVGu05kv70Q9oTA7X3ciF+PJNiChGdILssQGPM1HCTCgYo9m1aUs96cPIr1+pV2Vf2sJ7I7j3UKKpld63WH1u2YFAk7qWOCQnNE6BIsYsPmZZ0uqlZDKa0FvEGXoRCnUp8Wem1Ka6FMiP/KdJlqV/5qPHS43ofyLjKxHaETl3plFSqC3wFmSFEzt/0tvySdI2IQzirC3o8AU8g08Ne5yzYhJfjZbQYeeenPe5ORjv0NvaMSn4oev2TvAcnBGwA3sz3XFAcRqGF5ysF8ehV9Y15L0GAwKK4z/gGw==
compressedtrue
originalWidth340
revision3

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.

Plantumlcloud
toolbarbottom
filenamePlantUML Diagram 4.svg
originalHeight245
datanVRRT4MwEP41xCdMKWp8ZWzqAxqivptKD3ZZabEt0/jrva5ONzajkZKm+Xrfd99dC8kZc15YP/YqYcXJI/SDEh6SvEg4O3/iTyzA8y+IRp5mWcoD7laoB2FFTxsSWjEqf2W0vxM9EHIDag0eGzGJfICXEXQDt+Cc6KBQ2GmCG9Ae7CT23oxalsZq2uEsO59s1+QcGxyE9jNjJdjSKBMin5VoVtO8SyHNK+qO1q1QDg7EpIy70zRXxpC1UNpWP+E52zw/Rj7ge2hCxiliEuQ+G3BaYQsVapiR2c7GUr/04TKMX6l7Ze/aoneJMnhoydSzeYvY8N2yDYEXw6DokDwaOgVOmHA0VYsi6pVsfjnnx4gVeUFNupyFO9Ma2+8K1J/8i/liUf6ZTx53NbL/icz2RPhE5Lszo1aoVyAjKBqP63DTY/msiE1Ik3wRC9p8AdcQUsMbnbMWipbWKHATeh3Y9SG5BhssBl9roVBu2u5+CL4HbxHW4I7l48y0NPllyGdsJzS6eIhb30lepumOXIXOb2lH7Es4qH8fCjUlZwy0pJ/FBw==
compressedtrue
originalWidth485
revision3