Options
All
  • Public
  • Public/Protected
  • All
Menu

Class OrganizationState

Represents the current organization state.

Hierarchy

  • OrganizationState

Index

Methods

getAccount

getPolicies

  • getPolicies(policyType: PolicyType): Policy[]

getPoliciesAttachedToTarget

  • getPoliciesAttachedToTarget(policyType: string, targetId: OrgEntityId): PolicyName[]
  • Get names of policies of given type attached directly to a target.

    Parameters

    • policyType: string
    • targetId: OrgEntityId

    Returns PolicyName[]

    names of policies of given type attached to a target

getPoliciesInheritedByTarget

  • getPoliciesInheritedByTarget(policyType: PolicyType, targetId: OrgEntityId): PolicyName[]
  • Get names of policies of given type inherited by a target.

    Parameters

    • policyType: PolicyType
    • targetId: OrgEntityId

    Returns PolicyName[]

    names of policies of given type inherited by a target

getPolicy

  • getPolicy(policyType: PolicyType, policyName: PolicyName): Policy | null
  • Get a policy by type and name, or null if no matching policy is found.

    Parameters

    • policyType: PolicyType
    • policyName: PolicyName

    Returns Policy | null

    policy of given type and name, or null if no matching policy is found

getPolicyId

  • getPolicyId(policyType: PolicyType, policyName: PolicyName): string
  • Get id of a policy by type and name, or throw an error if no matching policy is found.

    throws

    error if no policy is found

    Parameters

    • policyType: PolicyType
    • policyName: PolicyName

    Returns string

    policy of given type and name

setPolicy

  • setPolicy(policyType: PolicyType, policyName: PolicyName, policy: Policy): void

Generated using TypeDoc