IdentityProviderType (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.cognitoidp.model.IdentityProviderType

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class IdentityProviderType
extends Object
implements Serializable, Cloneable, StructuredPojo
```
A container for information about an identity provider.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

IdentityProviderType()

Constructors
Constructor and Description
`IdentityProviderType()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`IdentityProviderType`	`addAttributeMappingEntry(String key, String value)` Add a single AttributeMapping entry
`IdentityProviderType`	`addProviderDetailsEntry(String key, String value)` Add a single ProviderDetails entry
`IdentityProviderType`	`clearAttributeMappingEntries()` Removes all the entries added into AttributeMapping.
`IdentityProviderType`	`clearProviderDetailsEntries()` Removes all the entries added into ProviderDetails.
`IdentityProviderType`	`clone()`
`boolean`	`equals(Object obj)`
`Map<String,String>`	`getAttributeMapping()` A mapping of identity provider attributes to standard and custom user pool attributes.
`Date`	`getCreationDate()` The date the identity provider was created.
`List<String>`	`getIdpIdentifiers()` A list of identity provider identifiers.
`Date`	`getLastModifiedDate()` The date the identity provider was last modified.
`Map<String,String>`	`getProviderDetails()` The identity provider details.
`String`	`getProviderName()` The identity provider name.
`String`	`getProviderType()` The identity provider type.
`String`	`getUserPoolId()` The user pool ID.
`int`	`hashCode()`
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setAttributeMapping(Map<String,String> attributeMapping)` A mapping of identity provider attributes to standard and custom user pool attributes.
`void`	`setCreationDate(Date creationDate)` The date the identity provider was created.
`void`	`setIdpIdentifiers(Collection<String> idpIdentifiers)` A list of identity provider identifiers.
`void`	`setLastModifiedDate(Date lastModifiedDate)` The date the identity provider was last modified.
`void`	`setProviderDetails(Map<String,String> providerDetails)` The identity provider details.
`void`	`setProviderName(String providerName)` The identity provider name.
`void`	`setProviderType(IdentityProviderTypeType providerType)` The identity provider type.
`void`	`setProviderType(String providerType)` The identity provider type.
`void`	`setUserPoolId(String userPoolId)` The user pool ID.
`String`	`toString()` Returns a string representation of this object.
`IdentityProviderType`	`withAttributeMapping(Map<String,String> attributeMapping)` A mapping of identity provider attributes to standard and custom user pool attributes.
`IdentityProviderType`	`withCreationDate(Date creationDate)` The date the identity provider was created.
`IdentityProviderType`	`withIdpIdentifiers(Collection<String> idpIdentifiers)` A list of identity provider identifiers.
`IdentityProviderType`	`withIdpIdentifiers(String... idpIdentifiers)` A list of identity provider identifiers.
`IdentityProviderType`	`withLastModifiedDate(Date lastModifiedDate)` The date the identity provider was last modified.
`IdentityProviderType`	`withProviderDetails(Map<String,String> providerDetails)` The identity provider details.
`IdentityProviderType`	`withProviderName(String providerName)` The identity provider name.
`IdentityProviderType`	`withProviderType(IdentityProviderTypeType providerType)` The identity provider type.
`IdentityProviderType`	`withProviderType(String providerType)` The identity provider type.
`IdentityProviderType`	`withUserPoolId(String userPoolId)` The user pool ID.

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - IdentityProviderType
```
public IdentityProviderType()
```
- Method Detail
  - setUserPoolId
```
public void setUserPoolId(String userPoolId)
```
    The user pool ID.
    
    Parameters:
    
    userPoolId - The user pool ID.
  - getUserPoolId
```
public String getUserPoolId()
```
    The user pool ID.
    
    Returns:
    
    The user pool ID.
  - withUserPoolId
```
public IdentityProviderType withUserPoolId(String userPoolId)
```
    The user pool ID.
    
    Parameters:
    
    userPoolId - The user pool ID.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setProviderName
```
public void setProviderName(String providerName)
```
    The identity provider name.
    
    Parameters:
    
    providerName - The identity provider name.
  - getProviderName
```
public String getProviderName()
```
    The identity provider name.
    
    Returns:
    
    The identity provider name.
  - withProviderName
```
public IdentityProviderType withProviderName(String providerName)
```
    The identity provider name.
    
    Parameters:
    
    providerName - The identity provider name.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setProviderType
```
public void setProviderType(String providerType)
```
    The identity provider type.
    
    Parameters:
    
    providerType - The identity provider type.
    
    See Also:
    
    IdentityProviderTypeType
  - getProviderType
```
public String getProviderType()
```
    The identity provider type.
    
    Returns:
    
    The identity provider type.
    
    See Also:
    
    IdentityProviderTypeType
  - withProviderType
```
public IdentityProviderType withProviderType(String providerType)
```
    The identity provider type.
    
    Parameters:
    
    providerType - The identity provider type.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    IdentityProviderTypeType
  - setProviderType
```
public void setProviderType(IdentityProviderTypeType providerType)
```
    The identity provider type.
    
    Parameters:
    
    providerType - The identity provider type.
    
    See Also:
    
    IdentityProviderTypeType
  - withProviderType
```
public IdentityProviderType withProviderType(IdentityProviderTypeType providerType)
```
    The identity provider type.
    
    Parameters:
    
    providerType - The identity provider type.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    IdentityProviderTypeType
  - getProviderDetails
```
public Map<String,String> getProviderDetails()
```
    The identity provider details. The following list describes the provider detail keys for each identity provider 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
      
      authorize_scopes
    - For OIDC providers:
      
      client_id
      
      client_secret
      
      attributes_request_method
      
      oidc_issuer
      
      authorize_scopes
      
      authorize_url if not available from discovery URL specified by oidc_issuer key
      
      token_url if not available from discovery URL specified by oidc_issuer key
      
      attributes_url if not available from discovery URL specified by oidc_issuer key
      
      jwks_uri if not available from discovery URL specified by oidc_issuer key
      
      authorize_scopes
    - For SAML providers:
      
      MetadataFile OR MetadataURL
      
      IDPSignOut optional
    Returns:
    The identity provider details. The following list describes the provider detail keys for each identity provider 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
    
    authorize_scopes
    
    For OIDC providers:
    
    client_id
    
    client_secret
    
    attributes_request_method
    
    oidc_issuer
    
    authorize_scopes
    
    authorize_url if not available from discovery URL specified by oidc_issuer key
    
    token_url if not available from discovery URL specified by oidc_issuer key
    
    attributes_url if not available from discovery URL specified by oidc_issuer key
    
    jwks_uri if not available from discovery URL specified by oidc_issuer key
    
    authorize_scopes
    
    For SAML providers:
    
    MetadataFile OR MetadataURL
    
    IDPSignOut optional
  - setProviderDetails
```
public void setProviderDetails(Map<String,String> providerDetails)
```
    The identity provider details. The following list describes the provider detail keys for each identity provider 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
      
      authorize_scopes
    - For OIDC providers:
      
      client_id
      
      client_secret
      
      attributes_request_method
      
      oidc_issuer
      
      authorize_scopes
      
      authorize_url if not available from discovery URL specified by oidc_issuer key
      
      token_url if not available from discovery URL specified by oidc_issuer key
      
      attributes_url if not available from discovery URL specified by oidc_issuer key
      
      jwks_uri if not available from discovery URL specified by oidc_issuer key
      
      authorize_scopes
    - For SAML providers:
      
      MetadataFile OR MetadataURL
      
      IDPSignOut optional
    Parameters:
    providerDetails - The identity provider details. The following list describes the provider detail keys for each identity provider 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
    
    authorize_scopes
    
    For OIDC providers:
    
    client_id
    
    client_secret
    
    attributes_request_method
    
    oidc_issuer
    
    authorize_scopes
    
    authorize_url if not available from discovery URL specified by oidc_issuer key
    
    token_url if not available from discovery URL specified by oidc_issuer key
    
    attributes_url if not available from discovery URL specified by oidc_issuer key
    
    jwks_uri if not available from discovery URL specified by oidc_issuer key
    
    authorize_scopes
    
    For SAML providers:
    
    MetadataFile OR MetadataURL
    
    IDPSignOut optional
  - withProviderDetails
```
public IdentityProviderType withProviderDetails(Map<String,String> providerDetails)
```
    The identity provider details. The following list describes the provider detail keys for each identity provider 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
      
      authorize_scopes
    - For OIDC providers:
      
      client_id
      
      client_secret
      
      attributes_request_method
      
      oidc_issuer
      
      authorize_scopes
      
      authorize_url if not available from discovery URL specified by oidc_issuer key
      
      token_url if not available from discovery URL specified by oidc_issuer key
      
      attributes_url if not available from discovery URL specified by oidc_issuer key
      
      jwks_uri if not available from discovery URL specified by oidc_issuer key
      
      authorize_scopes
    - For SAML providers:
      
      MetadataFile OR MetadataURL
      
      IDPSignOut optional
    Parameters:
    providerDetails - The identity provider details. The following list describes the provider detail keys for each identity provider 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
    
    authorize_scopes
    
    For OIDC providers:
    
    client_id
    
    client_secret
    
    attributes_request_method
    
    oidc_issuer
    
    authorize_scopes
    
    authorize_url if not available from discovery URL specified by oidc_issuer key
    
    token_url if not available from discovery URL specified by oidc_issuer key
    
    attributes_url if not available from discovery URL specified by oidc_issuer key
    
    jwks_uri if not available from discovery URL specified by oidc_issuer key
    
    authorize_scopes
    
    For SAML providers:
    
    MetadataFile OR MetadataURL
    
    IDPSignOut optional
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - addProviderDetailsEntry
```
public IdentityProviderType addProviderDetailsEntry(String key,
                                                    String value)
```
    Add a single ProviderDetails entry
    
    See Also:
    
    withProviderDetails(java.util.Map<java.lang.String, java.lang.String>)
  - clearProviderDetailsEntries
```
public IdentityProviderType clearProviderDetailsEntries()
```
    Removes all the entries added into ProviderDetails.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getAttributeMapping
```
public Map<String,String> getAttributeMapping()
```
    A mapping of identity provider attributes to standard and custom user pool attributes.
    
    Returns:
    
    A mapping of identity provider attributes to standard and custom user pool attributes.
  - setAttributeMapping
```
public void setAttributeMapping(Map<String,String> attributeMapping)
```
    A mapping of identity provider attributes to standard and custom user pool attributes.
    
    Parameters:
    
    attributeMapping - A mapping of identity provider attributes to standard and custom user pool attributes.
  - withAttributeMapping
```
public IdentityProviderType withAttributeMapping(Map<String,String> attributeMapping)
```
    A mapping of identity provider attributes to standard and custom user pool attributes.
    
    Parameters:
    
    attributeMapping - A mapping of identity provider attributes to standard and custom user pool attributes.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - addAttributeMappingEntry
```
public IdentityProviderType addAttributeMappingEntry(String key,
                                                     String value)
```
    Add a single AttributeMapping entry
    
    See Also:
    
    withAttributeMapping(java.util.Map<java.lang.String, java.lang.String>)
  - clearAttributeMappingEntries
```
public IdentityProviderType clearAttributeMappingEntries()
```
    Removes all the entries added into AttributeMapping.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getIdpIdentifiers
```
public List<String> getIdpIdentifiers()
```
    A list of identity provider identifiers.
    
    Returns:
    
    A list of identity provider identifiers.
  - setIdpIdentifiers
```
public void setIdpIdentifiers(Collection<String> idpIdentifiers)
```
    A list of identity provider identifiers.
    
    Parameters:
    
    idpIdentifiers - A list of identity provider identifiers.
  - withIdpIdentifiers
```
public IdentityProviderType withIdpIdentifiers(String... idpIdentifiers)
```
    A list of identity provider identifiers.
    
    NOTE: This method appends the values to the existing list (if any). Use setIdpIdentifiers(java.util.Collection) or withIdpIdentifiers(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    idpIdentifiers - A list of identity provider identifiers.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withIdpIdentifiers
```
public IdentityProviderType withIdpIdentifiers(Collection<String> idpIdentifiers)
```
    A list of identity provider identifiers.
    
    Parameters:
    
    idpIdentifiers - A list of identity provider identifiers.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setLastModifiedDate
```
public void setLastModifiedDate(Date lastModifiedDate)
```
    The date the identity provider was last modified.
    
    Parameters:
    
    lastModifiedDate - The date the identity provider was last modified.
  - getLastModifiedDate
```
public Date getLastModifiedDate()
```
    The date the identity provider was last modified.
    
    Returns:
    
    The date the identity provider was last modified.
  - withLastModifiedDate
```
public IdentityProviderType withLastModifiedDate(Date lastModifiedDate)
```
    The date the identity provider was last modified.
    
    Parameters:
    
    lastModifiedDate - The date the identity provider was last modified.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setCreationDate
```
public void setCreationDate(Date creationDate)
```
    The date the identity provider was created.
    
    Parameters:
    
    creationDate - The date the identity provider was created.
  - getCreationDate
```
public Date getCreationDate()
```
    The date the identity provider was created.
    
    Returns:
    
    The date the identity provider was created.
  - withCreationDate
```
public IdentityProviderType withCreationDate(Date creationDate)
```
    The date the identity provider was created.
    
    Parameters:
    
    creationDate - The date the identity provider was created.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - toString
```
public 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
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public IdentityProviderType clone()
```
    Overrides:
    
    clone in class Object
  - marshall
```
public void marshall(ProtocolMarshaller protocolMarshaller)
```
    Description copied from interface: StructuredPojo
    
    Marshalls this structured data using the given ProtocolMarshaller.
    
    Specified by:
    
    marshall in interface StructuredPojo
    
    Parameters:
    
    protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.

Did this page help you?

Class IdentityProviderType

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

IdentityProviderType

Method Detail

setUserPoolId

getUserPoolId

withUserPoolId

setProviderName

getProviderName

withProviderName

setProviderType

getProviderType

withProviderType

setProviderType

withProviderType

getProviderDetails

setProviderDetails

withProviderDetails

addProviderDetailsEntry

clearProviderDetailsEntries

getAttributeMapping

setAttributeMapping

withAttributeMapping

addAttributeMappingEntry

clearAttributeMappingEntries

getIdpIdentifiers

setIdpIdentifiers

withIdpIdentifiers

withIdpIdentifiers

setLastModifiedDate

getLastModifiedDate

withLastModifiedDate

setCreationDate

getCreationDate

withCreationDate

toString

equals

hashCode

clone

marshall