Skip to navigation

Update application credential

Partially updates an OAuth application credential. Only fields included in the request body are updated; omitted fields are left unchanged. Pass null to explicitly clear a field (e.g. client_secret or external_id).

Authentication

AuthorizationBearer

Token-based authentication with required prefix “Bearer”

Path parameters

idstringRequiredformat: "uuid"

Request

This endpoint expects an object.
client_idstringOptional<=255 characters
client_secretstring or nullOptional<=255 characters
external_idstring or nullOptional
oauth2_scopes_overridestring or nullOptional<=2048 characters

Space-separated OAuth scopes to request instead of the connector’s default scopes, applied to the OAuth option configured on this credential. Send an empty string to clear the override and revert to the connector defaults; a cleared override reads back as an empty string, while a field that was never set reads back as null. A value equal to the connector’s default scopes is treated as no override and reads back as null.

secretslist of objectsOptional

Connector-specific auth parameters to merge into the stored secrets, as a list of {name, value} entries. Only the entries you send are touched; an entry with no value key is left alone, and "value": null removes it — except for secrets the connector fixes to a single value, which are always reset to that value. Names must match the connector’s auth_options[].secrets[]; unknown names are rejected.

Response

idstringRead-onlyformat: "uuid"
connector_slugstringRead-only
client_idstringRead-only
external_idstring or nullRead-only
is_global_defaultbooleanRead-only
created_atdatetimeRead-only
modified_atdatetimeRead-only
oauth2_scopes_overridestring or nullRead-only
secretslist of objectsRead-only