Interface AccessPolicy

All Known Implementing Classes:
AccessPolicyJson
public interface AccessPolicy
A project-scoped IAM access policy - a set of permissions that may be granted to principals, groups or other projects. Returned by the access policy operations (listAccessPolicies, createAccessPolicy, getAccessPolicy, updateAccessPolicy, enableAccessPolicy, disableAccessPolicy).

This is a read-only response view (spec schema AccessPolicy). The polymorphic UserRectSet permission entries are exposed as PolicyExpression values, each of which losslessly preserves whichever oneOf form (bare string id/ERN or structured inline-permission / reference object) was returned.

  • Method Details

    • getAccessPolicyId

      String getAccessPolicyId()
      Returns:
      the access policy identifier (e.g. accesspolicy:my-policy or a managed policy id)

    • getErn

      String getErn()
      Returns:
      the Equinix Resource Name (ERN) of the access policy

    • getDescription

      String getDescription()
      Returns:
      the description of the access policy (may be null)

    • getTags

      Map<String,String> getTags()
      Returns:
      the user-controlled tags on the policy

    • getPermissions

      List<PolicyExpression> getPermissions()
      Returns:
      the policy's permission set entries (polymorphic UserRectSet members), each as a lossless PolicyExpression

    • getIntersect

      List<PolicyExpression> getIntersect()
      Returns:
      the policy's intersect permission entries, each as a lossless PolicyExpression

    • getSubtract

      List<PolicyExpression> getSubtract()
      Returns:
      the policy's subtract permission entries, each as a lossless PolicyExpression

    • getRev

      String getRev()
      Returns:
      the opaque revision of the policy (used as lastRev for concurrency control)

    • getDisabledPolicy

      Boolean getDisabledPolicy()
      Returns:
      true when the policy is disabled, otherwise null

    • getManaged

      Boolean getManaged()
      Returns:
      true when the policy is managed, otherwise null

    • getCreatedBy

      String getCreatedBy()
      Returns:
      the principal that created the policy

    • getCreatedAt

      String getCreatedAt()
      Returns:
      the creation timestamp

    • getUpdatedBy

      String getUpdatedBy()
      Returns:
      the principal that last updated the policy

    • getUpdatedAt

      String getUpdatedAt()
      Returns:
      the last-updated timestamp

    • getApprovedAt

      String getApprovedAt()
      Returns:
      the approval timestamp (may be null)

    • getApprovedBy

      String getApprovedBy()
      Returns:
      the principal that approved the policy (may be null)