v13

latestOpenAPI 3.0.3MITraw.githubusercontent.com2026-08-04237161688.6 KB

OAuth Applications

Create an OAuth application

Creates a new OAuth application with the given name and callback URL for an instance. The callback URL must be a valid URL. All URL schemes are allowed such as http://, https://, myapp://, etc...

post/oauth_applications

Request body

namestring required

The name of the new OAuth application. Max length: 256

redirect_urisstring[] nullable

An array of redirect URIs of the new OAuth application

callback_urlstring nullable

The callback URL of the new OAuth application

scopesstring nullable

Define the allowed scopes for the new OAuth applications that dictate the user payload of the OAuth user info endpoint. Available scopes are profile, email, public_metadata, private_metadata. Provide the requested scopes as a string, separated by spaces.

consent_screen_enabledboolean nullable

True to enable a consent screen to display in the authentication flow.

pkce_requiredboolean nullable

True to require the Proof Key of Code Exchange (PKCE) flow.

publicboolean nullable

If true, this client is public and you can use the Proof Key of Code Exchange (PKCE) flow.

Example request

{
  "scopes": "profile email public_metadata"
}

Response

An OAuth application with client secret

object'oauth_application' required

idstring required

instance_idstring required

namestring required

client_idstring required

client_uristring nullable required

client_image_urlstring nullable required

dynamically_registeredboolean required

consent_screen_enabledboolean required

pkce_requiredboolean required

publicboolean required

scopesstring required

redirect_urisstring[] required

callback_urlstring required

Deprecated: Use redirect_uris instead.

authorize_urlstring required

token_fetch_urlstring required

user_info_urlstring required

discovery_urlstring required

token_introspection_urlstring required

created_atinteger required

Unix timestamp of creation.

updated_atinteger required

Unix timestamp of last update.

client_secretstring

Empty if public client.