OAuth 2.0 clients

Create OAuth 2.0 client

POST/v4/config/consent/data-space/oauth2-client

Creates client credentials for another party, for example your data marketplace. The party uses them at the token endpoint of your organisation (/v4/service/consent/data-space/{organisationId}/token) with the client_credentials grant, and gets an access token for the data space endpoints of your organisation.

The service makes the client ID and the client secret. Give them to the party in a secure way: every answer holds the secret in clear text.

Errors: 400 when clientName is missing, shorter than 3 or longer than 50 characters, clientDescription is longer than 200 characters, or a client with the same name exists.

Language of the request sample

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

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

Authorizations

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

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 new client with its secret.

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.