Interface GetAuthorizeUrlOptions

Hierarchy

  • GetAuthorizeUrlOptions

Properties

callback contractDetails includeSampleDataOnlySources? locale? sampleData? serviceId? sessionOptions? sourceType? state userAccessToken?

Properties

callback

callback: string

A URL to call to be called after authorization is done.

contractDetails

contractDetails: ContractDetails

Any contract related details here.

Optional includeSampleDataOnlySources

includeSampleDataOnlySources?: boolean

Flag to indicate if we should include sample data only sources. Default is false.

Optional locale

locale?: string

Send prefared locale for authorization client to be used. If passed locale is not supported then language will fallback to browser language. If browser locale is not supported we will fallback to default locale (en).

Optional sampleData

sampleData?: SampleDataOptions

Options for sample data flow

Optional serviceId

serviceId?: number

Onboard a service while authorizing.

Optional sessionOptions

sessionOptions?: {
    pull?: PullSessionOptions;
}

Any optional parameters for the share.

Type declaration

Optional sourceType

sourceType?: SourceType

Please use SourceType push to filter out only services that are push type. Default SourceType is set to pull.

state

state: string

Any extra data you want to be passed back after a authorization flow.

Optional userAccessToken

userAccessToken?: UserAccessToken

User access token you may already have for this user from this or from another contract.

Settings

Member Visibility

Theme

Generated using TypeDoc