software.amazon.awssdk.services.workspacesweb.model

Class IdentityProvider

java.lang.Object

software.amazon.awssdk.services.workspacesweb.model.IdentityProvider

All Implemented Interfaces:

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

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

The identity provider.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	IdentityProvider.Builder

Method Summary

Modifier and Type	Method and Description
static IdentityProvider.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasIdentityProviderDetails() For responses, this returns true if the service returned a value for the IdentityProviderDetails property.
String	identityProviderArn() The ARN of the identity provider.
Map<String,String>	identityProviderDetails() The identity provider details.
String	identityProviderName() The identity provider name.
IdentityProviderType	identityProviderType() The identity provider type.
String	identityProviderTypeAsString() The identity provider type.
List<SdkField<?>>	sdkFields()
static Class<? extends IdentityProvider.Builder>	serializableBuilderClass()
IdentityProvider.Builder	toBuilder()
String	toString() Returns a string representation of this object.

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

identityProviderArn

public final String identityProviderArn()

The ARN of the identity provider.

Returns:

The ARN of the identity provider.

hasIdentityProviderDetails

public final boolean hasIdentityProviderDetails()

For responses, this returns true if the service returned a value for the IdentityProviderDetails 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.

identityProviderDetails

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

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

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

identityProviderName

public final String identityProviderName()

The identity provider name.

Returns:

The identity provider name.

identityProviderType

public final IdentityProviderType identityProviderType()

The identity provider type.

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

Returns:

The identity provider type.

See Also:

IdentityProviderType

identityProviderTypeAsString

public final String identityProviderTypeAsString()

The identity provider type.

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

Returns:

The identity provider type.

See Also:

IdentityProviderType

toBuilder

public IdentityProvider.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<IdentityProvider.Builder,IdentityProvider>

builder

public static IdentityProvider.Builder builder()

serializableBuilderClass

public static Class<? extends IdentityProvider.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