Get settings category scope access

GET

/api/admin/settings/meta/{category}/scope

Code sample: Shell / cURL

curl --request GET \
  --url https://auth.example.com/api/admin/settings/meta/example/scope \
  --header 'Authorization: Bearer <token>'

Returns only the setting scopes that the current admin can view or edit for the category.

Authorizations

• adminBearer
• adminSessionCookie

Parameters

Path Parameters

category

required

string

Settings category name.

Responses

200

Accessible scopes and permissions.

Media type application/json

object

key

additional properties

Example

{
  "allowedScopes": [
    "tenant",
    "platform"
  ],
  "userPermissions": {
    "tenant": "edit",
    "platform": "view"
  }
}

400

Error response.

Media type application/json

object

error

string

message

string

error_description

string

key

additional properties

Example ^generated

{
  "error": "example",
  "message": "example",
  "error_description": "example"
}

401

Error response.

Media type application/json

object

error

string

message

string

error_description

string

key

additional properties

Example ^generated

{
  "error": "example",
  "message": "example",
  "error_description": "example"
}

403

Error response.

Media type application/json

object

error

string

message

string

error_description

string

key

additional properties

Example ^generated

{
  "error": "example",
  "message": "example",
  "error_description": "example"
}

404

Error response.

Media type application/json

object

error

string

message

string

error_description

string

key

additional properties

Example ^generated

{
  "error": "example",
  "message": "example",
  "error_description": "example"
}

500

Error response.

Media type application/json

object

error

string

message

string

error_description

string

key

additional properties

Example ^generated

{
  "error": "example",
  "message": "example",
  "error_description": "example"
}