OAuth Clients

Update OAuth Client

GA

Update an existing OAuth client’s configuration.

Modifiable settings:

  • Authorized redirect URIs
  • Supported grant types

Notes:

  • Client ID and secret cannot be changed
  • Client type (user/project) cannot be modified
  • Updates are atomic - all changes succeed or none do
  • Previous configuration remains valid until update succeeds

Use this endpoint to:

  • Add/remove redirect URIs
  • Modify supported grant types
  • Update client configuration without disrupting existing tokens

Path parameters

oauth_client_idstringRequired
org_idstringRequired
The unique identifier of the organization.
project_idstringRequired
The unique identifier of the project.

Headers

AuthorizationstringRequired

Bearer authentication of the form Bearer <token>, where token is your auth token.

Request

This endpoint expects an object.
redirect_urislist of stringsOptional
Updated list of authorized redirect URIs. All existing URIs will be replaced with this list.
grant_typeslist of enumsOptional
Updated list of enabled grant types. All existing grant types will be replaced with this list.
Allowed values:

Response

OAuth client updated successfully
idstringformat: "uuid"
Unique identifier for the OAuth client.
namestring

Human-readable name for the OAuth client.

client_idstringformat: "uuid"
Unique identifier used to identify the client with the authorization server.
project_idstringformat: "uuid"
ID of the project this OAuth client belongs to.
createdstring
Timestamp when the OAuth client was created.
modifiedstring
Timestamp when the OAuth client was last modified.
descriptionstring or null
Optional description explaining the client's purpose and usage.
redirect_urislist of strings or null

List of authorized redirect URIs for OAuth flows requiring user interaction. Required for authorization code and implicit flows. Must be exact matches when used. Must use HTTPS in production (except for localhost).

grant_typeslist of enums or null

OAuth 2.0 grant types enabled for this client.

  • client_credentials: For server-to-server API access
  • authorization_code: For web and mobile apps
  • refresh_token: For maintaining long-term access
  • implicit: Legacy flow, not recommended for new applications
Allowed values:
client_secretstring or null

Secret key used to authenticate the client. Only shown once upon creation. Must be stored securely. Required for confidential clients (e.g., server applications).

Errors