Organisations

Update organisation features

PUT/v4/onboard/platform/operator/organisation/{organisationId}/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.

Language of the request sample

curl -X PUT 'https://demo-api.igrant.io/v4/onboard/platform/operator/organisation/6731f0c2a1b2c3d4e5f60789/features' \
  -H 'Authorization: Bearer <access-token>' \
  -H 'Content-Type: application/json' \
  -d '{
  "walletUnit": true,
  "consentManagement": true
}'

{
  "configuredFeatures": {
    "issuerVerifier": true,
    "walletUnit": true,
    "consentManagement": true,
    "dataDisclosureAgreements": false,
    "apiKeyScopesUi": false
  }
}

Authorizations

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

Path parameters

organisationIdstringrequired
The ID of the organisation, from List organisations of the installation.
At most 256 characters.
Example:"6731f0c2a1b2c3d4e5f60789"

Body

application/json

issuerVerifierboolean
Issuer & Verifier.
Example:true
walletUnitboolean
Wallet Unit (Holder).
Example:true
consentManagementboolean
Consent Management.
Example:true
dataDisclosureAgreementsboolean
Data Marketplace.
Example:false
apiKeyScopesUiboolean
The feature preview of the scope picker of the new API key scopes.
Example:false

Response

application/json

The features of the organisation after the change.

configuredFeaturesobject
The features of an organisation. The four product features decide which parts of the platform the organisation can use: when one is off, the API refuses its operations for the organisation with 403 and errorKey feature_disabled. Getting Started, Account, Webhooks and Activity Logs have no feature and are always on. See Organisation features.