Abilities

Overview

Control registered WordPress abilities. Routes use /wp-json/aam/v2 on a standard WordPress installation.

Endpoints

Method Route Input Purpose
GET /abilities — Get items.
DELETE /abilities — Reset items.
GET /ability resource Get item.
PATCH /ability resource, effect Update item.
DELETE /ability resource Reset item.
PATCH (Premium) /ability-access/mode effect Set access mode.

PATCH rows also accept POST and PUT because WordPress registers them as editable routes. The Input column lists route-specific parameters. A path parameter in {braces} is required. WordPress validates body and query parameters against the registered route schema. Premium rows require the Complete Package add-on.

Parameter guide

The route table shows which operation uses each parameter. Path parameters are required; other requirements depend on the operation.

Parameter Type Meaning
effect string Default access effect.
resource string Registered ability name.

Access level and authorization

Most routes accept access_level=role&role_id=editor, access_level=user&user_id=42, access_level=visitor, or access_level=default. This selects whose rules you read or change. A path ID or body value selects the target.

Required permission: aam_manager and aam_manage_abilities. See Authentication and Error handling.

Example

GET /wp-json/aam/v2/abilities?access_level=role&role_id=editor
Authorization: Basic <base64 username:application-password>

This lists registered abilities and their rules for the Editor role.