Organisations

Read platform operator information

GET/v4/onboard/platform/operator

Tells whether the organisation of the caller is the platform operator organisation, whether the caller is a platform admin, and whether the installation has an e-mail service. Every admin can call it with the access token of their login. The dashboard reads it to show or hide the functions of a platform admin. See the Platform Admin Guide.

Language of the request sample

curl 'https://demo-api.igrant.io/v4/onboard/platform/operator' \
  -H 'Authorization: Bearer <access-token>'

{
  "isPlatformOperatorOrganisation": true,
  "isPlatformAdmin": true,
  "emailEnabled": true
}

Authorizations

Authorizationstringheaderrequired
An access token: Bearer <access-token>.

Response

application/json

The platform operator information of the caller.

isPlatformOperatorOrganisationboolean
The organisation of the caller is the platform operator organisation.
Example:true
isPlatformAdminboolean
The caller is a platform admin.
Example:true
emailEnabledboolean
The installation has an e-mail service. Without it, invitations and password resets cannot be sent: use a one-time password.
Example:true