/AWS1/CL_BDOGETO2CREDPVDRRSP¶
GetOauth2CredentialProviderResponse
CONSTRUCTOR¶
IMPORTING¶
Required arguments:¶
io_clientsecretarn TYPE REF TO /AWS1/CL_BDOSECRET /AWS1/CL_BDOSECRET¶
The Amazon Resource Name (ARN) of the client secret in AWS Secrets Manager.
iv_name TYPE /AWS1/BDOCREDPROVIDERNAME /AWS1/BDOCREDPROVIDERNAME¶
The name of the OAuth2 credential provider.
iv_credentialproviderarn TYPE /AWS1/BDOCREDPROVIDERARNTYPE /AWS1/BDOCREDPROVIDERARNTYPE¶
ARN of the credential provider requested.
iv_credentialprovidervendor TYPE /AWS1/BDOCREDPVDRVENDORTYPE /AWS1/BDOCREDPVDRVENDORTYPE¶
The vendor of the OAuth2 credential provider.
io_oauth2pvdrconfigoutput TYPE REF TO /AWS1/CL_BDOOAUTH2PVDRCFGOUT /AWS1/CL_BDOOAUTH2PVDRCFGOUT¶
The configuration output for the OAuth2 provider.
iv_createdtime TYPE /AWS1/BDOTIMESTAMP /AWS1/BDOTIMESTAMP¶
The timestamp when the OAuth2 credential provider was created.
iv_lastupdatedtime TYPE /AWS1/BDOTIMESTAMP /AWS1/BDOTIMESTAMP¶
The timestamp when the OAuth2 credential provider was last updated.
Optional arguments:¶
iv_clientsecretjsonkey TYPE /AWS1/BDOSECRETJSONKEYTYPE /AWS1/BDOSECRETJSONKEYTYPE¶
The JSON key used to extract the client secret value from the AWS Secrets Manager secret.
iv_clientsecretsource TYPE /AWS1/BDOSECRETSOURCETYPE /AWS1/BDOSECRETSOURCETYPE¶
The source type of the client secret. Either
MANAGEDif the secret is managed by the service, orEXTERNALif managed by the user in AWS Secrets Manager.
iv_callbackurl TYPE /AWS1/BDOSTRING /AWS1/BDOSTRING¶
Callback URL to register on the OAuth2 credential provider as an allowed callback URL. This URL is where the OAuth2 authorization server redirects users after they complete the authorization flow.
iv_status TYPE /AWS1/BDOSTATUS /AWS1/BDOSTATUS¶
The current status of the OAuth2 credential provider.
iv_failurereason TYPE /AWS1/BDOSTRING /AWS1/BDOSTRING¶
The reason for failure if the OAuth2 credential provider is in a failed state.
Queryable Attributes¶
clientSecretArn¶
The Amazon Resource Name (ARN) of the client secret in AWS Secrets Manager.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_CLIENTSECRETARN() |
Getter for CLIENTSECRETARN |
clientSecretJsonKey¶
The JSON key used to extract the client secret value from the AWS Secrets Manager secret.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_CLIENTSECRETJSONKEY() |
Getter for CLIENTSECRETJSONKEY, with configurable default |
ASK_CLIENTSECRETJSONKEY() |
Getter for CLIENTSECRETJSONKEY w/ exceptions if field has no |
HAS_CLIENTSECRETJSONKEY() |
Determine if CLIENTSECRETJSONKEY has a value |
clientSecretSource¶
The source type of the client secret. Either
MANAGEDif the secret is managed by the service, orEXTERNALif managed by the user in AWS Secrets Manager.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_CLIENTSECRETSOURCE() |
Getter for CLIENTSECRETSOURCE, with configurable default |
ASK_CLIENTSECRETSOURCE() |
Getter for CLIENTSECRETSOURCE w/ exceptions if field has no |
HAS_CLIENTSECRETSOURCE() |
Determine if CLIENTSECRETSOURCE has a value |
name¶
The name of the OAuth2 credential provider.
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 |
credentialProviderArn¶
ARN of the credential provider requested.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_CREDENTIALPROVIDERARN() |
Getter for CREDENTIALPROVIDERARN, with configurable default |
ASK_CREDENTIALPROVIDERARN() |
Getter for CREDENTIALPROVIDERARN w/ exceptions if field has |
HAS_CREDENTIALPROVIDERARN() |
Determine if CREDENTIALPROVIDERARN has a value |
credentialProviderVendor¶
The vendor of the OAuth2 credential provider.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_CREDENTIALPROVIDERVENDOR() |
Getter for CREDENTIALPROVIDERVENDOR, with configurable defau |
ASK_CREDENTIALPROVIDERVENDOR() |
Getter for CREDENTIALPROVIDERVENDOR w/ exceptions if field h |
HAS_CREDENTIALPROVIDERVENDOR() |
Determine if CREDENTIALPROVIDERVENDOR has a value |
callbackUrl¶
Callback URL to register on the OAuth2 credential provider as an allowed callback URL. This URL is where the OAuth2 authorization server redirects users after they complete the authorization flow.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_CALLBACKURL() |
Getter for CALLBACKURL, with configurable default |
ASK_CALLBACKURL() |
Getter for CALLBACKURL w/ exceptions if field has no value |
HAS_CALLBACKURL() |
Determine if CALLBACKURL has a value |
oauth2ProviderConfigOutput¶
The configuration output for the OAuth2 provider.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_OAUTH2PVDRCONFIGOUTPUT() |
Getter for OAUTH2PROVIDERCONFIGOUTPUT |
createdTime¶
The timestamp when the OAuth2 credential provider 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 timestamp when the OAuth2 credential provider 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 |
status¶
The current status of the OAuth2 credential provider.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_STATUS() |
Getter for STATUS, with configurable default |
ASK_STATUS() |
Getter for STATUS w/ exceptions if field has no value |
HAS_STATUS() |
Determine if STATUS has a value |
failureReason¶
The reason for failure if the OAuth2 credential provider is in a failed state.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_FAILUREREASON() |
Getter for FAILUREREASON, with configurable default |
ASK_FAILUREREASON() |
Getter for FAILUREREASON w/ exceptions if field has no value |
HAS_FAILUREREASON() |
Determine if FAILUREREASON has a value |