cloudflare.getOrganizations

Start a Neo task

Explain and create a cloudflare.getOrganizations resource

Cloudflare v6.11.0 published on Friday, Oct 31, 2025 by Pulumi

pulumi/pulumi-cloudflare

Example Usage

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

const exampleOrganizations = cloudflare.getOrganizations({
    ids: ["a7b9c3d2e8f4g1h5i6j0k9l2m3n7o4p8"],
    containing: {
        account: "account",
        organization: "organization",
        user: "user",
    },
    name: {
        contains: "contains",
        endsWith: "endsWith",
        startsWith: "startsWith",
    },
    pageSize: 0,
    pageToken: "page_token",
    parent: {
        id: "a7b9c3d2e8f4g1h5i6j0k9l2m3n7o4p8",
    },
});

import pulumi
import pulumi_cloudflare as cloudflare

example_organizations = cloudflare.get_organizations(ids=["a7b9c3d2e8f4g1h5i6j0k9l2m3n7o4p8"],
    containing={
        "account": "account",
        "organization": "organization",
        "user": "user",
    },
    name={
        "contains": "contains",
        "ends_with": "endsWith",
        "starts_with": "startsWith",
    },
    page_size=0,
    page_token="page_token",
    parent={
        "id": "a7b9c3d2e8f4g1h5i6j0k9l2m3n7o4p8",
    })

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.LookupOrganizations(ctx, &cloudflare.LookupOrganizationsArgs{
			Ids: []string{
				"a7b9c3d2e8f4g1h5i6j0k9l2m3n7o4p8",
			},
			Containing: cloudflare.GetOrganizationsContaining{
				Account:      pulumi.StringRef("account"),
				Organization: pulumi.StringRef("organization"),
				User:         pulumi.StringRef("user"),
			},
			Name: cloudflare.GetOrganizationsName{
				Contains:   pulumi.StringRef("contains"),
				EndsWith:   pulumi.StringRef("endsWith"),
				StartsWith: pulumi.StringRef("startsWith"),
			},
			PageSize:  pulumi.IntRef(0),
			PageToken: pulumi.StringRef("page_token"),
			Parent: cloudflare.GetOrganizationsParent{
				Id: "a7b9c3d2e8f4g1h5i6j0k9l2m3n7o4p8",
			},
		}, 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 exampleOrganizations = Cloudflare.GetOrganizations.Invoke(new()
    {
        Ids = new[]
        {
            "a7b9c3d2e8f4g1h5i6j0k9l2m3n7o4p8",
        },
        Containing = new Cloudflare.Inputs.GetOrganizationsContainingInputArgs
        {
            Account = "account",
            Organization = "organization",
            User = "user",
        },
        Name = new Cloudflare.Inputs.GetOrganizationsNameInputArgs
        {
            Contains = "contains",
            EndsWith = "endsWith",
            StartsWith = "startsWith",
        },
        PageSize = 0,
        PageToken = "page_token",
        Parent = new Cloudflare.Inputs.GetOrganizationsParentInputArgs
        {
            Id = "a7b9c3d2e8f4g1h5i6j0k9l2m3n7o4p8",
        },
    });

});

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.GetOrganizationsArgs;
import com.pulumi.cloudflare.inputs.GetOrganizationsContainingArgs;
import com.pulumi.cloudflare.inputs.GetOrganizationsNameArgs;
import com.pulumi.cloudflare.inputs.GetOrganizationsParentArgs;
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 exampleOrganizations = CloudflareFunctions.getOrganizations(GetOrganizationsArgs.builder()
            .ids("a7b9c3d2e8f4g1h5i6j0k9l2m3n7o4p8")
            .containing(GetOrganizationsContainingArgs.builder()
                .account("account")
                .organization("organization")
                .user("user")
                .build())
            .name(GetOrganizationsNameArgs.builder()
                .contains("contains")
                .endsWith("endsWith")
                .startsWith("startsWith")
                .build())
            .pageSize(0)
            .pageToken("page_token")
            .parent(GetOrganizationsParentArgs.builder()
                .id("a7b9c3d2e8f4g1h5i6j0k9l2m3n7o4p8")
                .build())
            .build());

    }
}

variables:
  exampleOrganizations:
    fn::invoke:
      function: cloudflare:getOrganizations
      arguments:
        ids:
          - a7b9c3d2e8f4g1h5i6j0k9l2m3n7o4p8
        containing:
          account: account
          organization: organization
          user: user
        name:
          contains: contains
          endsWith: endsWith
          startsWith: startsWith
        pageSize: 0
        pageToken: page_token
        parent:
          id: a7b9c3d2e8f4g1h5i6j0k9l2m3n7o4p8

Using getOrganizations

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 getOrganizations(args: GetOrganizationsArgs, opts?: InvokeOptions): Promise<GetOrganizationsResult>
function getOrganizationsOutput(args: GetOrganizationsOutputArgs, opts?: InvokeOptions): Output<GetOrganizationsResult>

