1. Packages
  2. Cloudflare Provider
  3. API Docs
  4. getApiTokenPermissionGroupsList
Viewing docs for Cloudflare v6.13.0
published on Wednesday, Jan 21, 2026 by Pulumi
Schema (JSON)
pulumi/pulumi-cloudflare

cloudflare.getApiTokenPermissionGroupsList

cloudflare logo
Viewing docs for Cloudflare v6.13.0
published on Wednesday, Jan 21, 2026 by Pulumi
Schema (JSON)
pulumi/pulumi-cloudflare

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
import * as cloudflare from "@pulumi/cloudflare";

const exampleApiTokenPermissionGroupsList = cloudflare.getApiTokenPermissionGroupsList({
    name: "Account%20Settings%20Write",
    scope: "com.cloudflare.api.account.zone",
});

    import pulumi
import pulumi_cloudflare as cloudflare

example_api_token_permission_groups_list = cloudflare.get_api_token_permission_groups_list(name="Account%20Settings%20Write",
    scope="com.cloudflare.api.account.zone")

    package main

import (
	"github.com/pulumi/pulumi-cloudflare/sdk/v6/go/cloudflare"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := cloudflare.LookupApiTokenPermissionGroupsList(ctx, &cloudflare.LookupApiTokenPermissionGroupsListArgs{
			Name:  pulumi.StringRef("Account%20Settings%20Write"),
			Scope: pulumi.StringRef("com.cloudflare.api.account.zone"),
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Cloudflare = Pulumi.Cloudflare;

return await Deployment.RunAsync(() => 
{
    var exampleApiTokenPermissionGroupsList = Cloudflare.GetApiTokenPermissionGroupsList.Invoke(new()
    {
        Name = "Account%20Settings%20Write",
        Scope = "com.cloudflare.api.account.zone",
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.cloudflare.CloudflareFunctions;
import com.pulumi.cloudflare.inputs.GetApiTokenPermissionGroupsListArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        final var exampleApiTokenPermissionGroupsList = CloudflareFunctions.getApiTokenPermissionGroupsList(GetApiTokenPermissionGroupsListArgs.builder()
            .name("Account%20Settings%20Write")
            .scope("com.cloudflare.api.account.zone")
            .build());

    }
}

    variables:
  exampleApiTokenPermissionGroupsList:
    fn::invoke:
      function: cloudflare:getApiTokenPermissionGroupsList
      arguments:
        name: Account%20Settings%20Write
        scope: com.cloudflare.api.account.zone

    Using getApiTokenPermissionGroupsList

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getApiTokenPermissionGroupsList(args: GetApiTokenPermissionGroupsListArgs, opts?: InvokeOptions): Promise<GetApiTokenPermissionGroupsListResult>
function getApiTokenPermissionGroupsListOutput(args: GetApiTokenPermissionGroupsListOutputArgs, opts?: InvokeOptions): Output<GetApiTokenPermissionGroupsListResult>
    def get_api_token_permission_groups_list(max_items: Optional[int] = None,
                                         name: Optional[str] = None,
                                         scope: Optional[str] = None,
                                         opts: Optional[InvokeOptions] = None) -> GetApiTokenPermissionGroupsListResult
def get_api_token_permission_groups_list_output(max_items: Optional[pulumi.Input[int]] = None,
                                         name: Optional[pulumi.Input[str]] = None,
                                         scope: Optional[pulumi.Input[str]] = None,
                                         opts: Optional[InvokeOptions] = None) -> Output[GetApiTokenPermissionGroupsListResult]
    func LookupApiTokenPermissionGroupsList(ctx *Context, args *LookupApiTokenPermissionGroupsListArgs, opts ...InvokeOption) (*LookupApiTokenPermissionGroupsListResult, error)
func LookupApiTokenPermissionGroupsListOutput(ctx *Context, args *LookupApiTokenPermissionGroupsListOutputArgs, opts ...InvokeOption) LookupApiTokenPermissionGroupsListResultOutput

    > Note: This function is named LookupApiTokenPermissionGroupsList in the Go SDK.

    public static class GetApiTokenPermissionGroupsList 
{
    public static Task<GetApiTokenPermissionGroupsListResult> InvokeAsync(GetApiTokenPermissionGroupsListArgs args, InvokeOptions? opts = null)
    public static Output<GetApiTokenPermissionGroupsListResult> Invoke(GetApiTokenPermissionGroupsListInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetApiTokenPermissionGroupsListResult> getApiTokenPermissionGroupsList(GetApiTokenPermissionGroupsListArgs args, InvokeOptions options)
public static Output<GetApiTokenPermissionGroupsListResult> getApiTokenPermissionGroupsList(GetApiTokenPermissionGroupsListArgs args, InvokeOptions options)

    fn::invoke:
  function: cloudflare:index/getApiTokenPermissionGroupsList:getApiTokenPermissionGroupsList
  arguments:
    # arguments dictionary

    The following arguments are supported:

    MaxItems int
    Max items to fetch, default: 1000
    Name string
    Filter by the name of the permission group. The value must be URL-encoded.
    Scope string
    Filter by the scope of the permission group. The value must be URL-encoded.
    MaxItems int
    Max items to fetch, default: 1000
    Name string
    Filter by the name of the permission group. The value must be URL-encoded.
    Scope string
    Filter by the scope of the permission group. The value must be URL-encoded.
    maxItems Integer
    Max items to fetch, default: 1000
    name String
    Filter by the name of the permission group. The value must be URL-encoded.
    scope String
    Filter by the scope of the permission group. The value must be URL-encoded.
    maxItems number
    Max items to fetch, default: 1000
    name string
    Filter by the name of the permission group. The value must be URL-encoded.
    scope string
    Filter by the scope of the permission group. The value must be URL-encoded.
    max_items int
    Max items to fetch, default: 1000
    name str
    Filter by the name of the permission group. The value must be URL-encoded.
    scope str
    Filter by the scope of the permission group. The value must be URL-encoded.
    maxItems Number
    Max items to fetch, default: 1000
    name String
    Filter by the name of the permission group. The value must be URL-encoded.
    scope String
    Filter by the scope of the permission group. The value must be URL-encoded.

    getApiTokenPermissionGroupsList Result

    The following output properties are available:

    Id string
    The provider-assigned unique ID for this managed resource.
    Results List<GetApiTokenPermissionGroupsListResult>
    The items returned by the data source
    MaxItems int
    Max items to fetch, default: 1000
    Name string
    Filter by the name of the permission group. The value must be URL-encoded.
    Scope string
    Filter by the scope of the permission group. The value must be URL-encoded.
    Id string
    The provider-assigned unique ID for this managed resource.
    Results []GetApiTokenPermissionGroupsListResult
    The items returned by the data source
    MaxItems int
    Max items to fetch, default: 1000
    Name string
    Filter by the name of the permission group. The value must be URL-encoded.
    Scope string
    Filter by the scope of the permission group. The value must be URL-encoded.
    id String
    The provider-assigned unique ID for this managed resource.
    results List<GetApiTokenPermissionGroupsListResult>
    The items returned by the data source
    maxItems Integer
    Max items to fetch, default: 1000
    name String
    Filter by the name of the permission group. The value must be URL-encoded.
    scope String
    Filter by the scope of the permission group. The value must be URL-encoded.
    id string
    The provider-assigned unique ID for this managed resource.
    results GetApiTokenPermissionGroupsListResult[]
    The items returned by the data source
    maxItems number
    Max items to fetch, default: 1000
    name string
    Filter by the name of the permission group. The value must be URL-encoded.
    scope string
    Filter by the scope of the permission group. The value must be URL-encoded.
    id str
    The provider-assigned unique ID for this managed resource.
    results Sequence[GetApiTokenPermissionGroupsListResult]
    The items returned by the data source
    max_items int
    Max items to fetch, default: 1000
    name str
    Filter by the name of the permission group. The value must be URL-encoded.
    scope str
    Filter by the scope of the permission group. The value must be URL-encoded.
    id String
    The provider-assigned unique ID for this managed resource.
    results List<Property Map>
    The items returned by the data source
    maxItems Number
    Max items to fetch, default: 1000
    name String
    Filter by the name of the permission group. The value must be URL-encoded.
    scope String
    Filter by the scope of the permission group. The value must be URL-encoded.

    Supporting Types

    GetApiTokenPermissionGroupsListResult

    Id string
    Public ID.
    Name string
    Permission Group Name
    Scopes List<string>
    Resources to which the Permission Group is scoped
    Id string
    Public ID.
    Name string
    Permission Group Name
    Scopes []string
    Resources to which the Permission Group is scoped
    id String
    Public ID.
    name String
    Permission Group Name
    scopes List<String>
    Resources to which the Permission Group is scoped
    id string
    Public ID.
    name string
    Permission Group Name
    scopes string[]
    Resources to which the Permission Group is scoped
    id str
    Public ID.
    name str
    Permission Group Name
    scopes Sequence[str]
    Resources to which the Permission Group is scoped
    id String
    Public ID.
    name String
    Permission Group Name
    scopes List<String>
    Resources to which the Permission Group is scoped

    Package Details

    Repository
    Cloudflare pulumi/pulumi-cloudflare
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the cloudflare Terraform Provider.
    cloudflare logo
    Viewing docs for Cloudflare v6.13.0
    published on Wednesday, Jan 21, 2026 by Pulumi
    Schema (JSON)
    pulumi/pulumi-cloudflare
      Try Pulumi Cloud free. Your team will thank you.