identity_provider_configurations

Creates, updates, deletes, gets or lists an identity_provider_configurations resource.

Overview

Name	identity_provider_configurations
Type	Resource
Id	aws.workmail.identity_provider_configurations

Fields

The following fields are returned by SELECT queries:

describe_identity_provider_configuration

Name	Datatype	Description
authentication_mode	string	The authentication mode used in WorkMail. (IDENTITY_PROVIDER_ONLY, IDENTITY_PROVIDER_AND_DIRECTORY)
identity_center_configuration	object	The details of the IAM Identity Center configuration.
personal_access_token_configuration	object	The details of the Personal Access Token configuration.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
describe_identity_provider_configuration	select	region		Returns detailed information on the current IdC setup for the WorkMail organization.
put_identity_provider_configuration	replace	region, OrganizationId, AuthenticationMode, IdentityCenterConfiguration, PersonalAccessTokenConfiguration		Enables integration between IAM Identity Center (IdC) and WorkMail to proxy authentication requests for mailbox users. You can connect your IdC directory or your external directory to WorkMail through IdC and manage access to WorkMail mailboxes in a single place. For enhanced protection, you could enable Multifactor Authentication (MFA) and Personal Access Tokens.
delete_identity_provider_configuration	delete	region		Disables the integration between IdC and WorkMail. Authentication will continue with the directory as it was before the IdC integration. You might have to reset your directory passwords and reconfigure your desktop and mobile email clients.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
region	string	AWS region (default: us-east-1)

SELECT examples

describe_identity_provider_configuration

Returns detailed information on the current IdC setup for the WorkMail organization.

SELECT
authentication_mode,
identity_center_configuration,
personal_access_token_configuration
FROM aws.workmail.identity_provider_configurations
WHERE region = '{{ region }}' -- required
;

REPLACE examples

put_identity_provider_configuration

Enables integration between IAM Identity Center (IdC) and WorkMail to proxy authentication requests for mailbox users. You can connect your IdC directory or your external directory to WorkMail through IdC and manage access to WorkMail mailboxes in a single place. For enhanced protection, you could enable Multifactor Authentication (MFA) and Personal Access Tokens.

REPLACE aws.workmail.identity_provider_configurations
SET 
OrganizationId = '{{ OrganizationId }}',
AuthenticationMode = '{{ AuthenticationMode }}',
IdentityCenterConfiguration = '{{ IdentityCenterConfiguration }}',
PersonalAccessTokenConfiguration = '{{ PersonalAccessTokenConfiguration }}'
WHERE 
region = '{{ region }}' --required
AND OrganizationId = '{{ OrganizationId }}' --required
AND AuthenticationMode = '{{ AuthenticationMode }}' --required
AND IdentityCenterConfiguration = '{{ IdentityCenterConfiguration }}' --required
AND PersonalAccessTokenConfiguration = '{{ PersonalAccessTokenConfiguration }}' --required;

DELETE examples

delete_identity_provider_configuration

Disables the integration between IdC and WorkMail. Authentication will continue with the directory as it was before the IdC integration. You might have to reset your directory passwords and reconfigure your desktop and mobile email clients.

DELETE FROM aws.workmail.identity_provider_configurations
WHERE region = '{{ region }}' --required
;