Request Syntax Request Parameters Response Elements Errors See Also

PutIdentityProviderConfiguration

Important

End of support notice: On March 31, 2027, AWS will end support for Amazon WorkMail. After March 31, 2027, you will no longer be able to access the WorkMail console or WorkMail resources. For more information, see Amazon WorkMail end of support.

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.

Request Syntax


{
   "AuthenticationMode": "string",
   "IdentityCenterConfiguration": { 
      "ApplicationArn": "string",
      "InstanceArn": "string"
   },
   "OrganizationId": "string",
   "PersonalAccessTokenConfiguration": { 
      "LifetimeInDays": number,
      "Status": "string"
   }
}

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

AuthenticationMode

The authentication mode used in WorkMail.

Type: String

Valid Values: IDENTITY_PROVIDER_ONLY | IDENTITY_PROVIDER_AND_DIRECTORY

Required: Yes

IdentityCenterConfiguration

The details of the IAM Identity Center configuration.

Type: IdentityCenterConfiguration object

Required: Yes

OrganizationId

The ID of the WorkMail Organization.

Type: String

Length Constraints: Fixed length of 34.

Pattern: ^m-[0-9a-f]{32}$

Required: Yes

PersonalAccessTokenConfiguration

The details of the Personal Access Token configuration.

Type: PersonalAccessTokenConfiguration object

Required: Yes

Response Elements

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

Errors

For information about the errors that are common to all actions, see Common Error Types.

InvalidParameterException

Important

One or more of the input parameters don't match the service's restrictions.

HTTP Status Code: 400

OrganizationNotFoundException

Important

An operation received a valid organization identifier that either doesn't belong or exist in the system.

HTTP Status Code: 400

OrganizationStateException

Important

The organization must have a valid state to perform certain operations on the organization or its members.

HTTP Status Code: 400

ResourceNotFoundException

Important

The resource cannot be found.

HTTP Status Code: 400