def get_organizations(containing: Optional[GetOrganizationsContaining] = None,
                      ids: Optional[Sequence[str]] = None,
                      max_items: Optional[int] = None,
                      name: Optional[GetOrganizationsName] = None,
                      page_size: Optional[int] = None,
                      page_token: Optional[str] = None,
                      parent: Optional[GetOrganizationsParent] = None,
                      opts: Optional[InvokeOptions] = None) -> GetOrganizationsResult
def get_organizations_output(containing: Optional[pulumi.Input[GetOrganizationsContainingArgs]] = None,
                      ids: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
                      max_items: Optional[pulumi.Input[int]] = None,
                      name: Optional[pulumi.Input[GetOrganizationsNameArgs]] = None,
                      page_size: Optional[pulumi.Input[int]] = None,
                      page_token: Optional[pulumi.Input[str]] = None,
                      parent: Optional[pulumi.Input[GetOrganizationsParentArgs]] = None,
                      opts: Optional[InvokeOptions] = None) -> Output[GetOrganizationsResult]

func LookupOrganizations(ctx *Context, args *LookupOrganizationsArgs, opts ...InvokeOption) (*LookupOrganizationsResult, error)
func LookupOrganizationsOutput(ctx *Context, args *LookupOrganizationsOutputArgs, opts ...InvokeOption) LookupOrganizationsResultOutput

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

