Resolve Tenant Email Policy Overrides

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

Resolves tenant-level email policy overrides. Email policies support default values; therefore, if tenant-level overrides are enabled and no overrides are defined at the tenant level, this API will return the defaults instead.

Tenant-level email policy overrides can be defined per email policy type. Therefore, within a tenant, some email types may be overridden, while others may still use default email policies.

Required Permissions

Below is the list of required permissions needed to interact with this API. For each permission, the allowed permission boundaries are also specified.

PermissionBoundaryDescription
email-policy:readApplicationThe subject can perform this request if the tenant specified in the URL path is associated with the subject's application.
TenantThe subject can perform this request if they are associated with the tenant specified in the URL path.
Tenant Inclusion ListThe subject can perform this request if the tenant specified in the URL path is included in the tenant inclusion list.
Tenant Exclusion ListThe subject can perform this request if the tenant specified in the URL path belongs to the subject's associated application and is not included in the tenant exclusion list.
Path Params
string
required
length between 1 and 26

The ID of the tenant that the resource or action is scoped to.

Query Params
string
enum
length between 1 and 60

Allows filtering the resolved email policy overrides to a specific email type

string
length ≥ 0
Defaults to *

List of resource fields that should be returned in a response. The wildcard value of * can be used to return all fields for the resource.

boolean
Defaults to true

Boolean indicating if the resolve API should recurse the tenant's ancestors for the case where tenant level overrides are disabled. If set to "false", then this API will only resolve the overrides for the tenant level regardless of whether tenant level overrides are enabled or not.

Responses

Language
Credentials
Bearer
JWT
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json