Create Custom Scope

Testing

POST

/scopes

Last modified:2026-08-27 23:58:55

OperationId:createCustomScope

Creates a custom scope derived from a built-in parent. Modifications can only subtract — none removes an object, ro makes it read-only — so the new scope can never exceed its parent.

Writes are published on the internal event bus and applied cluster-wide; a 202 means "published", and the row is visible on each server once its event lands.

Requires Super User (reads also allow Super User Read Only) — enforced in the controller; scope_priv cannot express it.

Request

Authorization

Bearer Token

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Body Params application/jsonRequired

Examples

Responses

🟢202Accepted

application/json

Published. Echoes the accepted definition.

Bodyapplication/json

🟠400Bad Request

🟠403Forbidden

🟠409

Request Example

Shell

JavaScript

Java

Swift

curl --location 'https://awqacore01.crexendocloud.com/ns-api/v2/scopes' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
    "name": "Platform Manager",
    "parent-scope": "Super User",
    "description": "Ops admin — no platform config or routing changes",
    "modifications": {
        "nsconfig": "none",
        "route": "ro",
        "dialplan": "ro"
    }
}'

Response Example

{
    "name": "Platform Manager",
    "parent-scope": "Super User",
    "description": "Ops admin — no platform config or routing changes",
    "read-only": "no",
    "modifications": {
        "nsconfig": "none",
        "route": "ro",
        "device": "no-delete",
        "phonenumber": "update-only"
    },
    "enabled": "yes",
    "built-in": "yes"
}

Modified at 2026-08-27 23:58:55

List Custom Scopes

Count Custom Scopes