List OIDC Client

GET 
/v3/config/extension/oidc/clients

Retrieves a list of all OpenID Connect clients configured for the organisation, including their verification request settings and configurations.

Request

Query Parameters

offset integerrequired

Number of records to skip for pagination.

limit integerrequired

Default value: 10

Maximum number of records to return per page.

systemManaged booleanrequired

Requested index for start of resources to be provided in response requested by client

Responses

200

List of clients

Response Headers

• Cache-Control string

  Indicates that the response should not be cached.

application/json

Schema

Schema

clients object[]required
Array [
presentationDefinitionId string
The ID of the client's configured presentation definition
name string
The name of the client
clientId string
The ID of the client
clientSecret string
The secret of the client
redirectURIs string[]
The valid redirect URIs for the client
allowedOrigins string[]
The valid origins for the client
callbackURI string
The URI at which a sub value will be calculated and returned according to the sent presentation.
callbackSecret string
The secret used to access the callbackURI. Required when callbackURI is set.
identityMatchingAttributes object
A map of VCTs (verifiable credential types) to claim paths used as linking values for identity matching. Each key is the VCT of a credential, and the value is the dot-separated path to the claim within that credential to use as the linking value.
property name* string
transactionDataAction string
The configured action for the transaction data, e.g. "login" or "verify"
kid string
The ID of the client's key
systemManaged boolean
Indicates whether the client is system-managed or not
]
pagination objectrequired

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)

{
  "clients": [
    {
      "presentationDefinitionId": "string",
      "name": "string",
      "clientId": "string",
      "clientSecret": "string",
      "redirectURIs": [
        "string"
      ],
      "allowedOrigins": [
        "string"
      ],
      "callbackURI": "string",
      "callbackSecret": "string",
      "identityMatchingAttributes": {},
      "transactionDataAction": "string",
      "kid": "string",
      "systemManaged": true
    }
  ],
  "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...