Read Custom Scope

Testing

GET

/scopes/{name}

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

OperationId:readCustomScope

Returns one custom scope definition by name.

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 ********************

Path Params

Responses

🟢200OK

application/json

The custom scope.

Bodyapplication/json

🟠403Forbidden

🟠404Record Not Found

Request Example

Shell

JavaScript

Java

Swift

curl --location 'https://awqacore01.crexendocloud.com/ns-api/v2/scopes/' \
--header 'Authorization: Bearer <token>'

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

Count Custom Scopes

Update Custom Scope