CreateRedirectUrlParams
Example
Backend API (BAPI) endpoint

Edit this page on GitHub

`createRedirectUrl()`

Creates a RedirectUrl.

function createRedirectUrl(params: CreateRedirectUrlParams): Promise<RedirectUrl>

`CreateRedirectUrlParams`

Name
url
Type
string
Description
The full url value prefixed with https:// or a custom scheme. For example, https://my-app.com/oauth-callback or my-app://oauth-callback

Example

Note

Importing clerkClient varies based on your framework. Refer to the Backend SDK overview for usage details, including guidance on how to access the userId and other properties.

const response = await clerkClient.redirectUrls.createRedirectUrl({
  url: 'https://example.com',
})

Backend API (BAPI) endpoint

This method in the SDK is a wrapper around the BAPI endpoint POST/redirect_urls. See the BAPI reference for more information.

Edit this page on GitHub

Last updated on Feb 20, 2025