Organisation

Update organisation

PUT/v4/onboard/platform/organisation

Changes the profile of the organisation of the API key or token: the name, the location, the description and the privacy policy URL. Send only the members that you change: an empty or missing member keeps its stored value, so you cannot clear a value with this operation. A new policyUrl must be an absolute http:// or https:// URL. The organisation wallet and the consent service get the change a moment after the response.

The response has the same members as Read organisation, but only id, name, description, sector, location, policyUrl and authentication have their values. The other members are empty strings, false, 0 or objects with such values: read the organisation again for the full record.

Update organisation

Language of the request sample

curl -X PUT 'https://demo-api.igrant.io/v4/onboard/platform/organisation' \
  -H 'Authorization: ApiKey <your-api-key>' \
  -H 'Content-Type: application/json' \
  -d '{
  "description": "Retail bank that issues and verifies payment credentials.",
  "policyUrl": "https://acme-bank.example.com/privacy"
}'

{
  "organisation": {
    "id": "6ae2bf741c3dadfeb27982ec",
    "name": "Acme Bank",
    "description": "Retail bank that issues and verifies payment credentials.",
    "sector": "Banking",
    "location": "Stockholm, Sweden",
    "policyUrl": "https://acme-bank.example.com/privacy",
    "coverImageUrl": "",
    "coverImageId": "",
    "logoImageUrl": "",
    "logoImageId": "",
    "eulaUrl": "",
    "enabled": false,
    "authentication": {
      "password": {
        "enabled": true
      },
      "oidcPasswordless": {
        "enabled": false,
        "loginPresentationDefinitionId": "",
        "linkingPresentationDefinitionId": "",
        "authenticatorCredentialDefinitionId": ""
      }
    },
    "privacyDashboard": {
      "hostname": "",
      "version": "",
      "status": 0,
      "delete": false,
      "buttonLabels": {
        "dataUsingServicesButtonLabel": ""
      }
    },
    "openIdDeployment": {
      "openIdDigitalWalletId": "",
      "status": 0,
      "ledgerId": 0,
      "infrastructureProvider": "",
      "version": "",
      "role": "",
      "trustAnchor": "",
      "isWalletProvider": false
    },
    "configuredFeatures": {
      "gettingStarted": false,
      "dataAgreements": false,
      "dataDisclosureAgreements": false,
      "managedData": false,
      "issuerVerifier": false,
      "walletUnit": false,
      "consentManagement": false,
      "privacyDashboard": false,
      "account": false,
      "actionLogs": false,
      "webhooks": false,
      "files": false,
      "sandbox": false,
      "apiKeyScopesUi": false
    },
    "subscribeMethod": 0,
    "subs": {
      "method": 0,
      "key": ""
    }
  }
}

Authorizations

Authorizationstringheaderrequired
Your API key with the prefix ApiKey: ApiKey <your-api-key>. Get an API key.
Scope:organisation:update

Body

application/json

The members to change.

namestring
The new name. It must be unique in the installation.
Example:"Acme Bank"
locationstring
The new location.
Example:"Stockholm, Sweden"
descriptionstring
The new description, at most 500 characters.
At most 500 characters.
Example:"Retail bank that issues and verifies payment credentials."
policyUrlstring
The new privacy policy URL, an absolute http:// or https:// URL.
Example:"https://acme-bank.example.com/privacy"

Response

application/json

The organisation after the change, with only the profile members filled in.

organisationobject