Herald
OpenapiClient

Update a client app configuration

Updates the configuration of an existing OAuth client application. Optionally regenerate the client secret.

PUT
/api/client/{realmId}/{clientAppId}

Updates the configuration of an existing OAuth client application. Optionally regenerate the client secret.

Path Parameters

realmId*string

Realm ID

clientAppId*string

client app UUID

Formatuuid

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

allowedOrigins?array<string>|null
browserRefreshAbsoluteTtlSeconds?|
Formatint32
description?|

Detailed description of the client application (max 500 characters)

Updates the description explaining the purpose of the application.

deviceCodeGrantEnabled?boolean|null
emailVerifyReturnUrl?string|null
enabled?|

Whether this client application is active

When set to false, the client cannot be used for new OAuth flows.

iconUrl?|

URL to client application icon (favicon, logo)

Updates the URL to an image file that will be displayed as the app icon. Should be a valid HTTPS URL to an image resource.

name?|

Client application name (1-100 characters)

Updates the display name shown to users in authorization screens.

passwordResetReturnUrl?string|null
redirectUris?array<string>|

Allowed OAuth redirect URIs

Updates the list of valid redirect URIs for OAuth flows. Must be valid HTTPS URLs (http://localhost is allowed for development). Users will only be redirected to these URIs after authentication.

regenerateSecret?|

Regenerate client secret

Set to true to generate a new client_secret. The old secret will be immediately invalidated and cannot be recovered. The new secret will be returned in the response. Store this securely - it will not be retrievable after this response.

turnstileEnabled?|

Enable/disable Cloudflare Turnstile for this Client App (D-PROTECT-01).

turnstileSecretKey?|

Update the Cloudflare Turnstile secret key (server-side, sensitive). Write-only: never echoed back in responses.

turnstileSiteKey?|

Update the Cloudflare Turnstile site key (public).

Response Body

application/json

application/json

application/json

curl -X PUT "https://example.com/api/client/string/497f6eca-6276-4993-bfeb-53cbbbba6f08" \  -H "Content-Type: application/json" \  -d '{}'
{  "allowedOrigins": [    "string"  ],  "browserRefreshAbsoluteTtlSeconds": 0,  "clientId": "my-web-app",  "clientSecret": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",  "description": "Internal admin dashboard for organization management",  "deviceCodeGrantEnabled": true,  "emailVerifyReturnUrl": "string",  "enabled": "true",  "iconUrl": "https://example.com/logo.png",  "id": "01234567-89ab-cdef-0123-456789abcdef",  "isFirstParty": true,  "name": "My Web Application",  "passwordResetReturnUrl": "string",  "realmId": "my-realm",  "redirectUris": [    "https://example.com/callback",    "http://localhost:3000/auth/callback"  ],  "turnstileEnabled": true,  "turnstileSiteKey": "string"}
{  "code": "string",  "details": null,  "message": "string",  "requestId": "string",  "status": 0}
{  "code": "string",  "details": null,  "message": "string",  "requestId": "string",  "status": 0}