Get OIDC Client by Id - GET /OIDCClients/{id}
Owned by David P (Deactivated)
Gets details of an OIDC client according to OIDC client Id.
The ‘Manage Clients’ permission is required to execute this API.
Usage:
- POST /OIDCClients and create a new OIDC client
- GET /OIDCClients/{id} and get details of an OIDC client
URL
/cxrestapi/auth/OIDCClients/{id}
Method:
GET
Media Type (header):
Authorization: Bearer <access token value>
Accept: application/json;v=1.0
Parameters
Required:
id=[integer] - Unique Id of the OIDC client
Success Response:
Code: 200 Success
Error Response:
Code: 400 Bad Request
Code: 401 Unauthorized
Code: 403 Forbidden
Code: 404 Not Found
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 the OIDC client according to OIDC client Id. If the request fails, it returns an error response.
In this section
Related content
Send Documentation Feedback - If you have comments about this documentation, you can contact the documentation team by sending your feedback to us. We appreciate your feedback!