Get All OIDC Clients - GET /OIDCClients



Get details of all OIDC (OpenID Connect) clients.

The ‘Manage Clients’ permission is required to execute this API.

Usage:

  1. GET /OIDCClients and get details of all OIDC clients
  2. PUT /OIDCClients/{id} and update OIDC client details

URL

/cxrestapi/auth/OIDCClients

Method:

GET

Media Type (header):

Authorization: Bearer <access token value>
Accept: application/json;v=1.0

Parameters

None

Success Response:

Code: 200 Success

Error Response:

Code: 401 Unauthorized
Code: 403 Forbidden

Sample Response:

{
  "id": 4,
  "updateAccessTokenClaimsOnRefresh": false,
  "accessTokenType": 0,
  "includeJwtId": false,
  "alwaysIncludeUserClaimsInIdToken": false,
  "clientId": "resource_owner_sast_client",
  "clientName": "Cx Sast Resource Owner Client",
  "allowOfflineAccess": true,
  "clientSecrets": [
    "7PXDgKOvDnF+YLUEpZ02brsgAAfeyld6n2D/qd4UunM="
  ],
  "allowedGrantTypes": [
    "password"
  ],
  "allowedScopes": [
    "sast_api",
    "access_control_api",
    "offline_access"
  ],
  "enabled": true,
  "requireClientSecret": true,
  "redirectUris": [],
  "postLogoutRedirectUris": [],
  "frontChannelLogoutUri": null,
  "frontChannelLogoutSessionRequired": true,
  "backChannelLogoutUri": null,
  "backChannelLogoutSessionRequired": true,
  "identityTokenLifetime": 300,
  "accessTokenLifetime": 3600,
  "authorizationCodeLifetime": 300,
  "absoluteRefreshTokenLifetime": 2592000,
  "slidingRefreshTokenLifetime": 1296000,
  "refreshTokenUsage": 1,
  "refreshTokenExpiration": 1,
  "allowedCorsOrigins": [],
  "allowAccessTokensViaBrowser": false,
  "claims": [],
  "clientClaimsPrefix": ""
}

Notes:

Retrieves details of all OIDC clients. If the request fails, it returns an error response.




Send Documentation Feedback - If you have comments about this documentation, you can contact the documentation team by sending your feedback to usWe appreciate your feedback!