public static class GetOrganizations 
{
    public static Task<GetOrganizationsResult> InvokeAsync(GetOrganizationsArgs args, InvokeOptions? opts = null)
    public static Output<GetOrganizationsResult> Invoke(GetOrganizationsInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetOrganizationsResult> getOrganizations(GetOrganizationsArgs args, InvokeOptions options)
public static Output<GetOrganizationsResult> getOrganizations(GetOrganizationsArgs args, InvokeOptions options)

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

The following arguments are supported:

Containing GetOrganizationsContaining
Ids List<string>: Only return organizations with the specified IDs (ex. id=foo&id=bar). Send multiple elements by repeating the query value.
MaxItems int: Max items to fetch, default: 1000
Name GetOrganizationsName
PageSize int: The amount of items to return. Defaults to 10.
PageToken string: An opaque token returned from the last list response that when provided will retrieve the next page.
Parent GetOrganizationsParent

Containing GetOrganizationsContaining
Ids []string: Only return organizations with the specified IDs (ex. id=foo&id=bar). Send multiple elements by repeating the query value.
MaxItems int: Max items to fetch, default: 1000
Name GetOrganizationsName
PageSize int: The amount of items to return. Defaults to 10.
PageToken string: An opaque token returned from the last list response that when provided will retrieve the next page.
Parent GetOrganizationsParent

containing GetOrganizationsContaining
ids List<String>: Only return organizations with the specified IDs (ex. id=foo&id=bar). Send multiple elements by repeating the query value.
maxItems Integer: Max items to fetch, default: 1000
name GetOrganizationsName
pageSize Integer: The amount of items to return. Defaults to 10.
pageToken String: An opaque token returned from the last list response that when provided will retrieve the next page.
parent GetOrganizationsParent

containing GetOrganizationsContaining
ids string[]: Only return organizations with the specified IDs (ex. id=foo&id=bar). Send multiple elements by repeating the query value.
maxItems number: Max items to fetch, default: 1000
name GetOrganizationsName
pageSize number: The amount of items to return. Defaults to 10.
pageToken string: An opaque token returned from the last list response that when provided will retrieve the next page.
parent GetOrganizationsParent

containing GetOrganizationsContaining
ids Sequence[str]: Only return organizations with the specified IDs (ex. id=foo&id=bar). Send multiple elements by repeating the query value.
max_items int: Max items to fetch, default: 1000
name GetOrganizationsName
page_size int: The amount of items to return. Defaults to 10.
page_token str: An opaque token returned from the last list response that when provided will retrieve the next page.
parent GetOrganizationsParent

containing Property Map
ids List<String>: Only return organizations with the specified IDs (ex. id=foo&id=bar). Send multiple elements by repeating the query value.
maxItems Number: Max items to fetch, default: 1000
name Property Map
pageSize Number: The amount of items to return. Defaults to 10.
pageToken String: An opaque token returned from the last list response that when provided will retrieve the next page.
parent Property Map

getOrganizations Result

The following output properties are available:

Results List<GetOrganizationsResult>
Containing GetOrganizationsContaining
Ids List<string>: Only return organizations with the specified IDs (ex. id=foo&id=bar). Send multiple elements by repeating the query value.
MaxItems int: Max items to fetch, default: 1000
Name GetOrganizationsName
PageSize int: The amount of items to return. Defaults to 10.
PageToken string: An opaque token returned from the last list response that when provided will retrieve the next page.
Parent GetOrganizationsParent

Results []GetOrganizationsResult
Containing GetOrganizationsContaining
Ids []string: Only return organizations with the specified IDs (ex. id=foo&id=bar). Send multiple elements by repeating the query value.
MaxItems int: Max items to fetch, default: 1000
Name GetOrganizationsName
PageSize int: The amount of items to return. Defaults to 10.
PageToken string: An opaque token returned from the last list response that when provided will retrieve the next page.
Parent GetOrganizationsParent

results List<GetOrganizationsResult>
containing GetOrganizationsContaining
ids List<String>: Only return organizations with the specified IDs (ex. id=foo&id=bar). Send multiple elements by repeating the query value.
maxItems Integer: Max items to fetch, default: 1000
name GetOrganizationsName
pageSize Integer: The amount of items to return. Defaults to 10.
pageToken String: An opaque token returned from the last list response that when provided will retrieve the next page.
parent GetOrganizationsParent

results GetOrganizationsResult[]
containing GetOrganizationsContaining
ids string[]: Only return organizations with the specified IDs (ex. id=foo&id=bar). Send multiple elements by repeating the query value.
maxItems number: Max items to fetch, default: 1000
name GetOrganizationsName
pageSize number: The amount of items to return. Defaults to 10.
pageToken string: An opaque token returned from the last list response that when provided will retrieve the next page.
parent GetOrganizationsParent

results Sequence[GetOrganizationsResult]
containing GetOrganizationsContaining
ids Sequence[str]: Only return organizations with the specified IDs (ex. id=foo&id=bar). Send multiple elements by repeating the query value.
max_items int: Max items to fetch, default: 1000
name GetOrganizationsName
page_size int: The amount of items to return. Defaults to 10.
page_token str: An opaque token returned from the last list response that when provided will retrieve the next page.
parent GetOrganizationsParent

results List<Property Map>
containing Property Map
ids List<String>: Only return organizations with the specified IDs (ex. id=foo&id=bar). Send multiple elements by repeating the query value.
maxItems Number: Max items to fetch, default: 1000
name Property Map
pageSize Number: The amount of items to return. Defaults to 10.
pageToken String: An opaque token returned from the last list response that when provided will retrieve the next page.
parent Property Map

Supporting Types

GetOrganizationsContaining

Account string: Filter the list of organizations to the ones that contain this particular account.
Organization string: Filter the list of organizations to the ones that contain this particular organization.
User string: Filter the list of organizations to the ones that contain this particular user.

Account string: Filter the list of organizations to the ones that contain this particular account.
Organization string: Filter the list of organizations to the ones that contain this particular organization.
User string: Filter the list of organizations to the ones that contain this particular user.

account String: Filter the list of organizations to the ones that contain this particular account.
organization String: Filter the list of organizations to the ones that contain this particular organization.
user String: Filter the list of organizations to the ones that contain this particular user.

account string: Filter the list of organizations to the ones that contain this particular account.
organization string: Filter the list of organizations to the ones that contain this particular organization.
user string: Filter the list of organizations to the ones that contain this particular user.

account str: Filter the list of organizations to the ones that contain this particular account.
organization str: Filter the list of organizations to the ones that contain this particular organization.
user str: Filter the list of organizations to the ones that contain this particular user.

account String: Filter the list of organizations to the ones that contain this particular account.
organization String: Filter the list of organizations to the ones that contain this particular organization.
user String: Filter the list of organizations to the ones that contain this particular user.

GetOrganizationsName

Contains string: (case-insensitive) Filter the list of organizations to where the name contains a particular string.
EndsWith string: (case-insensitive) Filter the list of organizations to where the name ends with a particular string.
StartsWith string: (case-insensitive) Filter the list of organizations to where the name starts with a particular string.

Contains string: (case-insensitive) Filter the list of organizations to where the name contains a particular string.
EndsWith string: (case-insensitive) Filter the list of organizations to where the name ends with a particular string.
StartsWith string: (case-insensitive) Filter the list of organizations to where the name starts with a particular string.

contains String: (case-insensitive) Filter the list of organizations to where the name contains a particular string.
endsWith String: (case-insensitive) Filter the list of organizations to where the name ends with a particular string.
startsWith String: (case-insensitive) Filter the list of organizations to where the name starts with a particular string.

contains string: (case-insensitive) Filter the list of organizations to where the name contains a particular string.
endsWith string: (case-insensitive) Filter the list of organizations to where the name ends with a particular string.
startsWith string: (case-insensitive) Filter the list of organizations to where the name starts with a particular string.

contains str: (case-insensitive) Filter the list of organizations to where the name contains a particular string.
ends_with str: (case-insensitive) Filter the list of organizations to where the name ends with a particular string.
starts_with str: (case-insensitive) Filter the list of organizations to where the name starts with a particular string.

contains String: (case-insensitive) Filter the list of organizations to where the name contains a particular string.
endsWith String: (case-insensitive) Filter the list of organizations to where the name ends with a particular string.
startsWith String: (case-insensitive) Filter the list of organizations to where the name starts with a particular string.