OPopal
access-rules

PUT /access-rules/{access_rule_id}

Changed on

Updates the access rule config for the given group_id.

Request

  • Base URL
    https://api.opal.dev/v1
  • Auth
    HTTP bearer

Path parameters

access_rule_idstring uuid required

The access rule ID (group ID) of the access rule.

Request body

namestring required

The name of the access rule.

descriptionstring required

A description of the group.

admin_owner_idstring uuid required

The ID of the owner of the group.

status'ACTIVE' | 'PAUSED' required

The status of the access rule.

Example request

{
  "name": "Platform Engineering",
  "description": "This access rule represents all platform engineers in the company.",
  "admin_owner_id": "7c86c85d-0651-43e2-a748-d69d658418e8",
  "status": "ACTIVE"
}

Response

The updated access rule config for the group.

access_rule_idstring uuid required

The ID (group ID) of the access rule.

namestring required

The name of the access rule.

descriptionstring required

A description of the group.

admin_owner_idstring uuid required

The ID of the owner of the group.

status'ACTIVE' | 'PAUSED' required

The status of the access rule.

Example response

{
  "access_rule_id": "7c86c85d-0651-43e2-a748-d69d658418e8",
  "name": "Platform Engineering",
  "description": "This access rule represents all platform engineers in the company.",
  "admin_owner_id": "7c86c85d-0651-43e2-a748-d69d658418e8",
  "status": "ACTIVE"
}

Changes

  • 327ea741c867Revision changes
    • info

      added the new optional request property ////

    • info

      added the new optional request property ////

    • info

      added the optional property //// to the response with the status

    • info

      added the optional property //// to the response with the status