Get a list of Client configuration data.
Client Object Reference
Request
Method: GET
URI: /api/configuration/clientList
Headers
| | |
|---|
X-SurePassID-Api-Key | string | An API Key with 'Reader' role. |
Query String
| | |
|---|
includeNulls | boolean | Show/don't show JSON properties that have null values.
Default: false (don't show null property values) |
clientIds | string | A comma delimited list of URL encoded client IDs to list.
Default: All clients. |
Response
Status: 200 OK
{
"Clients": [
{
"Enabled": true,
"ClientId": "client_name",
"ProtocolType": "oidc",
"ClientSecrets": [
{
"Value": "K7gNU3sdo+OL0wNhqoVWhr3g6s1xYv72ol/pe/Unols=",
"Type": "SharedSecret"
}
],
"RequireClientSecret": true,
"ClientName": "SurePassID Client",
"RequireConsent": true,
"AllowRememberConsent": true,
"AllowedGrantTypes": [
"hybrid"
],
"RequirePkce": false,
"AllowPlainTextPkce": false,
"AllowAccessTokensViaBrowser": false,
"RedirectUris": [
"https://oidc-client.surepassid.com/signin-oidc"
],
"PostLogoutRedirectUris": [
"https://oidc-client.surepassid.com/signout-callback-oidc"
],
"FrontChannelLogoutSessionRequired": true,
"BackChannelLogoutSessionRequired": true,
"AllowOfflineAccess": false,
"AllowedScopes": [
"openid",
"profile"
],
"AlwaysIncludeUserClaimsInIdToken": true,
"IdentityTokenLifetime": 300,
"AccessTokenLifetime": 3600,
"AuthorizationCodeLifetime": 300,
"AbsoluteRefreshTokenLifetime": 2592000,
"SlidingRefreshTokenLifetime": 1296000,
"RefreshTokenUsage": 1,
"UpdateAccessTokenClaimsOnRefresh": false,
"RefreshTokenExpiration": 1,
"AccessTokenType": 0,
"EnableLocalLogin": true,
"IdentityProviderRestrictions": [],
"IncludeJwtId": false,
"Claims": [],
"AlwaysSendClientClaims": false,
"ClientClaimsPrefix": "client_",
"DeviceCodeLifetime": 300,
"AllowedCorsOrigins": [],
"Properties": {
"foo": "bar"
}
}
]
}Status: 401 Unauthorized
{
"type": "https://httpstatuses.com/401",
"title": "Unauthorized",
"status": 401
}