Skip to main content

Delete permissions

This endpoint allows you to remove existing permissions from an access on specific resources.

Endpoint

POST /user/v1/authz/{access}/permissions/delete

Prerequisites

  • Valid API token authentication
  • Required roles: WEBSERVICE_USER_RW and WEBSERVICE_DNS_R
  • The access must belong to the user's scope

Parameters

NameLocationRequiredTypeDescription
accessPathYesStringID of the access
permissionsBodyYesArrayPermissions to delete

Validation constraints

  • permissions.*.resource.type: Required - Resource type
  • permissions.*.resource.ids: Required - Array of resource IDs
    • Minimum 1 element
    • Values must be unique
  • permissions.*.resource.ids.*: String
  • permissions.*.capabilities: Required - Array of capabilities
    • Minimum 1 element
    • Values must be unique
  • permissions.*.capabilities.*: String
    • Accepted values: can_view_zone_content, can_edit_zone_content

Example request

{
"permissions": [
{
"resource": {
"type": "zone",
"ids": ["example.com"]
},
"capabilities": ["can_edit_zone_content"]
}
]
}

Example response

{
"message": "OK"
}

General constraints

  • Resource type: Currently, only the zone type is supported
  • Validation: Zone names are verified with the DNS API
  • Uniqueness: Uniqueness rule applied to arrays of IDs and capabilities

Error handling

  • Success: HTTP 200 with "message": "OK"
  • Error: HTTP 400 with details in the errors field