Class UpdateBackendAuthOAuthConfig
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<UpdateBackendAuthOAuthConfig.Builder,
UpdateBackendAuthOAuthConfig>
The OAuth configurations for authenticating users into your Amplify app.
- See Also:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionbuilder()
final String
The Amazon Cognito domain prefix used to create a hosted UI for authentication.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final int
hashCode()
final boolean
For responses, this returns true if the service returned a value for the OAuthScopes property.final boolean
For responses, this returns true if the service returned a value for the RedirectSignInURIs property.final boolean
For responses, this returns true if the service returned a value for the RedirectSignOutURIs property.final OAuthGrantType
The OAuth grant type to allow app users to authenticate from your Amplify app.final String
The OAuth grant type to allow app users to authenticate from your Amplify app.final List
<OAuthScopesElement> The list of OAuth-related flows that can allow users to authenticate from your Amplify app.The list of OAuth-related flows that can allow users to authenticate from your Amplify app.Redirect URLs that OAuth uses when a user signs in to an Amplify app.Redirect URLs that OAuth uses when a user signs out of an Amplify app.static Class
<? extends UpdateBackendAuthOAuthConfig.Builder> final SocialProviderSettings
Describes third-party social federation configurations for allowing your users to sign in with OAuth.Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
domainPrefix
The Amazon Cognito domain prefix used to create a hosted UI for authentication.
- Returns:
- The Amazon Cognito domain prefix used to create a hosted UI for authentication.
-
oAuthGrantType
The OAuth grant type to allow app users to authenticate from your Amplify app.
If the service returns an enum value that is not available in the current SDK version,
oAuthGrantType
will returnOAuthGrantType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromoAuthGrantTypeAsString()
.- Returns:
- The OAuth grant type to allow app users to authenticate from your Amplify app.
- See Also:
-
oAuthGrantTypeAsString
The OAuth grant type to allow app users to authenticate from your Amplify app.
If the service returns an enum value that is not available in the current SDK version,
oAuthGrantType
will returnOAuthGrantType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromoAuthGrantTypeAsString()
.- Returns:
- The OAuth grant type to allow app users to authenticate from your Amplify app.
- See Also:
-
oAuthScopes
The list of OAuth-related flows that can allow users to authenticate from your Amplify app.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the
hasOAuthScopes()
method.- Returns:
- The list of OAuth-related flows that can allow users to authenticate from your Amplify app.
-
hasOAuthScopes
public final boolean hasOAuthScopes()For responses, this returns true if the service returned a value for the OAuthScopes property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified. -
oAuthScopesAsStrings
The list of OAuth-related flows that can allow users to authenticate from your Amplify app.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the
hasOAuthScopes()
method.- Returns:
- The list of OAuth-related flows that can allow users to authenticate from your Amplify app.
-
hasRedirectSignInURIs
public final boolean hasRedirectSignInURIs()For responses, this returns true if the service returned a value for the RedirectSignInURIs property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified. -
redirectSignInURIs
Redirect URLs that OAuth uses when a user signs in to an Amplify app.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the
hasRedirectSignInURIs()
method.- Returns:
- Redirect URLs that OAuth uses when a user signs in to an Amplify app.
-
hasRedirectSignOutURIs
public final boolean hasRedirectSignOutURIs()For responses, this returns true if the service returned a value for the RedirectSignOutURIs property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified. -
redirectSignOutURIs
Redirect URLs that OAuth uses when a user signs out of an Amplify app.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the
hasRedirectSignOutURIs()
method.- Returns:
- Redirect URLs that OAuth uses when a user signs out of an Amplify app.
-
toBuilder
Description copied from interface:ToCopyableBuilder
Take this object and create a builder that contains all of the current property values of this object.- Specified by:
toBuilder
in interfaceToCopyableBuilder<UpdateBackendAuthOAuthConfig.Builder,
UpdateBackendAuthOAuthConfig> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode() -
equals
-
equalsBySdkFields
Description copied from interface:SdkPojo
Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
toString
Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value. -
getValueForField
-
sdkFields
-
socialProviderSettings
Describes third-party social federation configurations for allowing your users to sign in with OAuth.