Skip to main content
User Management

Read admin profile

GET/v4/onboard/platform/admin

Returns the profile of the admin who makes the call: the signed-in admin of an admin token, or the admin that the API key acts for (the first admin of the organisation, which is not always the admin who created the key). Use it for an account or profile page. The answer is the profile itself, with no wrapper member.

Authorizations

  • Authorizationstringheaderrequired

    Your API key with the prefix ApiKey: ApiKey <your-api-key>. Get an API key.

    Scope:admin-profile:read

Response

application/json

The profile of the admin.

  • idstring

    The id of the admin.

  • emailstring

    The email address with which the admin signs in.

  • namestring

    The display name of the admin.

  • phonestring

    The phone number of the admin. An empty string when not set.

  • avatarImageIdstring

    The id of the avatar image. An empty string when the admin has no avatar image; then Read admin avatar image gives a default image.

  • avatarImageUrlstring

    The URL that the service stored at the last avatar upload (https://{api host}/onboard/admin/avatarimage), or an empty string when the admin has no avatar image. No route of the API answers on this URL: get the image with Read admin avatar image.

  • externalIdstring

    The id of the admin in an external system. An empty string when not set.

  • identityProviderIdstring

    The id of the external identity provider with which the admin signs in. An empty string when the admin signs in to the platform directly.

  • lastSignInstring

    When the admin last signed in (RFC 3339, UTC). An empty string when the admin has not signed in since the platform started to record it.

  • apiKeystringdeprecated

    Not in use: an empty string. Manage the API keys in the dashboard under Account > Developer APIs.

  • roleIdinteger

    The role of the admin in the organisation: 1 Admin, 2 Dpo, 3 Developer, 4 SuperAdmin, 5 NormalAdmin.

  • roleNamestring

    The name of the role of roleId, for example SuperAdmin.

  • organizationNamestring

    The name of the organisation.