1. Packages
  2. Buildkite
  3. API Docs
  4. Organization
  5. getPortals
Viewing docs for Buildkite v3.2.0
published on Monday, Feb 23, 2026 by Pulumiverse
Schema (JSON)
pulumiverse/pulumi-buildkite

buildkite.Organization.getPortals

buildkite logo
Viewing docs for Buildkite v3.2.0
published on Monday, Feb 23, 2026 by Pulumiverse
Schema (JSON)
pulumiverse/pulumi-buildkite

    Use this data source to retrieve all portals for an organization.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
import * as buildkite from "@pulumiverse/buildkite";

const all = buildkite.Organization.getPortals({});
export const userInvokablePortals = all.then(all => .filter(portal => portal.userInvokable).map(portal => (portal.name)));

    import pulumi
import pulumi_buildkite as buildkite

all = buildkite.Organization.get_portals()
pulumi.export("userInvokablePortals", [portal.name for portal in all.portals if portal.user_invokable])

    Example coming soon!

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Buildkite = Pulumiverse.Buildkite;

return await Deployment.RunAsync(() => 
{
    var all = Buildkite.Organization.GetPortals.Invoke();

    return new Dictionary<string, object?>
    {
        ["userInvokablePortals"] = .Where(portal => portal.UserInvokable).Select(portal => 
        {
            return portal.Name;
        }).ToList(),
    };
});

    Example coming soon!

    Example coming soon!

    Using getPortals

    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 getPortals(opts?: InvokeOptions): Promise<GetPortalsResult>
function getPortalsOutput(opts?: InvokeOptions): Output<GetPortalsResult>
    def get_portals(opts: Optional[InvokeOptions] = None) -> GetPortalsResult
def get_portals_output(opts: Optional[InvokeOptions] = None) -> Output[GetPortalsResult]
    func GetPortals(ctx *Context, opts ...InvokeOption) (*GetPortalsResult, error)
func GetPortalsOutput(ctx *Context, opts ...InvokeOption) GetPortalsResultOutput

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

    public static class GetPortals 
{
    public static Task<GetPortalsResult> InvokeAsync(InvokeOptions? opts = null)
    public static Output<GetPortalsResult> Invoke(InvokeOptions? opts = null)
}
    public static CompletableFuture<GetPortalsResult> getPortals(InvokeOptions options)
public static Output<GetPortalsResult> getPortals(InvokeOptions options)

    fn::invoke:
  function: buildkite:Organization/getPortals:getPortals
  arguments:
    # arguments dictionary

    getPortals Result

    The following output properties are available:

    Id string
    The provider-assigned unique ID for this managed resource.
    Portals List<Pulumiverse.Buildkite.Organization.Outputs.GetPortalsPortal>
    Id string
    The provider-assigned unique ID for this managed resource.
    Portals []GetPortalsPortal
    id String
    The provider-assigned unique ID for this managed resource.
    portals List<GetPortalsPortal>
    id string
    The provider-assigned unique ID for this managed resource.
    portals GetPortalsPortal[]
    id str
    The provider-assigned unique ID for this managed resource.
    portals Sequence[GetPortalsPortal]
    id String
    The provider-assigned unique ID for this managed resource.
    portals List<Property Map>

    Supporting Types

    GetPortalsPortal

    AllowedIpAddresses string
    Space-delimited list of IP addresses (in CIDR notation) allowed to invoke this portal.
    CreatedAt string
    The time when the portal was created.
    CreatedBy Pulumiverse.Buildkite.Organization.Inputs.GetPortalsPortalCreatedBy
    Information about the user who created the portal.
    Description string
    The description of the portal.
    Name string
    The name of the portal.
    Query string
    The GraphQL query that the portal executes.
    Slug string
    The slug of the portal.
    UserInvokable bool
    Whether users can invoke the portal.
    Uuid string
    The UUID of the portal.
    AllowedIpAddresses string
    Space-delimited list of IP addresses (in CIDR notation) allowed to invoke this portal.
    CreatedAt string
    The time when the portal was created.
    CreatedBy GetPortalsPortalCreatedBy
    Information about the user who created the portal.
    Description string
    The description of the portal.
    Name string
    The name of the portal.
    Query string
    The GraphQL query that the portal executes.
    Slug string
    The slug of the portal.
    UserInvokable bool
    Whether users can invoke the portal.
    Uuid string
    The UUID of the portal.
    allowedIpAddresses String
    Space-delimited list of IP addresses (in CIDR notation) allowed to invoke this portal.
    createdAt String
    The time when the portal was created.
    createdBy GetPortalsPortalCreatedBy
    Information about the user who created the portal.
    description String
    The description of the portal.
    name String
    The name of the portal.
    query String
    The GraphQL query that the portal executes.
    slug String
    The slug of the portal.
    userInvokable Boolean
    Whether users can invoke the portal.
    uuid String
    The UUID of the portal.
    allowedIpAddresses string
    Space-delimited list of IP addresses (in CIDR notation) allowed to invoke this portal.
    createdAt string
    The time when the portal was created.
    createdBy GetPortalsPortalCreatedBy
    Information about the user who created the portal.
    description string
    The description of the portal.
    name string
    The name of the portal.
    query string
    The GraphQL query that the portal executes.
    slug string
    The slug of the portal.
    userInvokable boolean
    Whether users can invoke the portal.
    uuid string
    The UUID of the portal.
    allowed_ip_addresses str
    Space-delimited list of IP addresses (in CIDR notation) allowed to invoke this portal.
    created_at str
    The time when the portal was created.
    created_by GetPortalsPortalCreatedBy
    Information about the user who created the portal.
    description str
    The description of the portal.
    name str
    The name of the portal.
    query str
    The GraphQL query that the portal executes.
    slug str
    The slug of the portal.
    user_invokable bool
    Whether users can invoke the portal.
    uuid str
    The UUID of the portal.
    allowedIpAddresses String
    Space-delimited list of IP addresses (in CIDR notation) allowed to invoke this portal.
    createdAt String
    The time when the portal was created.
    createdBy Property Map
    Information about the user who created the portal.
    description String
    The description of the portal.
    name String
    The name of the portal.
    query String
    The GraphQL query that the portal executes.
    slug String
    The slug of the portal.
    userInvokable Boolean
    Whether users can invoke the portal.
    uuid String
    The UUID of the portal.

    GetPortalsPortalCreatedBy

    Email string
    The email of the user.
    Name string
    The name of the user.
    Uuid string
    The UUID of the user.
    Email string
    The email of the user.
    Name string
    The name of the user.
    Uuid string
    The UUID of the user.
    email String
    The email of the user.
    name String
    The name of the user.
    uuid String
    The UUID of the user.
    email string
    The email of the user.
    name string
    The name of the user.
    uuid string
    The UUID of the user.
    email str
    The email of the user.
    name str
    The name of the user.
    uuid str
    The UUID of the user.
    email String
    The email of the user.
    name String
    The name of the user.
    uuid String
    The UUID of the user.

    Package Details

    Repository
    buildkite pulumiverse/pulumi-buildkite
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the buildkite Terraform Provider.
    buildkite logo
    Viewing docs for Buildkite v3.2.0
    published on Monday, Feb 23, 2026 by Pulumiverse
    Schema (JSON)
    pulumiverse/pulumi-buildkite
      Try Pulumi Cloud free. Your team will thank you.