Interface OAuth2Config

interface OAuth2Config {
    accessTokenUrl: string;
    appId?: string;
    authorizationUrl?: string;
    authService?: string;
    clientId: string;
    clientSecret?: string;
    deployUrl?: string;
    grantType?: string;
    password?: string;
    pkce?: boolean;
    redirectUrl?: string;
    username?: string;
}

Properties

accessTokenUrl appId? authorizationUrl? authService? clientId clientSecret? deployUrl? grantType? password? pkce? redirectUrl? username?

Properties

accessTokenUrl

accessTokenUrl: string

The endpoint for retrieving the access token.

OptionalappId

appId?: string

Optional application ID for which access is requested, If not specified will utilize the default access group within the current user's operator record.

OptionalauthorizationUrl

authorizationUrl?: string

The endpoint for retrieving the access token.

OptionalauthService

authService?: string

Infinity Authentication service alias, only used for the authorization code flow.

clientId

clientId: string

The client ID of the OAuth 2 client registration.

OptionalclientSecret

clientSecret?: string

The client secret of the OAuth 2 client registration.

OptionaldeployUrl

deployUrl?: string

The path to the static application files, only used for the authorization code flow. Note that the full url (including the origin) should be used.

OptionalgrantType

grantType?: string

The requested grant type used for retrieving an access token.

Optionalpassword

password?: string

The password is required for the credentials flow.

Optionalpkce

pkce?: boolean

Whether to enable the Proof Key for Code Exchange for the authorization code flow.

OptionalredirectUrl

redirectUrl?: string

The url to redirect to after authorization succeeded

Optionalusername

username?: string

The username is required for the credentials flow.

Settings

Member Visibility

On This Page

Properties