Read platform operator information
Tells whether the organisation of the caller is the platform operator organisation, whether the caller is a platform admin, and whether the installation has an e-mail service. Every admin can call it with the access token of their login. The dashboard reads it to show or hide the functions of a platform admin. See the [Platform Admin Guide](/docs/platform-admin-guide/).
List organisations of the installation
Lists the organisations of the installation, newest first, with the numbers of all organisations in each state. The platform operator organisation is in the list. All filters must match. The member `statistics` counts all organisations, without the filters.
Add organisation
Adds an organisation to the installation, with its first admin and its organisation wallet. The first admin becomes the super admin of the organisation and gets access by an invitation e-mail or a one-time password (`access`). A new organisation has only the feature Issuer & Verifier on; `configuredFeatures` sets the features that differ.
Read organisation of the installation
Reads one organisation of the installation, as a platform admin sees it.
Delete organisation
Starts the deletion of a suspended organisation. The deletion cannot be undone. The organisation gets the state `deleting`, and the API deletes its data of the organisation in steps: the sessions, the admins, the API keys, the data verifier users, the webhooks, the identity providers, the extension instances, the OpenID provider tenants, the sandbox organisations, the tickets, the individuals and the images. After the answer, the consent service purges its data of the organisation, and the organisation wallet deactivates the wallet of the organisation and purges it after its grace period. See [Deletion](/docs/platform-admin-guide/#deletion).
Read organisation features
Reads the features of an organisation: the four product features and the feature preview. See [Organisation features](/docs/platform-admin-guide/#organisation-features).
Update organisation features
Turns features of an organisation on or off. Send only the features that you change; a missing member keeps its value. A removed feature of an earlier release (`gettingStarted`, `dataAgreements`, `managedData`, `privacyDashboard`, `account`, `actionLogs`, `webhooks`, `files` or `sandbox`) gets `400` with a text that names it. When a feature is off, the API refuses its operations for the organisation with `403` and `errorKey` `feature_disabled`. A change is written in the Activity Logs of the platform operator organisation.
Suspend or resume organisation
Suspends (`suspended`) or resumes (`active`) an organisation. A suspension can be undone: the data, the keys and the wallet units of the organisation stay, and no credential is revoked. While the organisation is suspended, each call with its API keys or the logins of its admins gets `401` with `errorKey` `organisation_suspended`, and its organisation wallet refuses its operations; the status lists, the issuer metadata and the JWKS stay available. See [Suspension](/docs/platform-admin-guide/#suspension).
Send organisation invitation again
Sends the invitation e-mail again: to the super admin `adminId` of the organisation, or, without a body, to each super admin of the organisation with a pending invitation.
Deploy organisation wallet
Deploys the organisation wallet of an organisation whose deployment failed when it was added (`wallet.deploymentStatus` is not `deployed`). The body is empty. The new wallet is never the wallet provider: only the wallet of the platform operator organisation is.
Add organisation type
Adds an organisation type, which an organisation names with `organisation.typeId` in [Add organisation](/docs/openid4vc-api/onboard-operator-create-organisation). The spaces at the ends of the name are removed. An installation has at most 200 organisation types.