software.amazon.awssdk.services.cognitoidentityprovider.model

Class IdentityProviderType

java.lang.Object

software.amazon.awssdk.services.cognitoidentityprovider.model.IdentityProviderType

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<IdentityProviderType.Builder,IdentityProviderType>

@Generated(value="software.amazon.awssdk:codegen")
public final class IdentityProviderType
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<IdentityProviderType.Builder,IdentityProviderType>

A container for information about an IdP.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	IdentityProviderType.Builder

Method Summary

Modifier and Type	Method and Description
Map<String,String>	attributeMapping() A mapping of IdP attributes to standard and custom user pool attributes.
static IdentityProviderType.Builder	builder()
Instant	creationDate() The date the IdP was created.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasAttributeMapping() For responses, this returns true if the service returned a value for the AttributeMapping property.
int	hashCode()
boolean	hasIdpIdentifiers() For responses, this returns true if the service returned a value for the IdpIdentifiers property.
boolean	hasProviderDetails() For responses, this returns true if the service returned a value for the ProviderDetails property.
List<String>	idpIdentifiers() A list of IdP identifiers.
Instant	lastModifiedDate() The date the IdP was last modified.
Map<String,String>	providerDetails() The IdP details.
String	providerName() The IdP name.
IdentityProviderTypeType	providerType() The IdP type.
String	providerTypeAsString() The IdP type.
List<SdkField<?>>	sdkFields()
static Class<? extends IdentityProviderType.Builder>	serializableBuilderClass()
IdentityProviderType.Builder	toBuilder()
String	toString() Returns a string representation of this object.
String	userPoolId() The user pool ID.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

userPoolId

public final String userPoolId()

The user pool ID.

Returns:

The user pool ID.

providerName

public final String providerName()

The IdP name.

Returns:

The IdP name.

providerType

public final IdentityProviderTypeType providerType()

The IdP type.

If the service returns an enum value that is not available in the current SDK version, providerType will return IdentityProviderTypeType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from providerTypeAsString().

Returns:

The IdP type.

See Also:

IdentityProviderTypeType

providerTypeAsString

public final String providerTypeAsString()

The IdP type.

If the service returns an enum value that is not available in the current SDK version, providerType will return IdentityProviderTypeType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from providerTypeAsString().

Returns:

The IdP type.

See Also:

IdentityProviderTypeType

hasProviderDetails

public final boolean hasProviderDetails()

For responses, this returns true if the service returned a value for the ProviderDetails property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() 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.

providerDetails

public final Map<String,String> providerDetails()

The IdP details. The following list describes the provider detail keys for each IdP type.

• For Google and Login with Amazon:

  • client_id

  • client_secret

  • authorize_scopes

• For Facebook:

  • client_id

  • client_secret

  • authorize_scopes

  • api_version

• For Sign in with Apple:

  • client_id

  • team_id

  • key_id

  • private_key

    You can submit a private_key when you add or update an IdP. Describe operations don't return the private key.

  • authorize_scopes

• For OIDC providers:

  • client_id

  • client_secret

  • attributes_request_method

  • oidc_issuer

  • authorize_scopes

  • The following keys are only present if Amazon Cognito didn't discover them at the oidc_issuer URL.

    • authorize_url

    • token_url

    • attributes_url

    • jwks_uri

  • Amazon Cognito sets the value of the following keys automatically. They are read-only.

    • attributes_url_add_attributes

• For SAML providers:

  • MetadataFile or MetadataURL

  • IDPSignout optional

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 hasProviderDetails() method.

Returns:

The IdP details. The following list describes the provider detail keys for each IdP type.

• For Google and Login with Amazon:

  • client_id

  • client_secret

  • authorize_scopes

• For Facebook:

  • client_id

  • client_secret

  • authorize_scopes

  • api_version

• For Sign in with Apple:

  • client_id

  • team_id

  • key_id

  • private_key

    You can submit a private_key when you add or update an IdP. Describe operations don't return the private key.

  • authorize_scopes

• For OIDC providers:

  • client_id

  • client_secret

  • attributes_request_method

  • oidc_issuer

  • authorize_scopes

  • The following keys are only present if Amazon Cognito didn't discover them at the oidc_issuer URL.

    • authorize_url

    • token_url

    • attributes_url

    • jwks_uri

  • Amazon Cognito sets the value of the following keys automatically. They are read-only.

    • attributes_url_add_attributes

• For SAML providers:

  • MetadataFile or MetadataURL

  • IDPSignout optional

hasAttributeMapping

public final boolean hasAttributeMapping()

For responses, this returns true if the service returned a value for the AttributeMapping property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() 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.

attributeMapping

public final Map<String,String> attributeMapping()

A mapping of IdP attributes to standard and custom user pool attributes.

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 hasAttributeMapping() method.

Returns:

A mapping of IdP attributes to standard and custom user pool attributes.

hasIdpIdentifiers

public final boolean hasIdpIdentifiers()

For responses, this returns true if the service returned a value for the IdpIdentifiers property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() 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.

idpIdentifiers

public final List<String> idpIdentifiers()

A list of IdP identifiers.

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 hasIdpIdentifiers() method.

Returns:

A list of IdP identifiers.

lastModifiedDate

public final Instant lastModifiedDate()

The date the IdP was last modified.

Returns:

The date the IdP was last modified.

creationDate

public final Instant creationDate()

The date the IdP was created.

Returns:

The date the IdP was created.

toBuilder

public IdentityProviderType.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<IdentityProviderType.Builder,IdentityProviderType>

builder

public static IdentityProviderType.Builder builder()

serializableBuilderClass

public static Class<? extends IdentityProviderType.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final String 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.

Overrides:

toString in class Object

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo