List OAuth2.0 Clients

GET 
/v3/config/data-space/oauth2-clients

Lists OAuth2 Clients for use with a Data Marketplace. Use an API key with the scope data-space:read (an older API key: config).

Request

Query Parameters

offset integerrequired

Default value: 0

Number of records to skip for pagination. A negative or unreadable value falls back to 0.

limit integerrequired

Default value: 10

Maximum number of records to return per page.

Responses

200

Data Marketplace related OAuth2 Clients listed

Response Headers

• Content-Type json

  Content-Type header

application/json

Schema

Schema

oauth2Clients object[]
Array [
clientId stringrequired
ID of the OAuth2 Client
clientSecret stringrequired
Secret of the OAuth2 Client
clientName stringrequired
Name of the OAuth2 Client
clientDescription string
Description of the OAuth2 Client
grantTypes stringrequired
Grant Types allowed for the OAuth2 Client
timestamp intrequired
Timestamp of the OAuth2 Client creation or last modification
]
pagination object

currentPage integer

Current page number

totalItems integer

Total number of items available

totalPages integer

Total number of pages based on limit

limit integer

Number of items per page

hasPrevious boolean

Indicates if there's a previous page

hasNext boolean

Indicates if there's a next page

Example (from schema)

{
  "oauth2Clients": [
    {
      "clientId": "string",
      "clientSecret": "string",
      "clientName": "string",
      "clientDescription": "string",
      "grantTypes": "string"
    }
  ],
  "pagination": {
    "currentPage": 1,
    "totalItems": 25,
    "totalPages": 3,
    "limit": 10,
    "hasPrevious": false,
    "hasNext": true
  }
}

401

Unauthorized

Response Headers

application/json

Schema

Schema

errorCode integerrequired
errorDescription stringrequired

Example (from schema)

{
  "errorCode": 400,
  "errorDescription": "Bad input parameter"
}

500

Internal server error

Response Headers

application/json

Schema

Schema

errorCode integerrequired
errorDescription stringrequired

Example (from schema)

{
  "errorCode": 400,
  "errorDescription": "Bad input parameter"
}

Loading...