GET
/
link
/
url

Authorizations

Authorization
string
headerrequired

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

Query Parameters

app
string
required

See supported integrations for list of accepted enum values.

appUserId
string
required

Any unique user ID e.g. user-123-xyz. Not required if appUserIdToken is present. The sub claim of the token will be used as the appUserId.

appUserIdToken
string | null

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.

chromeExtensionId
string | null

Defaults to Anon's chrome extension ID lbgbplnejdpahnfmnphghjlbedpjjbgd. Set this parameter when using your own chrome extension.

clientId
string | null

Required when setting appUserIdToken to an ID token from your existing identity provider. This is the ID of an SdkClient.

companyLogoUrl
string | null

A URL to the company logo. This will be displayed in the Anon Link UI. Defaults to your organization's logo URL if set.

companyName
string | null

The name of your company or application. This will be displayed in the Anon Link UI. Defaults to the name of your organization

redirectUrl
string
required

Any valid url e.g. http://localhost:3000/redirect. This is the url the user will be redirected to after linking an account.

state
string | null

Any valid JSON string e.g. {"key":"value"}. Defaults to {}. This value will be included as a query parameter sent to the specified redirectUrl.

Response

200 - application/json
url
string
required