Read admin profile
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
AuthorizationstringheaderrequiredYour API key with the prefix
ApiKey:ApiKey <your-api-key>. Get an API key.Scope:
admin-profile:read
Response
The profile of the admin.
idstringThe id of the admin.
emailstringThe email address with which the admin signs in.
namestringThe display name of the admin.
phonestringThe phone number of the admin. An empty string when not set.
avatarImage Id stringThe id of the avatar image. An empty string when the admin has no avatar image; then Read admin avatar image gives a default image.
avatarImage Url stringThe 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.externalId stringThe id of the admin in an external system. An empty string when not set.
identityProvider Id stringThe id of the external identity provider with which the admin signs in. An empty string when the admin signs in to the platform directly.
lastSign In stringWhen 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.
apiKey stringdeprecatedNot in use: an empty string. Manage the API keys in the dashboard under Account > Developer APIs.
roleId integerThe role of the admin in the organisation:
1Admin,2Dpo,3Developer,4SuperAdmin,5NormalAdmin.roleName stringThe name of the role of
roleId, for exampleSuperAdmin.organizationName stringThe name of the organisation.