DescribeIdentityProviderConfiguration
Returns detailed information on the current IdC setup for the WorkMail organization.
Request Syntax
{
"OrganizationId": "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.
- OrganizationId
-
The Organization ID.
Type: String
Length Constraints: Fixed length of 34.
Pattern:
^m-[0-9a-f]{32}$Required: Yes
Response Syntax
{
"AuthenticationMode": "string",
"IdentityCenterConfiguration": {
"ApplicationArn": "string",
"InstanceArn": "string"
},
"PersonalAccessTokenConfiguration": {
"LifetimeInDays": number,
"Status": "string"
}
}Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
- AuthenticationMode
-
The authentication mode used in WorkMail.
Type: String
Valid Values:
IDENTITY_PROVIDER_ONLY | IDENTITY_PROVIDER_AND_DIRECTORY - IdentityCenterConfiguration
-
The details of the IAM Identity Center configuration.
Type: IdentityCenterConfiguration object
- PersonalAccessTokenConfiguration
-
The details of the Personal Access Token configuration.
Type: PersonalAccessTokenConfiguration object
Errors
For information about the errors that are common to all actions, see Common Errors.
- InvalidParameterException
-
One or more of the input parameters don't match the service's restrictions.
HTTP Status Code: 400
- OrganizationNotFoundException
-
An operation received a valid organization identifier that either doesn't belong or exist in the system.
HTTP Status Code: 400
- OrganizationStateException
-
The organization must have a valid state to perform certain operations on the organization or its members.
HTTP Status Code: 400
- ResourceNotFoundException
-
The resource cannot be found.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
