Package software.amazon.awssdk.services.workspacesweb.model

Interface IdentityProvider.Builder

All Superinterfaces:

Buildable, CopyableBuilder<IdentityProvider.Builder,IdentityProvider>, SdkBuilder<IdentityProvider.Builder,IdentityProvider>, SdkPojo

Enclosing class:

IdentityProvider

public static interface IdentityProvider.Builder
extends SdkPojo, CopyableBuilder<IdentityProvider.Builder,IdentityProvider>

Method Summary

Modifier and Type	Method	Description
IdentityProvider.Builder	identityProviderArn(String identityProviderArn)	The ARN of the identity provider.
IdentityProvider.Builder	identityProviderDetails(Map<String,String> identityProviderDetails)	The identity provider details.
IdentityProvider.Builder	identityProviderName(String identityProviderName)	The identity provider name.
IdentityProvider.Builder	identityProviderType(String identityProviderType)	The identity provider type.
IdentityProvider.Builder	identityProviderType(IdentityProviderType identityProviderType)	The identity provider type.

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

copy

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

applyMutation, build

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFieldNameToField, sdkFields

Method Detail

identityProviderArn

IdentityProvider.Builder identityProviderArn(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.

identityProviderDetails

IdentityProvider.Builder identityProviderDetails(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 (boolean) optional

  • IDPInit (boolean) optional

  • RequestSigningAlgorithm (string) optional - Only accepts rsa-sha256

  • EncryptedResponses (boolean) 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 (boolean) optional

  • IDPInit (boolean) optional

  • RequestSigningAlgorithm (string) optional - Only accepts rsa-sha256

  • EncryptedResponses (boolean) optional

Returns:

Returns a reference to this object so that method calls can be chained together.

identityProviderName

IdentityProvider.Builder identityProviderName(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.

identityProviderType

IdentityProvider.Builder identityProviderType(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, IdentityProviderType

identityProviderType

IdentityProvider.Builder identityProviderType(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, IdentityProviderType