Super admins and platform admins

Disable or enable super admin

PUT/v4/onboard/platform/operator/super-admin/{adminId}/status

Disables (disabled) or enables (active) the account of a super admin. A request for the state that the account has changes nothing and gets the same answer. The API refuses to disable the only super admin of an organisation that is not disabled, and the only platform admin that is not disabled.

Language of the request sample

curl -X PUT 'https://demo-api.igrant.io/v4/onboard/platform/operator/super-admin/6731f1d8a1b2c3d4e5f6078a/status' \
  -H 'Authorization: Bearer <access-token>' \
  -H 'Content-Type: application/json' \
  -d '{
  "status": "disabled"
}'

{
  "superAdmin": {
    "id": "6731f1d8a1b2c3d4e5f6078a",
    "email": "[email protected]",
    "name": "Jane Doe",
    "roleName": "SuperAdmin",
    "organisation": {
      "id": "6731f0c2a1b2c3d4e5f60789",
      "name": "Acme Bank"
    },
    "status": "disabled",
    "lastSignIn": "2026-11-12T09:30:00Z",
    "platformAdmin": null
  }
}

Authorizations

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

Path parameters

adminIdstringrequired
The ID of a super admin of an organisation, from List super admins.
At most 256 characters.
Example:"6731f1d8a1b2c3d4e5f6078a"

Body

application/json

statusenum<string>required
disabled disables the account; active enables it.
Available options:disabled,active
Example:"disabled"

Response

application/json

The account after the change.

superAdminobject
An admin account as a platform admin sees it.