Clerk.OAuthApplication (Clerk SDK v1.0.0)

OAuth applications contain data for clients using Clerk as an OAuth2 identity provider.

Summary

Functions

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...

Deletes the given OAuth application. This is not reversible.

Fetches the OAuth application whose ID matches the provided id in the path.

This request returns the list of OAuth applications for an instance. Results can be paginated using the optional limit and offset query parameters. The OAuth applications are ordered by descending creation date. Most recent OAuth applications will be returned first.

Rotates the OAuth application's client secret. When the client secret is rotated, make sure to update it in authorized OAuth clients.

Updates an existing OAuth application

Functions

Link to this function

create(params, opts \\ [])

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...

REQUEST BODY SCHEMA: application/json

name

required string The name of the new OAuth application

callback_url

required string The callback URL of the new OAuth application

scopes

string Default: "profile email" 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.

public

boolean If true, this client is public and cannot securely store a client secret. Only the authorization code flow with proof key for code exchange (PKCE) may be used. Public clients cannot be updated to be confidential clients, and vice versa.

Link to this function

delete(id, opts \\ [])

Deletes the given OAuth application. This is not reversible.

Link to this function

get(id, opts \\ [])

Fetches the OAuth application whose ID matches the provided id in the path.

Link to this function

list(params \\ %{}, opts \\ [])

This request returns the list of OAuth applications for an instance. Results can be paginated using the optional limit and offset query parameters. The OAuth applications are ordered by descending creation date. Most recent OAuth applications will be returned first.

QUERY PARAMETERS

limit

number [ 1 .. 500 ] Default: 10 Applies a limit to the number of results returned. Can be used for paginating the results together with offset. Must be an integer greater than zero and less than 500. By default, if not supplied, a limit of 10 is used.

offset

number >= 0 Default: 0 Skip the first offset results when paginating. Needs to be an integer greater or equal to zero. To be used in conjunction with limit.

Link to this function

rotate_secret(id, opts \\ [])

Rotates the OAuth application's client secret. When the client secret is rotated, make sure to update it in authorized OAuth clients.

Link to this function

update(id, params, opts \\ [])

Updates an existing OAuth application

REQUEST BODY SCHEMA: application/json

required

name

string The new name of the OAuth application

callback_url

string The new callback URL of the OAuth application

scopes

string Default: "profile email" 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.