Create Link URL
Generates a url for launching Anon Link. You must pass either an appUserId or appUserIdToken in the query parameters.
Authorizations
Bearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
Query Parameters
See supported integrations for list of accepted values. Otherwise, you can create a new custom integration by additionally supplying an authUrl
, as well as optionally a displayName
, iconUrl
, and checkUrl
.
Any unique user ID e.g. user-123-xyz
. Not required if appUserIdToken
is present.
Create one or use an ID token from your existing identity provider. This is an OIDC JWT token. The sub
claim of the token will be used as the appUserId
.
Defaults to Anon's chrome extension ID lbgbplnejdpahnfmnphghjlbedpjjbgd
. Set this parameter when using your own chrome extension.
Required when setting appUserIdToken
to an ID token from your existing identity provider. This is the ID of an SdkClient
.
A URL to the company logo. This will be displayed in the Anon Link UI. Defaults to your organization's logo URL if set.
The name of your company or application. This will be displayed in the Anon Link UI. Defaults to the name of your organization
Any valid url e.g. http://localhost:3000/redirect
. This is the url the user will be redirected to after linking an account.
Any valid JSON string e.g. {"key":"value"}
. Defaults to {}
. This value will be included as a query parameter sent to the specified redirectUrl
.
If you are creating a custom integration, set this to the URL of the integration's login page.
If you are creating a custom integration, set this to a page that can be used to determine whether a user is logged in, such as the user profile page. If not specified, this defaults to the authUrl
, which works in many cases.
If you are creating a custom integration, set this to the name of the integration as it should appear to the end user.
If you are creating a custom integration, set this to the url of an icon representing the integration to show to the end user.
Response
Was this page helpful?