Skip to main content

policy

Returns a Policy by ID.

Arguments

  • id required ID


Returns

Nullable Policy

The Policy type. It governs an Application's access to a Metric's data.

  • policy.id non-null ID

    The Policy's unique identifier.

  • policy.account non-null Account

    The Policy's Account.

  • policy.environment non-null Environment

    The Policy's Environment.

  • policy.createdAt non-null DateTime

    The Policy's creation date and time in UTC.

  • policy.modifiedAt non-null DateTime

    The Policy's last modification date and time in UTC.

  • policy.createdBy non-null String

    The Policy's creator. It can be either a User ID, an Application ID, or "system" if it was created by Propel.

  • policy.modifiedBy non-null String

    The Policy's last modifier. It can be either a User ID, an Application ID, or "system" if it was modified by Propel.

  • policy.type non-null PolicyType

    The type of Policy.

    The types of Policies that can be applied to a Metric.

    • ALL_ACCESS

      Grants access to all Metric data.

    • TENANT_ACCESS

      Grants access to a specified tenant's Metric data.

  • policy.application non-null Application

    The Application that is granted access.

  • policy.metric non-null Metric

    The Metric that the Application is granted access to.