Class OidcConfigForResponse
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<OidcConfigForResponse.Builder,
OidcConfigForResponse>
Your OIDC IdP workforce configuration.
- See Also:
-
Nested Class Summary
Nested Classes -
Method Summary
Modifier and TypeMethodDescriptionA string to string map of identifiers specific to the custom identity provider (IdP) being used.final String
The OIDC IdP authorization endpoint used to configure your private workforce.builder()
final String
clientId()
The OIDC IdP client ID used to configure your private workforce.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 boolean
For responses, this returns true if the service returned a value for the AuthenticationRequestExtraParams property.final int
hashCode()
final String
issuer()
The OIDC IdP issuer used to configure your private workforce.final String
jwksUri()
The OIDC IdP JSON Web Key Set (Jwks) URI used to configure your private workforce.final String
The OIDC IdP logout endpoint used to configure your private workforce.final String
scope()
An array of string identifiers used to refer to the specific pieces of user data or claims that the client application wants to access.static Class
<? extends OidcConfigForResponse.Builder> Take this object and create a builder that contains all of the current property values of this object.final String
The OIDC IdP token endpoint used to configure your private workforce.final String
toString()
Returns a string representation of this object.final String
The OIDC IdP user information endpoint used to configure your private workforce.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
clientId
The OIDC IdP client ID used to configure your private workforce.
- Returns:
- The OIDC IdP client ID used to configure your private workforce.
-
issuer
The OIDC IdP issuer used to configure your private workforce.
- Returns:
- The OIDC IdP issuer used to configure your private workforce.
-
authorizationEndpoint
The OIDC IdP authorization endpoint used to configure your private workforce.
- Returns:
- The OIDC IdP authorization endpoint used to configure your private workforce.
-
tokenEndpoint
The OIDC IdP token endpoint used to configure your private workforce.
- Returns:
- The OIDC IdP token endpoint used to configure your private workforce.
-
userInfoEndpoint
The OIDC IdP user information endpoint used to configure your private workforce.
- Returns:
- The OIDC IdP user information endpoint used to configure your private workforce.
-
logoutEndpoint
The OIDC IdP logout endpoint used to configure your private workforce.
- Returns:
- The OIDC IdP logout endpoint used to configure your private workforce.
-
jwksUri
The OIDC IdP JSON Web Key Set (Jwks) URI used to configure your private workforce.
- Returns:
- The OIDC IdP JSON Web Key Set (Jwks) URI used to configure your private workforce.
-
scope
An array of string identifiers used to refer to the specific pieces of user data or claims that the client application wants to access.
- Returns:
- An array of string identifiers used to refer to the specific pieces of user data or claims that the client application wants to access.
-
hasAuthenticationRequestExtraParams
public final boolean hasAuthenticationRequestExtraParams()For responses, this returns true if the service returned a value for the AuthenticationRequestExtraParams 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. -
authenticationRequestExtraParams
A string to string map of identifiers specific to the custom identity provider (IdP) being used.
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
hasAuthenticationRequestExtraParams()
method.- Returns:
- A string to string map of identifiers specific to the custom identity provider (IdP) being used.
-
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<OidcConfigForResponse.Builder,
OidcConfigForResponse> - 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
-