/AWS1/CL_QSTOAUTHCLIENTAPP

An OAuth client application that is used to authenticate connections to a data source through an OAuth identity provider.

CONSTRUCTOR

IMPORTING

Optional arguments:

iv_oauthclientapplicationid TYPE /AWS1/QSTOAUTHCLIENTAPPID /AWS1/QSTOAUTHCLIENTAPPID

The ID of the OAuthClientApplication. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.

iv_name TYPE /AWS1/QSTRESOURCENAME /AWS1/QSTRESOURCENAME

The display name of the OAuthClientApplication.

iv_oauthclientauthntctntype TYPE /AWS1/QSTOAUTHCLIAUTHNTCTNTYPE /AWS1/QSTOAUTHCLIAUTHNTCTNTYPE

The OAuth client authentication type used by the OAuthClientApplication. Valid values are TOKEN.

iv_oauthtokenendpointurl TYPE /AWS1/QSTOAUTHTOKENENDPOINTURL /AWS1/QSTOAUTHTOKENENDPOINTURL

The token endpoint URL of the identity provider that is used to obtain access tokens.

iv_oauthauthendpointurl TYPE /AWS1/QSTOAUTHAUTHENDPOINTURL /AWS1/QSTOAUTHAUTHENDPOINTURL

The authorization endpoint URL of the identity provider that is used to obtain authorization codes.

iv_oauthscopes TYPE /AWS1/QSTOAUTHSCOPESSTRING /AWS1/QSTOAUTHSCOPESSTRING

The OAuth scopes that are requested when the OAuthClientApplication obtains an access token from the identity provider.

iv_datasourcetype TYPE /AWS1/QSTDATASOURCETYPE /AWS1/QSTDATASOURCETYPE

The type of data source that the OAuthClientApplication is used with. Valid values are SNOWFLAKE.

io_identitypvdrvpcconnprps TYPE REF TO /AWS1/CL_QSTVPCCONNPROPERTIES /AWS1/CL_QSTVPCCONNPROPERTIES

VPC connection properties.

iv_createdtime TYPE /AWS1/QSTTIMESTAMP /AWS1/QSTTIMESTAMP

The time that the OAuthClientApplication was created.

iv_lastupdatedtime TYPE /AWS1/QSTTIMESTAMP /AWS1/QSTTIMESTAMP

The time that the OAuthClientApplication was last updated.

iv_arn TYPE /AWS1/QSTARN /AWS1/QSTARN

The Amazon Resource Name (ARN) of the OAuthClientApplication.

---

Queryable Attributes

OAuthClientApplicationId

The ID of the OAuthClientApplication. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.

Accessible with the following methods

Method	Description
GET_OAUTHCLIENTAPPLICATIONID()	Getter for OAUTHCLIENTAPPLICATIONID, with configurable defau
ASK_OAUTHCLIENTAPPLICATIONID()	Getter for OAUTHCLIENTAPPLICATIONID w/ exceptions if field h
HAS_OAUTHCLIENTAPPLICATIONID()	Determine if OAUTHCLIENTAPPLICATIONID has a value

Name

The display name of the OAuthClientApplication.

Accessible with the following methods

Method	Description
GET_NAME()	Getter for NAME, with configurable default
ASK_NAME()	Getter for NAME w/ exceptions if field has no value
HAS_NAME()	Determine if NAME has a value

OAuthClientAuthenticationType

The OAuth client authentication type used by the OAuthClientApplication. Valid values are TOKEN.

Accessible with the following methods

Method	Description
GET_OAUTHCLIENTAUTHNTCTNTYPE()	Getter for OAUTHCLIENTAUTHNTCTNTYPE, with configurable defau
ASK_OAUTHCLIENTAUTHNTCTNTYPE()	Getter for OAUTHCLIENTAUTHNTCTNTYPE w/ exceptions if field h
HAS_OAUTHCLIENTAUTHNTCTNTYPE()	Determine if OAUTHCLIENTAUTHNTCTNTYPE has a value

OAuthTokenEndpointUrl

The token endpoint URL of the identity provider that is used to obtain access tokens.

Accessible with the following methods

Method	Description
GET_OAUTHTOKENENDPOINTURL()	Getter for OAUTHTOKENENDPOINTURL, with configurable default
ASK_OAUTHTOKENENDPOINTURL()	Getter for OAUTHTOKENENDPOINTURL w/ exceptions if field has
HAS_OAUTHTOKENENDPOINTURL()	Determine if OAUTHTOKENENDPOINTURL has a value

OAuthAuthorizationEndpointUrl

The authorization endpoint URL of the identity provider that is used to obtain authorization codes.

Accessible with the following methods

Method	Description
GET_OAUTHAUTHENDPOINTURL()	Getter for OAUTHAUTHENDPOINTURL, with configurable default
ASK_OAUTHAUTHENDPOINTURL()	Getter for OAUTHAUTHENDPOINTURL w/ exceptions if field has n
HAS_OAUTHAUTHENDPOINTURL()	Determine if OAUTHAUTHENDPOINTURL has a value

OAuthScopes

The OAuth scopes that are requested when the OAuthClientApplication obtains an access token from the identity provider.

Accessible with the following methods

Method	Description
GET_OAUTHSCOPES()	Getter for OAUTHSCOPES, with configurable default
ASK_OAUTHSCOPES()	Getter for OAUTHSCOPES w/ exceptions if field has no value
HAS_OAUTHSCOPES()	Determine if OAUTHSCOPES has a value

DataSourceType

The type of data source that the OAuthClientApplication is used with. Valid values are SNOWFLAKE.

Accessible with the following methods

Method	Description
GET_DATASOURCETYPE()	Getter for DATASOURCETYPE, with configurable default
ASK_DATASOURCETYPE()	Getter for DATASOURCETYPE w/ exceptions if field has no valu
HAS_DATASOURCETYPE()	Determine if DATASOURCETYPE has a value

IdentityProviderVpcConnectionProperties

VPC connection properties.

Accessible with the following methods

Method	Description
GET_IDENTITYPVDRVPCCONNPRPS()	Getter for IDENTITYPROVIDERVPCCONNPRPS

CreatedTime

The time that the OAuthClientApplication was created.

Accessible with the following methods

Method	Description
GET_CREATEDTIME()	Getter for CREATEDTIME, with configurable default
ASK_CREATEDTIME()	Getter for CREATEDTIME w/ exceptions if field has no value
HAS_CREATEDTIME()	Determine if CREATEDTIME has a value

LastUpdatedTime

The time that the OAuthClientApplication was last updated.

Accessible with the following methods

Method	Description
GET_LASTUPDATEDTIME()	Getter for LASTUPDATEDTIME, with configurable default
ASK_LASTUPDATEDTIME()	Getter for LASTUPDATEDTIME w/ exceptions if field has no val
HAS_LASTUPDATEDTIME()	Determine if LASTUPDATEDTIME has a value

Arn

The Amazon Resource Name (ARN) of the OAuthClientApplication.

Accessible with the following methods

Method	Description
GET_ARN()	Getter for ARN, with configurable default
ASK_ARN()	Getter for ARN w/ exceptions if field has no value
HAS_ARN()	Determine if ARN has a value