Documentation

Mistake on this page? Email us

Policy Policy This object represents a feature policy. Either the feature or the resource must be specified.

Hierarchy

Index

Constructors

constructor

  • new Policy(init: Partial<Policy>): Policy
  • Parameters

    • init: Partial<Policy>

    Returns Policy

Properties

action

action: string

Comma-separated list of actions, empty string represents all actions. Comma separated list of actions, empty string represents all actions.

example

GET

allow

allow: boolean

True or false controlling whether an action is allowed or not. True or false controlling whether an action is allowed or not.

example

true

feature

feature: string

Feature name corresponding to this policy. Feature name corresponding to this policy.

example

update-campaigns

id

id: string

The unique identifier of the entity

inherited

inherited: boolean

Flag indicating whether this feature is inherited or overwritten specifically.

inheritedFrom

inheritedFrom: string

An ID indicating where this policy is inherited from.

example

016ada3ec2d46665bf66e32e00000000

inheritedType

inheritedType: PolicyInheritedType

Indicates the type of entity this policy is inherited from.

example

account

resource

resource: string

Resource that is protected by this policy. Resource that is protected by this policy.

example

/v3/update-campaign