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

Description¶

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

Usage¶

workmail_get_impersonation_role_effect(OrganizationId,
  ImpersonationRoleId, TargetUser)

Arguments¶

• OrganizationId

  [required] The WorkMail organization where the impersonation role is defined.

• ImpersonationRoleId

  [required] The impersonation role ID to test.

• TargetUser

  [required] The WorkMail organization user chosen to test the impersonation role. The following identity formats are available:

  • User ID: 12345678-1234-1234-1234-123456789012 or S-1-1-12-1234567890-123456789-123456789-1234
  • Email address: user@domain.tld
  • User name: user

Value¶

A list with the following syntax:

list(
  Type = "FULL_ACCESS"|"READ_ONLY",
  Effect = "ALLOW"|"DENY",
  MatchedRules = list(
    list(
      ImpersonationRuleId = "string",
      Name = "string"
    )
  )
)

Request syntax¶

svc$get_impersonation_role_effect(
  OrganizationId = "string",
  ImpersonationRoleId = "string",
  TargetUser = "string"
)