Get Client

GET /api/v1/customer-accounts/{id}/client

Show customer account OAuth client information

Example response (application/json)

client.json
{
    "id": "4f50e517-03f5-41fb-8b23-94f807414cab",
    "clientId": "auth-customeraccount-1219",
    "name": "auth-customeraccount-1219",
    "description": "",
    "rootUrl": "https://api.licensespring.com",
    "adminUrl": "https://api.licensespring.com",
    "baseUrl": "https://api.licensespring.com",
    "surrogateAuthRequired": false,
    "enabled": true,
    "alwaysDisplayInConsole": false,
    "clientAuthenticatorType": "client-secret",
    "secret": "secret",
    "redirectUris": [
        "https://api.licensespring.com/*"
    ],
    "webOrigins": [
        "+"
    ],
    "notBefore": 0,
    "bearerOnly": false,
    "consentRequired": false,
    "standardFlowEnabled": true,
    "implicitFlowEnabled": true,
    "directAccessGrantsEnabled": true,
    "serviceAccountsEnabled": true,
    "authorizationServicesEnabled": true,
    "publicClient": false,
    "frontchannelLogout": true,
    "protocol": "openid-connect",
    "attributes": {
        "client.secret.rotated.creation.time": "1753853304",
        "client.secret.creation.time": "1753853304",
        "SECRET_ROTATED_EXPIRATION_PERIOD": "604800",
        "client.secret.expiration.time": "1756445304",
        "post.logout.redirect.uris": "+",
        "oauth2.device.authorization.grant.enabled": "true",
        "backchannel.logout.revoke.offline.tokens": "false",
        "client.secret.rotated.expiration.time": "1754458104",
        "SECRET_REMAINING_ROTATION_PERIOD": "172800",
        "realm_client": "false",
        "oidc.ciba.grant.enabled": "false",
        "SECRET_EXPIRATION_PERIOD": "2592000",
        "backchannel.logout.session.required": "true",
        "client.secret.rotated": "zv1hKzrgX8IBglJfEkt0UYQX3pJ5RrEO"
    },
    "authenticationFlowBindingOverrides": {},
    "fullScopeAllowed": true,
    "nodeReRegistrationTimeout": -1,
    "protocolMappers": [
        {
            "id": "05421ca8-9c76-453c-a06b-0f5fc68db03e",
            "name": "Client Host",
            "protocol": "openid-connect",
            "protocolMapper": "oidc-usersessionmodel-note-mapper",
            "consentRequired": false,
            "config": {
                "user.session.note": "clientHost",
                "id.token.claim": "true",
                "introspection.token.claim": "true",
                "access.token.claim": "true",
                "claim.name": "clientHost",
                "jsonType.label": "String"
            }
        },
        {
            "id": "e9877f79-45c4-4564-8238-bf2961a36e21",
            "name": "Client IP Address",
            "protocol": "openid-connect",
            "protocolMapper": "oidc-usersessionmodel-note-mapper",
            "consentRequired": false,
            "config": {
                "user.session.note": "clientAddress",
                "id.token.claim": "true",
                "introspection.token.claim": "true",
                "access.token.claim": "true",
                "claim.name": "clientAddress",
                "jsonType.label": "String"
            }
        },
        {
            "id": "a7d416a2-20c2-4788-8864-7fa502fd4d51",
            "name": "Client ID",
            "protocol": "openid-connect",
            "protocolMapper": "oidc-usersessionmodel-note-mapper",
            "consentRequired": false,
            "config": {
                "user.session.note": "client_id",
                "id.token.claim": "true",
                "introspection.token.claim": "true",
                "access.token.claim": "true",
                "claim.name": "client_id",
                "jsonType.label": "String"
            }
        }
    ],
    "defaultClientScopes": [
        "web-origins",
        "acr",
        "profile",
        "roles",
        "basic",
        "email"
    ],
    "optionalClientScopes": [
        "address",
        "phone",
        "offline_access",
        "microprofile-jwt"
    ],
    "access": {
        "view": true,
        "configure": true,
        "manage": true
    }
}

Possible responses

chevron-right200 — OKhashtag

Code: 200 OK

chevron-right404 — Not Foundhashtag

Request

Path parameters

  • id — (required) customer account ID

Query parameters

  • None

Header parameters

  • None

Body

  • None

Notes

  • This endpoint returns the OAuth client configuration associated with the specified customer account.

Was this helpful?