Interface GetAuthorizeUrlOptions

interface GetAuthorizeUrlOptions {
    callback: string;
    contractDetails: ContractDetails;
    includeSampleDataOnlySources?: boolean;
    locale?: string;
    sampleData?: SampleDataOptions;
    serviceId?: number;
    sessionOptions?: { pull?: PullSessionOptions };
    sourcesScope?: SourcesScope;
    sourceType?: SourceType;
    state: string;
    storageId?: string;
    triggerQuery?: boolean;
    userAccessToken?: UserAccessToken;
}

Properties

callback contractDetails includeSampleDataOnlySources? locale? sampleData? serviceId? sessionOptions? sourcesScope? sourceType? state storageId? triggerQuery? userAccessToken?

Properties

callback

callback: string

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

contractDetails

contractDetails: ContractDetails

Any contract related details here.

OptionalincludeSampleDataOnlySources

includeSampleDataOnlySources?: boolean

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

Optionallocale

locale?: string

Send preferred 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).

OptionalsampleData

sampleData?: SampleDataOptions

Options for sample data flow

OptionalserviceId

serviceId?: number

Onboard a service while authorizing.

OptionalsessionOptions

sessionOptions?: { pull?: PullSessionOptions }

Any optional parameters for the share.

OptionalsourcesScope

sourcesScope?: SourcesScope

Options that is used to scope list of available sources during process of adding sources. Currently this is only used for data types but will be used for other params as well.

OptionalsourceType

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.

OptionalstorageId

storageId?: string

Provide storage.id returned createProvisionalStorage to connect this storage to created user

OptionaltriggerQuery

triggerQuery?: boolean

Flag to indicate if data query will be triggered post service authorisation. Default is true. If this is set to false data for added service will not be returned. You may want to set to false when adding multiple services subsequently and only get data for all services when adding last service.

OptionaluserAccessToken

userAccessToken?: UserAccessToken

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

Settings

Member Visibility

On This Page

Properties