Update confidential API connection

patch

https://rls.congacloud.com/api/user-management/v1/api-connections/confidential/{clientId}

Updates confidential API connection for current organization.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

clientId

string

required

Client identifier

Body Params

Input for updating confidential API connection.

Request payload for partially updating an existing confidential OAuth client.
Only the fields provided in the request are updated; omitted or null fields are left unchanged.

ClientName

string | null

New display name of the confidential client. Leave null to keep the existing value.

Example: "Billing-Confidential-Client"

Description

string | null

New description explaining the purpose of the confidential client. Leave null to keep the existing value.

Example: "Confidential client used by the Billing service to call platform APIs."

RedirectUrls

array of strings | null

Absolute HTTPS redirect URIs allowed after authentication. When provided, replaces the existing list.

Example: ["https://app.dummy.com/signin-oidc", "https://app.dummy.com/callback"]

RedirectUrls

CorsOrigins

array of strings | null

Origins allowed to make CORS requests for this client. When provided, replaces the existing list.

Example: ["https://app.dummy.com", "https://admin.dummy.com"]

CorsOrigins

AllowedScopes

array of strings | null

OAuth scopes granted to this client. When provided, replaces the existing scopes.

Example: ["openid", "offline_access", "Auth.Api.Read", "Auth.Api.Organizations"]

AllowedScopes

RequirePkce

boolean | null

Indicates whether Proof Key for Code Exchange (PKCE) is required for this client.
Leave null to keep the existing value.

Example: true

Headers

content-type

string

enum

Defaults to application/json

Generated from available request content types

Allowed:

Responses

400

Bad Request

404

Not Found

500

Internal Server Error

Language

Credentials

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Success