BeginAuthSessionParams

Parameter object passed to the AuthManager.beginAuthSession(params) method in the Bytescale SDKs.

Structure

{
  "accountId": String,
  "authHeaders": Function,
  "authUrl": String,
  "options": BeginAuthSessionParamsOptions
}

Example

{
  "accountId": "YOUR_ACCOUNT_ID",
  "authHeaders": Function,
  "authUrl": "https://your-web-app/your-auth-url",
  "options": {
    "cdnUrl": "https://your-custom-cname"
  }
}

Properties

accountId Required

Your account ID.

This is visible on the settings page:

https://www.bytescale.com/dashboard/settings

Example: "A623uY2"

Type: String

Length: 7

authHeaders Required

Parameterless function that returns a Promise containing the HTTP request headers to send to the authUrl (represented as a simple dictionary/object).

You must use this parameter to authorize with your authUrl.

Important: do not call 'AuthManager.beginAuthSession' or 'AuthManager.endAuthSession' inside this callback, as this will cause a deadlock.

Type: Function

authUrl Required

The fully-qualified URL for your backend API's auth endpoint (the endpoint that returns a JWT as plain text).

Example: "https://your-web-app/your-auth-url"

Type: String

Min Length: 1

Max Length: 255

options Optional

Optional parameters for the BeginAuthSessionParams.

Type: BeginAuthSessionParamsOptions

Was this section helpful? Yes No

You are using an outdated browser.

This website requires a modern web browser -- the latest versions of these browsers are supported:

UI Widgets

SDKs

Processing APIs

Core APIs

Data Types

More Resources

BeginAuthSessionParams

Structure

Example

Properties

accountId Required

authHeaders Required

authUrl Required

options Optional

You are using an outdated browser.