IdentityProvider (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.workspacesweb.model.IdentityProvider

All Implemented Interfaces:: StructuredPojo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class IdentityProvider
extends Object
implements Serializable, Cloneable, StructuredPojo

The identity provider.

See Also:: AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

IdentityProvider()

Constructors
Constructor and Description
`IdentityProvider()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`IdentityProvider`	`addIdentityProviderDetailsEntry(String key, String value)` Add a single IdentityProviderDetails entry
`IdentityProvider`	`clearIdentityProviderDetailsEntries()` Removes all the entries added into IdentityProviderDetails.
`IdentityProvider`	`clone()`
`boolean`	`equals(Object obj)`
`String`	`getIdentityProviderArn()` The ARN of the identity provider.
`Map<String,String>`	`getIdentityProviderDetails()` The identity provider details.
`String`	`getIdentityProviderName()` The identity provider name.
`String`	`getIdentityProviderType()` The identity provider type.
`int`	`hashCode()`
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setIdentityProviderArn(String identityProviderArn)` The ARN of the identity provider.
`void`	`setIdentityProviderDetails(Map<String,String> identityProviderDetails)` The identity provider details.
`void`	`setIdentityProviderName(String identityProviderName)` The identity provider name.
`void`	`setIdentityProviderType(String identityProviderType)` The identity provider type.
`String`	`toString()` Returns a string representation of this object.
`IdentityProvider`	`withIdentityProviderArn(String identityProviderArn)` The ARN of the identity provider.
`IdentityProvider`	`withIdentityProviderDetails(Map<String,String> identityProviderDetails)` The identity provider details.
`IdentityProvider`	`withIdentityProviderName(String identityProviderName)` The identity provider name.
`IdentityProvider`	`withIdentityProviderType(IdentityProviderType identityProviderType)` The identity provider type.
`IdentityProvider`	`withIdentityProviderType(String identityProviderType)` The identity provider type.

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

- Constructor Detail
  - IdentityProvider
```
public IdentityProvider()
```
- Method Detail
  - setIdentityProviderArn
```
public void setIdentityProviderArn(String identityProviderArn)
```
    The ARN of the identity provider.
    
    Parameters:
    
    identityProviderArn - The ARN of the identity provider.
  - getIdentityProviderArn
```
public String getIdentityProviderArn()
```
    The ARN of the identity provider.
    
    Returns:
    
    The ARN of the identity provider.
  - withIdentityProviderArn
```
public IdentityProvider withIdentityProviderArn(String identityProviderArn)
```
    The ARN of the identity provider.
    
    Parameters:
    
    identityProviderArn - The ARN of the identity provider.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getIdentityProviderDetails
```
public Map<String,String> getIdentityProviderDetails()
```
    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
    - 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
    
    For SAML providers:
    
    MetadataFile OR MetadataURL
    
    IDPSignout optional
  - setIdentityProviderDetails
```
public void setIdentityProviderDetails(Map<String,String> identityProviderDetails)
```
    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
    - For SAML providers:
      
      MetadataFile OR MetadataURL
      
      IDPSignout optional
    Parameters:
    identityProviderDetails - 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
    
    For SAML providers:
    
    MetadataFile OR MetadataURL
    
    IDPSignout optional
  - withIdentityProviderDetails
```
public IdentityProvider withIdentityProviderDetails(Map<String,String> identityProviderDetails)
```
    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
    - For SAML providers:
      
      MetadataFile OR MetadataURL
      
      IDPSignout optional
    Parameters:
    identityProviderDetails - 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
    
    For SAML providers:
    
    MetadataFile OR MetadataURL
    
    IDPSignout optional
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - addIdentityProviderDetailsEntry
```
public IdentityProvider addIdentityProviderDetailsEntry(String key,
                                                        String value)
```
    Add a single IdentityProviderDetails entry
    
    See Also:
    
    withIdentityProviderDetails(java.util.Map<java.lang.String, java.lang.String>)
  - clearIdentityProviderDetailsEntries
```
public IdentityProvider clearIdentityProviderDetailsEntries()
```
    Removes all the entries added into IdentityProviderDetails.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setIdentityProviderName
```
public void setIdentityProviderName(String identityProviderName)
```
    The identity provider name.
    
    Parameters:
    
    identityProviderName - The identity provider name.
  - getIdentityProviderName
```
public String getIdentityProviderName()
```
    The identity provider name.
    
    Returns:
    
    The identity provider name.
  - withIdentityProviderName
```
public IdentityProvider withIdentityProviderName(String identityProviderName)
```
    The identity provider name.
    
    Parameters:
    
    identityProviderName - The identity provider name.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setIdentityProviderType
```
public void setIdentityProviderType(String identityProviderType)
```
    The identity provider type.
    
    Parameters:
    
    identityProviderType - The identity provider type.
    
    See Also:
    
    IdentityProviderType
  - getIdentityProviderType
```
public String getIdentityProviderType()
```
    The identity provider type.
    
    Returns:
    
    The identity provider type.
    
    See Also:
    
    IdentityProviderType
  - withIdentityProviderType
```
public IdentityProvider withIdentityProviderType(String identityProviderType)
```
    The identity provider type.
    
    Parameters:
    
    identityProviderType - The identity provider type.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    IdentityProviderType
  - withIdentityProviderType
```
public IdentityProvider withIdentityProviderType(IdentityProviderType identityProviderType)
```
    The identity provider type.
    
    Parameters:
    
    identityProviderType - The identity provider type.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    IdentityProviderType
  - 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 IdentityProvider 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 IdentityProvider

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

IdentityProvider

Method Detail

setIdentityProviderArn

getIdentityProviderArn

withIdentityProviderArn

getIdentityProviderDetails

setIdentityProviderDetails

withIdentityProviderDetails

addIdentityProviderDetailsEntry

clearIdentityProviderDetailsEntries

setIdentityProviderName

getIdentityProviderName

withIdentityProviderName

setIdentityProviderType

getIdentityProviderType

withIdentityProviderType

withIdentityProviderType

toString

equals

hashCode

clone

marshall