List Permission Groups

client.Accounts.Tokens.PermissionGroups.List(ctx, params) (*SinglePage[TokenPermissionGroupListResponse], error)

GET/accounts/{account_id}/tokens/permission_groups

Find all available permission groups for Account Owned API Tokens

Security

API Token

The preferred authorization scheme for interacting with the Cloudflare API. Create a token.

Example:Authorization: Bearer Sn3lZJTBX6kkg7OdcBUAxOO963GEIyGQqnFTOFYY

Accepted Permissions (at least one required)

Account API Tokens WriteAccount API Tokens Read

ParametersExpand Collapse

params TokenPermissionGroupListParams

AccountID param.Field[string]

Path param: Account identifier tag.

maxLength32

minLength32

Name param.Field[string]Optional

Query param: Filter by the name of the permission group. The value must be URL-encoded.

Scope param.Field[string]Optional

Query param: Filter by the scope of the permission group. The value must be URL-encoded.

ReturnsExpand Collapse

type TokenPermissionGroupListResponse struct{…}

ID stringOptional

Public ID.

Category TokenPermissionGroupListResponseCategoryOptional

Product category that this permission group belongs to.

One of the following:

const TokenPermissionGroupListResponseCategoryDeveloperPlatform TokenPermissionGroupListResponseCategory = "developer_platform"

const TokenPermissionGroupListResponseCategoryAIAndMachineLearning TokenPermissionGroupListResponseCategory = "ai_and_machine_learning"

const TokenPermissionGroupListResponseCategoryDNSAndZones TokenPermissionGroupListResponseCategory = "dns_and_zones"

const TokenPermissionGroupListResponseCategoryAppSecurity TokenPermissionGroupListResponseCategory = "app_security"

const TokenPermissionGroupListResponseCategoryRulesAndConfiguration TokenPermissionGroupListResponseCategory = "rules_and_configuration"

const TokenPermissionGroupListResponseCategoryCloudflareOneAndZeroTrust TokenPermissionGroupListResponseCategory = "cloudflare_one_and_zero_trust"

const TokenPermissionGroupListResponseCategoryAnalyticsAndLogs TokenPermissionGroupListResponseCategory = "analytics_and_logs"

const TokenPermissionGroupListResponseCategoryNetworkServices TokenPermissionGroupListResponseCategory = "network_services"

const TokenPermissionGroupListResponseCategoryMedia TokenPermissionGroupListResponseCategory = "media"

const TokenPermissionGroupListResponseCategoryEmailAndMessaging TokenPermissionGroupListResponseCategory = "email_and_messaging"

const TokenPermissionGroupListResponseCategoryCacheAndPerformance TokenPermissionGroupListResponseCategory = "cache_and_performance"

const TokenPermissionGroupListResponseCategoryAccountAndBilling TokenPermissionGroupListResponseCategory = "account_and_billing"

const TokenPermissionGroupListResponseCategoryOther TokenPermissionGroupListResponseCategory = "other"

Name stringOptional

Permission Group Name

Scopes []TokenPermissionGroupListResponseScopeOptional

Resources to which the Permission Group is scoped

One of the following:

const TokenPermissionGroupListResponseScopeComCloudflareAPIAccount TokenPermissionGroupListResponseScope = "com.cloudflare.api.account"

const TokenPermissionGroupListResponseScopeComCloudflareAPIAccountZone TokenPermissionGroupListResponseScope = "com.cloudflare.api.account.zone"

const TokenPermissionGroupListResponseScopeComCloudflareAPIUser TokenPermissionGroupListResponseScope = "com.cloudflare.api.user"

const TokenPermissionGroupListResponseScopeComCloudflareEdgeR2Bucket TokenPermissionGroupListResponseScope = "com.cloudflare.edge.r2.bucket"

List Permission Groups

package main

import (
  "context"
  "fmt"

  "github.com/stainless-sdks/cloudflare-go"
  "github.com/stainless-sdks/cloudflare-go/accounts"
  "github.com/stainless-sdks/cloudflare-go/option"
)

func main() {
  client := cloudflare.NewClient(
    option.WithAPIToken("Sn3lZJTBX6kkg7OdcBUAxOO963GEIyGQqnFTOFYY"),
  )
  page, err := client.Accounts.Tokens.PermissionGroups.List(context.TODO(), accounts.TokenPermissionGroupListParams{
    AccountID: cloudflare.F("023e105f4ecef8ad9ca31a8372d0c353"),
  })
  if err != nil {
    panic(err.Error())
  }
  fmt.Printf("%+v\n", page)
}

