Skip to content

/AWS1/CL_AMBUPBACKENDAUTHOAU00

The OAuth configurations for authenticating users into your Amplify app.

CONSTRUCTOR

IMPORTING

Optional arguments:

IV_DOMAINPREFIX TYPE /AWS1/AMB__STRING /AWS1/AMB__STRING

The Amazon Cognito domain prefix used to create a hosted UI for authentication.

IV_OAUTHGRANTTYPE TYPE /AWS1/AMBOAUTHGRANTTYPE /AWS1/AMBOAUTHGRANTTYPE

The OAuth grant type to allow app users to authenticate from your Amplify app.

IT_OAUTHSCOPES TYPE /AWS1/CL_AMBLSTOFOAUTHSCOPES00=>TT_LISTOFOAUTHSCOPESELEMENT TT_LISTOFOAUTHSCOPESELEMENT

The list of OAuth-related flows that can allow users to authenticate from your Amplify app.

IT_REDIRECTSIGNINURIS TYPE /AWS1/CL_AMBLISTOF__STRING_W=>TT_LISTOF__STRING TT_LISTOF__STRING

Redirect URLs that OAuth uses when a user signs in to an Amplify app.

IT_REDIRECTSIGNOUTURIS TYPE /AWS1/CL_AMBLISTOF__STRING_W=>TT_LISTOF__STRING TT_LISTOF__STRING

Redirect URLs that OAuth uses when a user signs out of an Amplify app.

IO_SOCIALPROVIDERSETTINGS TYPE REF TO /AWS1/CL_AMBSOCIALPVDRSETTINGS /AWS1/CL_AMBSOCIALPVDRSETTINGS

Describes third-party social federation configurations for allowing your users to sign in with OAuth.


Queryable Attributes

DomainPrefix

The Amazon Cognito domain prefix used to create a hosted UI for authentication.

Accessible with the following methods

Method Description
GET_DOMAINPREFIX() Getter for DOMAINPREFIX, with configurable default
ASK_DOMAINPREFIX() Getter for DOMAINPREFIX w/ exceptions if field has no value
HAS_DOMAINPREFIX() Determine if DOMAINPREFIX has a value

OAuthGrantType

The OAuth grant type to allow app users to authenticate from your Amplify app.

Accessible with the following methods

Method Description
GET_OAUTHGRANTTYPE() Getter for OAUTHGRANTTYPE, with configurable default
ASK_OAUTHGRANTTYPE() Getter for OAUTHGRANTTYPE w/ exceptions if field has no valu
HAS_OAUTHGRANTTYPE() Determine if OAUTHGRANTTYPE has a value

OAuthScopes

The list of OAuth-related flows that can allow users to authenticate from your Amplify app.

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

RedirectSignInURIs

Redirect URLs that OAuth uses when a user signs in to an Amplify app.

Accessible with the following methods

Method Description
GET_REDIRECTSIGNINURIS() Getter for REDIRECTSIGNINURIS, with configurable default
ASK_REDIRECTSIGNINURIS() Getter for REDIRECTSIGNINURIS w/ exceptions if field has no
HAS_REDIRECTSIGNINURIS() Determine if REDIRECTSIGNINURIS has a value

RedirectSignOutURIs

Redirect URLs that OAuth uses when a user signs out of an Amplify app.

Accessible with the following methods

Method Description
GET_REDIRECTSIGNOUTURIS() Getter for REDIRECTSIGNOUTURIS, with configurable default
ASK_REDIRECTSIGNOUTURIS() Getter for REDIRECTSIGNOUTURIS w/ exceptions if field has no
HAS_REDIRECTSIGNOUTURIS() Determine if REDIRECTSIGNOUTURIS has a value

SocialProviderSettings

Describes third-party social federation configurations for allowing your users to sign in with OAuth.

Accessible with the following methods

Method Description
GET_SOCIALPROVIDERSETTINGS() Getter for SOCIALPROVIDERSETTINGS