Sign in

v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-1480317256.9 KB

Tests whether the given impersonation role can impersonate a target user.

post/#X-Amz-Target=WorkMailService.GetImpersonationRoleEffect

Headers

X-Amz-Target'WorkMailService.GetImpersonationRoleEffect' required

Request body

OrganizationIdstring required

The WorkMail organization where the impersonation role is defined.

ImpersonationRoleIdstring required

The impersonation role ID to test.

TargetUserstring required
<p>The WorkMail organization user chosen to test the impersonation role. The following identity formats are available:</p> <ul> <li> <p>User ID: <code>12345678-1234-1234-1234-123456789012</code> or <code>S-1-1-12-1234567890-123456789-123456789-1234</code> </p> </li> <li> <p>Email address: <code>user@domain.tld</code> </p> </li> <li> <p>User name: <code>user</code> </p> </li> </ul>

Response

Success

Type'FULL_ACCESS' | 'READ_ONLY'

The impersonation role type.

Effect'ALLOW' | 'DENY'

<code/>Effect of the impersonation role on the target user based on its rules. Available effects are <code>ALLOW</code> or <code>DENY</code>.