PEpermit
Policy Guards (EAP)

Associate Policy Guard Scope

Changed on

associate a project to a Policy guard scope.

post/v2/policy_guards/scopes/{policy_guard_scope_id}/associate

Request

  • Base URL
    https://api.permit.io (the document declares no server; this is the origin it was published from)
  • Auth
    HTTP bearer

Path parameters

policy_guard_scope_idstring required

Either the unique id of the policy_guard_scope, or the URL-friendly key of the policy_guard_scope (i.e: the "slug").

Query parameters

waitnumber

Time in seconds to wait for the task to complete. Default is 0, means no wait.

Request body

project_idstring required

The unique identifier of the project of this policy scope.

Response

Successful Response

task_idstring required

The unique id of the task.

status'processing' | 'success' | 'failure' | 'cancelled' required

An enumeration.

Example response

{
  "result": {
    "id": "c3b6f5d7-8b1e-4c6d-9e9f-8c9d6f8e0c8f",
    "key": "policy_guard_acme",
    "org_id": "c3b6f5d7-8b1e-4c6d-9e9f-8c9d6f8e0c8f",
    "policy_guard_scope_details": [
      {
        "project_id": "c3b6f5d78b1e4c6d9e9f8c9d6f8e0c8f"
      }
    ]
  }
}

Changes