/AWS1/CL_WKRREGOIDCCONFIGRSP¶
RegisterOidcConfigResponse
CONSTRUCTOR¶
IMPORTING¶
Required arguments:¶
iv_companyid TYPE /AWS1/WKRGENERICSTRING /AWS1/WKRGENERICSTRING¶
Custom identifier your end users will use to sign in with SSO.
iv_scopes TYPE /AWS1/WKRGENERICSTRING /AWS1/WKRGENERICSTRING¶
The OAuth scopes configured for the application.
iv_issuer TYPE /AWS1/WKRGENERICSTRING /AWS1/WKRGENERICSTRING¶
The issuer URL of the OIDC provider.
Optional arguments:¶
iv_applicationname TYPE /AWS1/WKRGENERICSTRING /AWS1/WKRGENERICSTRING¶
The name of the registered OIDC application.
iv_clientid TYPE /AWS1/WKRGENERICSTRING /AWS1/WKRGENERICSTRING¶
The OAuth client ID assigned to the application.
iv_clientsecret TYPE /AWS1/WKRSENSITIVESTRING /AWS1/WKRSENSITIVESTRING¶
The OAuth client secret for the application.
iv_secret TYPE /AWS1/WKRSENSITIVESTRING /AWS1/WKRSENSITIVESTRING¶
The client secret for authenticating with the OIDC provider.
iv_redirecturl TYPE /AWS1/WKRGENERICSTRING /AWS1/WKRGENERICSTRING¶
The redirect URL configured for the OAuth flow.
iv_userid TYPE /AWS1/WKRGENERICSTRING /AWS1/WKRGENERICSTRING¶
The claim field being used as the user identifier.
iv_customusername TYPE /AWS1/WKRGENERICSTRING /AWS1/WKRGENERICSTRING¶
The custom field mapping used for extracting the username.
iv_cacertificate TYPE /AWS1/WKRGENERICSTRING /AWS1/WKRGENERICSTRING¶
The CA certificate used for secure communication with the OIDC provider.
iv_applicationid TYPE /AWS1/WKRINTEGER /AWS1/WKRINTEGER¶
The unique identifier for the registered OIDC application.
iv_ssotokenbufferminutes TYPE /AWS1/WKRINTEGER /AWS1/WKRINTEGER¶
The buffer time in minutes before the SSO token expires.
iv_extraauthparams TYPE /AWS1/WKRGENERICSTRING /AWS1/WKRGENERICSTRING¶
The additional authentication parameters configured for the OIDC flow.
Queryable Attributes¶
applicationName¶
The name of the registered OIDC application.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_APPLICATIONNAME() |
Getter for APPLICATIONNAME, with configurable default |
ASK_APPLICATIONNAME() |
Getter for APPLICATIONNAME w/ exceptions if field has no val |
HAS_APPLICATIONNAME() |
Determine if APPLICATIONNAME has a value |
clientId¶
The OAuth client ID assigned to the application.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_CLIENTID() |
Getter for CLIENTID, with configurable default |
ASK_CLIENTID() |
Getter for CLIENTID w/ exceptions if field has no value |
HAS_CLIENTID() |
Determine if CLIENTID has a value |
companyId¶
Custom identifier your end users will use to sign in with SSO.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_COMPANYID() |
Getter for COMPANYID, with configurable default |
ASK_COMPANYID() |
Getter for COMPANYID w/ exceptions if field has no value |
HAS_COMPANYID() |
Determine if COMPANYID has a value |
scopes¶
The OAuth scopes configured for the application.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_SCOPES() |
Getter for SCOPES, with configurable default |
ASK_SCOPES() |
Getter for SCOPES w/ exceptions if field has no value |
HAS_SCOPES() |
Determine if SCOPES has a value |
issuer¶
The issuer URL of the OIDC provider.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_ISSUER() |
Getter for ISSUER, with configurable default |
ASK_ISSUER() |
Getter for ISSUER w/ exceptions if field has no value |
HAS_ISSUER() |
Determine if ISSUER has a value |
clientSecret¶
The OAuth client secret for the application.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_CLIENTSECRET() |
Getter for CLIENTSECRET, with configurable default |
ASK_CLIENTSECRET() |
Getter for CLIENTSECRET w/ exceptions if field has no value |
HAS_CLIENTSECRET() |
Determine if CLIENTSECRET has a value |
secret¶
The client secret for authenticating with the OIDC provider.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_SECRET() |
Getter for SECRET, with configurable default |
ASK_SECRET() |
Getter for SECRET w/ exceptions if field has no value |
HAS_SECRET() |
Determine if SECRET has a value |
redirectUrl¶
The redirect URL configured for the OAuth flow.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_REDIRECTURL() |
Getter for REDIRECTURL, with configurable default |
ASK_REDIRECTURL() |
Getter for REDIRECTURL w/ exceptions if field has no value |
HAS_REDIRECTURL() |
Determine if REDIRECTURL has a value |
userId¶
The claim field being used as the user identifier.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_USERID() |
Getter for USERID, with configurable default |
ASK_USERID() |
Getter for USERID w/ exceptions if field has no value |
HAS_USERID() |
Determine if USERID has a value |
customUsername¶
The custom field mapping used for extracting the username.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_CUSTOMUSERNAME() |
Getter for CUSTOMUSERNAME, with configurable default |
ASK_CUSTOMUSERNAME() |
Getter for CUSTOMUSERNAME w/ exceptions if field has no valu |
HAS_CUSTOMUSERNAME() |
Determine if CUSTOMUSERNAME has a value |
caCertificate¶
The CA certificate used for secure communication with the OIDC provider.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_CACERTIFICATE() |
Getter for CACERTIFICATE, with configurable default |
ASK_CACERTIFICATE() |
Getter for CACERTIFICATE w/ exceptions if field has no value |
HAS_CACERTIFICATE() |
Determine if CACERTIFICATE has a value |
applicationId¶
The unique identifier for the registered OIDC application.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_APPLICATIONID() |
Getter for APPLICATIONID, with configurable default |
ASK_APPLICATIONID() |
Getter for APPLICATIONID w/ exceptions if field has no value |
HAS_APPLICATIONID() |
Determine if APPLICATIONID has a value |
ssoTokenBufferMinutes¶
The buffer time in minutes before the SSO token expires.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_SSOTOKENBUFFERMINUTES() |
Getter for SSOTOKENBUFFERMINUTES, with configurable default |
ASK_SSOTOKENBUFFERMINUTES() |
Getter for SSOTOKENBUFFERMINUTES w/ exceptions if field has |
HAS_SSOTOKENBUFFERMINUTES() |
Determine if SSOTOKENBUFFERMINUTES has a value |
extraAuthParams¶
The additional authentication parameters configured for the OIDC flow.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_EXTRAAUTHPARAMS() |
Getter for EXTRAAUTHPARAMS, with configurable default |
ASK_EXTRAAUTHPARAMS() |
Getter for EXTRAAUTHPARAMS w/ exceptions if field has no val |
HAS_EXTRAAUTHPARAMS() |
Determine if EXTRAAUTHPARAMS has a value |