Options
All
  • Public
  • Public/Protected
  • All
Menu

Namespace CreateConnectionFromOAuth2

The details to create a OAuth2 connection

Enumerations

Properties

Methods

Properties

accessTokenUrl

accessTokenUrl: string

Specifies the endpoint used to exchange authentication credentials for access tokens

Optional clientId

clientId: undefined | string

Specifies the client ID key for specific application

Optional clientSecret

clientSecret: model.SensitiveAttribute

Optional connectionProperties

connectionProperties: Array<ConnectionProperty>

The properties for the connection.

Optional description

description: undefined | string

User-defined description for the connection.

Optional grantType

grantType: GrantType

Specifies the OAuth2 grant mechanism. Example CLIENT_CREDENTIALS, Implicit Flow etc.

identifier

identifier: string

Value can only contain upper case letters, underscore, and numbers. It should begin with upper case letter or underscore. The value can be modified.

Optional key

key: undefined | string

Generated key that can be used in API calls to identify connection. On scenarios where reference to the connection is needed, a value can be passed in create.

Const modelType

modelType: string = "OAUTH2_CONNECTION"

Optional modelVersion

modelVersion: undefined | string

The model version of an object.

name

name: string

Free form text without any restriction on permitted characters. Name can have letters, numbers, and special characters. The value is editable and is restricted to 1000 characters.

Optional objectStatus

objectStatus: undefined | number

The status of an object that can be set to value 1 for shallow references across objects, other values reserved. Note: Numbers greater than Number.MAX_SAFE_INTEGER will result in rounding issues.

Optional parentRef

parentRef: model.ParentReference

Optional registryMetadata

registryMetadata: model.RegistryMetadata

Optional scope

scope: undefined | string

Specifies the OAuth scopes that limit the permissions granted by an access token.

Methods

getDeserializedJsonObj

getJsonObj