Get permission context - ProxyScrape Docs

GET

account

api-keys

permission-context

Get permission context

curl --request GET \
  --url https://api.proxyscrape.com/v4/account/api-keys/permission-context \
  --header 'api-token: <api-key>'

{
  "structure": {
    "account": {
      "sub_types": [
        {
          "id": "<string>",
          "name": "<string>",
          "description": "<string>",
          "permissions": [
            {
              "id": "<string>",
              "name": "<string>",
              "description": "<string>",
              "enabled": true
            }
          ]
        }
      ]
    },
    "product": {
      "sub_types": [
        {
          "id": "<string>",
          "name": "<string>",
          "description": "<string>",
          "permissions": [
            {
              "id": "<string>",
              "name": "<string>",
              "description": "<string>",
              "enabled": true
            }
          ]
        }
      ]
    }
  },
  "allowed_permissions": [
    "<string>"
  ]
}

Authorizations

api-token

string

header

required

API key. Create and manage keys at /v4/account/api-keys or in the dashboard.

Response

Permission context with structure and allowed permissions

structure

object

Hierarchical permission structure filtered to only the permissions your account can assign.

Show child attributes

allowed_permissions

string[]

Flat list of permission strings you can assign

Get allowed permissionsReturns the flat list of permissions you may grant to API keys. Use this to populate a permissions UI or validate the `permissions` array when creating a key. Permission: `account:apikeys:read`.

Get permission context

curl --request GET \
  --url https://api.proxyscrape.com/v4/account/api-keys/permission-context \
  --header 'api-token: <api-key>'

{
  "structure": {
    "account": {
      "sub_types": [
        {
          "id": "<string>",
          "name": "<string>",
          "description": "<string>",
          "permissions": [
            {
              "id": "<string>",
              "name": "<string>",
              "description": "<string>",
              "enabled": true
            }
          ]
        }
      ]
    },
    "product": {
      "sub_types": [
        {
          "id": "<string>",
          "name": "<string>",
          "description": "<string>",
          "permissions": [
            {
              "id": "<string>",
              "name": "<string>",
              "description": "<string>",
              "enabled": true
            }
          ]
        }
      ]
    }
  },
  "allowed_permissions": [
    "<string>"
  ]
}