Versions Compared

Key

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

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

Info

Currently, it is not possible to create internal role accounts through the API. An administrator must sign in to the console and create a role account there.


Functions available for internal role accounts:

Table of Contents
maxLevel2
minLevel2


Retrieve internal role account

Steps

  1. Submit a request as per the in accordance with the details in Get internal role account.
  2. Lequinox platform retrieves the organisation to which the requesting application belongs to.
  3. Lequinox platform retrieves the internal role account corresponding to the role account Id which is part of the URI schema.
  4. Internal role account is returned.


Plantuml


Error messages *

Expand
title


HTTP status codeMessageComments
400Invalid role ID format

This error message is returned when the role account ID on the path section of the URL is incorrectly formatted. This error is not related to a role and its ID as falsely claimed by the message.

400Role account not found!

400

The role account ID '%1' does not match the company ID '%2'.

%1 is the role account ID specified via the URL.
%2 is the company ID associated with the submitted application key.