policy

Get correspondent policy

Read the correspondent policy for a scope (account by default, or a pod/inbox). Returns the mode this scope sets for each direction, the effective mode after inheritance, this scope's own rules, and the rules inherited from parent scopes. Inbox-scoped keys are rejected. A pod-scoped key may read its own pod or an inbox in that pod, never account-wide policy. Account-wide keys may read any scope.

get/v1/policy

Request

  • Base URL: https://api.openmail.sh
  • URL: https://api.openmail.sh/v1/policy
  • Auth: HTTP bearer

Query parameters

podIdstring

Confine the operation to one pod's policy. Accepts the pod ID. Mutually exclusive with inboxId.

inboxIdstring

Confine the operation to one inbox's policy. Mutually exclusive with podId.

Response

The resolved policy for the scope

object required

The resolved policy for the scope

Changes

No recorded changes to this operation across all 1 revision of this API.