Roles (admin API)

Admin routes of the roles module. Every route needs a staff session and the permission named on it; send X-Resolve-Locale: false to receive every locale of a translatable field for editing.

GET /v1/admin/roles

List all roles

Responses:

• 200: Roles retrieved.
• 401: Unauthorized.
• 403: Insufficient permissions.

POST /v1/admin/roles

Create new role

Request body: CreateRoleDto.

Responses:

• 201: Role created.
• 400: Invalid input.
• 401: Unauthorized.
• 403: Insufficient permissions.

PATCH /v1/admin/roles/{id}

Update role permissions

Parameters:

• id in path (string, required).

Request body: UpdateRolePermissionsDto.

Responses:

• 200: Role permissions updated.
• 400: Invalid input.
• 401: Unauthorized.
• 403: Insufficient permissions.
• 404: Role not found.

Schemas

CreateRoleDto

• name (string, max length 50, required).
• description (string, max length 255, optional).
• permissions (array of "admin_users:create", "admin_users:delete", "admin_users:manage", "admin_users:update", "admin_users:view", "analytics:create", "analytics:delete", "analytics:manage", "analytics:update", "analytics:view", "assets:create", "assets:delete", "assets:manage", "assets:update", "assets:view", "audit_log:create", "audit_log:delete", "audit_log:manage", "audit_log:update", "audit_log:view", "campaigns:create", "campaigns:delete", "campaigns:manage", "campaigns:update", "campaigns:view", "carriers:create", "carriers:delete", "carriers:manage", "carriers:update", "carriers:view", "categories:create", "categories:delete", "categories:manage", "categories:update", "categories:view", "checkout:create", "checkout:delete", "checkout:manage", "checkout:update", "checkout:view", "cms:create", "cms:delete", "cms:manage", "cms:update", "cms:view", "customers:create", "customers:delete", "customers:manage", "customers:update", "customers:view", "geo:create", "geo:delete", "geo:manage", "geo:update", "geo:view", "gift_cards:create", "gift_cards:delete", "gift_cards:manage", "gift_cards:update", "gift_cards:view", "inventory:create", "inventory:delete", "inventory:manage", "inventory:update", "inventory:view", "notifications:create", "notifications:delete", "notifications:manage", "notifications:update", "notifications:view", "orders:create", "orders:delete", "orders:manage", "orders:update", "orders:view", "payment_methods:create", "payment_methods:delete", "payment_methods:manage", "payment_methods:update", "payment_methods:view", "payments:create", "payments:delete", "payments:manage", "payments:update", "payments:view", "products:create", "products:delete", "products:manage", "products:update", "products:view", "promotions:create", "promotions:delete", "promotions:manage", "promotions:update", "promotions:view", "returns:create", "returns:delete", "returns:manage", "returns:update", "returns:view", "reviews:create", "reviews:delete", "reviews:manage", "reviews:update", "reviews:view", "search:create", "search:delete", "search:manage", "search:update", "search:view", "seo:create", "seo:delete", "seo:manage", "seo:update", "seo:view", "settings:create", "settings:delete", "settings:manage", "settings:update", "settings:view", "shipping:create", "shipping:delete", "shipping:manage", "shipping:update", "shipping:view", "storefront_config:create", "storefront_config:delete", "storefront_config:manage", "storefront_config:update", "storefront_config:view", required).

UpdateRolePermissionsDto

• permissions (array of "admin_users:create", "admin_users:delete", "admin_users:manage", "admin_users:update", "admin_users:view", "analytics:create", "analytics:delete", "analytics:manage", "analytics:update", "analytics:view", "assets:create", "assets:delete", "assets:manage", "assets:update", "assets:view", "audit_log:create", "audit_log:delete", "audit_log:manage", "audit_log:update", "audit_log:view", "campaigns:create", "campaigns:delete", "campaigns:manage", "campaigns:update", "campaigns:view", "carriers:create", "carriers:delete", "carriers:manage", "carriers:update", "carriers:view", "categories:create", "categories:delete", "categories:manage", "categories:update", "categories:view", "checkout:create", "checkout:delete", "checkout:manage", "checkout:update", "checkout:view", "cms:create", "cms:delete", "cms:manage", "cms:update", "cms:view", "customers:create", "customers:delete", "customers:manage", "customers:update", "customers:view", "geo:create", "geo:delete", "geo:manage", "geo:update", "geo:view", "gift_cards:create", "gift_cards:delete", "gift_cards:manage", "gift_cards:update", "gift_cards:view", "inventory:create", "inventory:delete", "inventory:manage", "inventory:update", "inventory:view", "notifications:create", "notifications:delete", "notifications:manage", "notifications:update", "notifications:view", "orders:create", "orders:delete", "orders:manage", "orders:update", "orders:view", "payment_methods:create", "payment_methods:delete", "payment_methods:manage", "payment_methods:update", "payment_methods:view", "payments:create", "payments:delete", "payments:manage", "payments:update", "payments:view", "products:create", "products:delete", "products:manage", "products:update", "products:view", "promotions:create", "promotions:delete", "promotions:manage", "promotions:update", "promotions:view", "returns:create", "returns:delete", "returns:manage", "returns:update", "returns:view", "reviews:create", "reviews:delete", "reviews:manage", "reviews:update", "reviews:view", "search:create", "search:delete", "search:manage", "search:update", "search:view", "seo:create", "seo:delete", "seo:manage", "seo:update", "seo:view", "settings:create", "settings:delete", "settings:manage", "settings:update", "settings:view", "shipping:create", "shipping:delete", "shipping:manage", "shipping:update", "shipping:view", "storefront_config:create", "storefront_config:delete", "storefront_config:manage", "storefront_config:update", "storefront_config:view", required).