OAuth 2.0 clients

Update OAuth 2.0 client

PUT/v4/config/consent/data-space/oauth2-client/{clientId}

Changes the name or the description of an OAuth 2.0 client. Send clientName every time. The client ID and the secret stay the same.

Errors: 400 when a field is not valid or another client has the name; 404 when the client does not exist.

Language of the request sample

curl -X PUT 'https://demo-api.igrant.io/v4/config/consent/data-space/oauth2-client/{clientId}' \
  -H 'Authorization: ApiKey <your-api-key>' \
  -H 'Content-Type: application/json' \
  -d '{
  "clientName": "Data marketplace",
  "clientDescription": "Client of the data marketplace for the access token of the notifications"
}'

{
  "oauth2Client": {
    "clientId": "6af081762d6fb7b6ac6efc64",
    "clientSecret": "<client-secret>",
    "clientName": "Data marketplace",
    "clientDescription": "Client of the data marketplace for the access token of the notifications",
    "grantTypes": "client_credentials",
    "timestamp": 1794146683
  }
}

Authorizations

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

Path parameters

clientIdstringrequired
Client ID of the OAuth 2.0 client.

Body

application/json

clientNamestringrequired
Name of the client. Must be unique in your organisation.
3 to 50 characters.
clientDescriptionstring
What the client is for. An update without it keeps the old description.
At most 200 characters.

Response

application/json

The changed client.

oauth2Clientobject
Client credentials that another party, for example your data marketplace, uses at the token endpoint of your organisation (/v4/service/consent/data-space/{organisationId}/token) with the client_credentials grant.