Read admin profile

GET 
/v2/onboard/admin

Reads the profile of the admin that owns the access token. The dashboard uses this operation on the Manage User page and after login.

Responses

200

The profile of the admin.

application/json

Schema

Schema

organisationAdmin object

id string

email string

Email

name stringrequired

Name

avatarImageId string

Avatar image ID

avatarImageUrl string

Avatar image Url

lastVisited string

Last visited date time

roleId integer

Role ID

roleName string

Role name

phone string

Admin's phone number

imageId string

Unique identifier for the admin's image

imageUrl string

URL to the admin's image

externalId string

External identifier for the admin

identityProviderId string

Identity provider ID

organizationId string

Unique identifier for the organization

organizationName string

Name of the organization

Example (from schema)

{
  "organisationAdmin": {
    "id": "",
    "email": "string",
    "name": "string",
    "avatarImageId": "string",
    "avatarImageUrl": "string",
    "lastVisited": "string",
    "roleId": 0,
    "roleName": "string",
    "phone": "string",
    "imageId": "string",
    "imageUrl": "string",
    "externalId": "string",
    "identityProviderId": "string",
    "organizationId": "string",
    "organizationName": "string"
  }
}

401

Unauthorized

Response Headers

application/json

Schema

Schema

errorCode integerrequired
errorDescription stringrequired

Example (from schema)

{
  "errorCode": 400,
  "errorDescription": "Bad input parameter"
}

500

Internal server error

Response Headers

application/json

Schema

Schema

errorCode integerrequired
errorDescription stringrequired

Example (from schema)

{
  "errorCode": 400,
  "errorDescription": "Bad input parameter"
}

Loading...