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

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

limit integerrequired

Default value: 10

Number of items returned per page. Requested number of resources to be provided in response requested by client.

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
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",
      "kid": "string",
      "systemManaged": true
    }
  ],
  "pagination": {
    "currentPage": 0,
    "totalItems": 0,
    "totalPages": 0,
    "limit": 0,
    "hasPrevious": true,
    "hasNext": true
  }
}

Loading...