PATCH /accounts/{account_id}/oauth_clients/{oauth_client_id}

Update an existing OAuth client. Only include fields you want to update.

Servers

Path parameters

Name Type Required Description
oauth_client_id String Yes
account_id String Yes

Request headers

Name Type Required Description
Content-Type String Yes The media type of the request body.

Default value: "application/json"

Request body fields

Name Type Required Description
tos_uri String No

URL that points to a terms of service document.

scopes[] Array No

Array of OAuth scopes the client is allowed to request. Colon-delimited scopes are not accepted. Dot-delimited scopes are validated against available OAuth API scopes; simple identity scopes are allowed. Protocol scopes offline_access and openid are added or removed automatically based on grant_types and response_types.

visibility String No

Promote the OAuth client from private to public visibility. Only public is accepted; demotion to private is not supported. Promotion requires a non-empty client name, logo URI, verified client URI host, and at least one non-identity scope.

Valid values:

  • "public"
logo_uri String No

URL of the client's logo.

token_endpoint_auth_method String No

The authentication method the client uses at the token endpoint.

Valid values:

  • "client_secret_basic"
  • "client_secret_post"
  • "none"
policy_uri String No

URL that points to a privacy policy document.

response_types[] Array No

Array of OAuth response types the client is allowed to use.

client_name String No

Human-readable name of the OAuth client.

client_uri String No

URL of the home page of the client.

grant_types[] Array No

Array of OAuth grant types the client is allowed to use. authorization_code is required; refresh_token may be included optionally.

allowed_cors_origins[] Array No

Array of allowed CORS origins.

post_logout_redirect_uris[] Array No

Array of allowed post-logout redirect URIs.

redirect_uris[] Array No

Array of allowed redirect URIs for the client.

How to start integrating

  1. Add HTTP Task to your workflow definition.
  2. Search for the API you want to integrate with and click on the name.
    • This loads the API reference documentation and prepares the Http request settings.
  3. Click Test request to test run your request to the API and see the API's response.