Sign in

v1

latestOpenAPI 3.1.0raw.githubusercontent.com2026-06-25173140700.7 KB
AuthConnector

Update an OAuth client

Update an OAuth client (superadmin only).

patch/auth/connectors/oauth-clients/{oauth_client_id}

Path parameters

oauth_client_idinteger required

ID of the OAuth client to update.

ID of the OAuth client to update.

Query parameters

cookie_namestring nullable

Request body

namestring nullable

New display name for the OAuth client.

descriptionstring nullable

New description for the OAuth client.

icon_urlstring nullable

URL of an icon representing the OAuth client.

Example request

{
  "name": "Microsoft 365",
  "description": "Shared Microsoft OAuth application.",
  "icon_url": "https://cdn.example.com/icons/microsoft.svg"
}

Response

Successful Response

created_atstring date-time

UTC timestamp when the record was created.

updated_atstring date-time

UTC timestamp when the record was last updated.

creator_user_idinteger nullable

ID of the user who created the record, if attributable.

updater_user_idinteger nullable

ID of the user who last updated the record, if any.

idinteger nullable

Primary key for the OAuth client.

namestring required

Unique human-readable name of the OAuth client.

provider_key'azure-entra' | 'microsoft' | 'atlassian' | 'hubspot' | 'oidc' required

Enum for OAuth providers.

client_idstring nullable

OAuth application (client) ID issued by the provider.

descriptionstring nullable

Optional description of the OAuth client.

icon_urlstring nullable

URL of the icon shown for this OAuth client.

authorize_urlstring required

OAuth authorization endpoint URL.

admin_consent_urlstring nullable

URL for granting tenant-wide admin consent, if applicable.

token_urlstring required

OAuth token endpoint URL.

logout_urlstring nullable

URL used to log the user out of the provider session.

redirect_uristring nullable

Redirect URI registered for the OAuth callback.

Example response

{
  "created_at": "2026-01-15T10:30:00Z",
  "updated_at": "2026-01-16T08:00:00Z",
  "creator_user_id": 12,
  "updater_user_id": 12,
  "id": 1,
  "name": "Microsoft 365",
  "client_id": "11111111-2222-3333-4444-555555555555",
  "description": "Microsoft Entra ID login and connectors",
  "icon_url": "https://cdn.example.com/microsoft.png",
  "authorize_url": "https://login.microsoftonline.com/common/oauth2/v2.0/authorize",
  "admin_consent_url": "https://login.microsoftonline.com/common/adminconsent",
  "token_url": "https://login.microsoftonline.com/common/oauth2/v2.0/token",
  "logout_url": "https://login.microsoftonline.com/common/oauth2/v2.0/logout",
  "redirect_uri": "https://app.example.com/auth/callback"
}