Update admin profile

PUT 
/v2/onboard/admin

Updates the name of the admin that the API key belongs to. name is mandatory and is the only field that changes. The other profile fields are accepted and ignored, and an unknown field gives HTTP 400.

Request

application/json

Body

required

organisationAdmin objectrequired

The profile fields to update.

name stringrequired

The new name of the admin.

Responses

200

The service updated the profile of the admin.

application/json

Schema

Schema

organisationAdmin object

The admin after the profile update.

id string

The identifier of the admin.

email string

The e-mail address of the admin.

name string

The name of the admin.

avatarImageId string

The identifier of the avatar image.

avatarImageUrl string

The URL of the avatar image.

lastVisited string

The date and time of the last login of the admin.

roleId integer

The role identifier of the admin in the organisation.

roleName string

The role name of the admin in the organisation.

Example (from schema)

{
  "organisationAdmin": {
    "id": "6a1f0c2e9b3d4e5f6a7b8c9d",
    "email": "[email protected]",
    "name": "Jane Doe",
    "avatarImageId": "6a1f0c2e9b3d4e5f6a7b8c9e",
    "avatarImageUrl": "https://demo-api.igrant.io/onboard/admin/avatarimage",
    "lastVisited": "2026-10-27T09:12:44Z",
    "roleId": 1,
    "roleName": "Admin"
  }
}

400

Bad request

Response Headers

application/json

Schema

Schema

errorCode integerrequired
errorDescription stringrequired

Example (from schema)

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

401

Unauthorized

Response Headers

application/json

Schema

Schema

errorCode integerrequired
errorDescription stringrequired

Example (from schema)

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

404

The organisation or the admin is not found.

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...