{
  "errors": [
    {
      "code": 1000,
      "message": "message",
      "documentation_url": "documentation_url",
      "source": {
        "pointer": "pointer"
      }
    }
  ],
  "messages": [
    {
      "code": 1000,
      "message": "message",
      "documentation_url": "documentation_url",
      "source": {
        "pointer": "pointer"
      }
    }
  ],
  "success": true,
  "result": [
    {
      "id": "7cf72faf220841aabcfdfab81c43c4f6",
      "category": "account_and_billing",
      "name": "Billing Read",
      "scopes": [
        "com.cloudflare.api.account"
      ]
    },
    {
      "id": "9d24387c6e8544e2bc4024a03991339f",
      "category": "network_services",
      "name": "Load Balancing: Monitors and Pools Read",
      "scopes": [
        "com.cloudflare.api.account"
      ]
    },
    {
      "id": "d2a1802cc9a34e30852f8b33869b2f3c",
      "category": "network_services",
      "name": "Load Balancing: Monitors and Pools Write",
      "scopes": [
        "com.cloudflare.api.account"
      ]
    },
    {
      "id": "8b47d2786a534c08a1f94ee8f9f599ef",
      "category": "developer_platform",
      "name": "Workers KV Storage Read",
      "scopes": [
        "com.cloudflare.api.account"
      ]
    },
    {
      "id": "f7f0eda5697f475c90846e879bab8666",
      "category": "developer_platform",
      "name": "Workers KV Storage Write",
      "scopes": [
        "com.cloudflare.api.account"
      ]
    },
    {
      "id": "1a71c399035b4950a1bd1466bbe4f420",
      "category": "developer_platform",
      "name": "Workers Scripts Read",
      "scopes": [
        "com.cloudflare.api.account"
      ]
    },
    {
      "id": "e086da7e2179491d91ee5f35b3ca210a",
      "category": "developer_platform",
      "name": "Workers Scripts Write",
      "scopes": [
        "com.cloudflare.api.account"
      ]
    }
  ],
  "result_info": {
    "count": 1,
    "page": 1,
    "per_page": 20,
    "total_count": 2000
  }
}

Returns Examples

{
  "errors": [
    {
      "code": 1000,
      "message": "message",
      "documentation_url": "documentation_url",
      "source": {
        "pointer": "pointer"
      }
    }
  ],
  "messages": [
    {
      "code": 1000,
      "message": "message",
      "documentation_url": "documentation_url",
      "source": {
        "pointer": "pointer"
      }
    }
  ],
  "success": true,
  "result": [
    {
      "id": "7cf72faf220841aabcfdfab81c43c4f6",
      "category": "account_and_billing",
      "name": "Billing Read",
      "scopes": [
        "com.cloudflare.api.account"
      ]
    },
    {
      "id": "9d24387c6e8544e2bc4024a03991339f",
      "category": "network_services",
      "name": "Load Balancing: Monitors and Pools Read",
      "scopes": [
        "com.cloudflare.api.account"
      ]
    },
    {
      "id": "d2a1802cc9a34e30852f8b33869b2f3c",
      "category": "network_services",
      "name": "Load Balancing: Monitors and Pools Write",
      "scopes": [
        "com.cloudflare.api.account"
      ]
    },
    {
      "id": "8b47d2786a534c08a1f94ee8f9f599ef",
      "category": "developer_platform",
      "name": "Workers KV Storage Read",
      "scopes": [
        "com.cloudflare.api.account"
      ]
    },
    {
      "id": "f7f0eda5697f475c90846e879bab8666",
      "category": "developer_platform",
      "name": "Workers KV Storage Write",
      "scopes": [
        "com.cloudflare.api.account"
      ]
    },
    {
      "id": "1a71c399035b4950a1bd1466bbe4f420",
      "category": "developer_platform",
      "name": "Workers Scripts Read",
      "scopes": [
        "com.cloudflare.api.account"
      ]
    },
    {
      "id": "e086da7e2179491d91ee5f35b3ca210a",
      "category": "developer_platform",
      "name": "Workers Scripts Write",
      "scopes": [
        "com.cloudflare.api.account"
      ]
    }
  ],
  "result_info": {
    "count": 1,
    "page": 1,
    "per_page": 20,
    "total_count": 2000
  }
}