Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Honeycombio Provider
  3. API Docs
  4. getAuthMetadata
honeycombio 0.31.0 published on Friday, Mar 7, 2025 by honeycombio
honeycombio/terraform-provider-honeycombio

honeycombio.getAuthMetadata

Explore with Pulumi AI

honeycombio logo
honeycombio 0.31.0 published on Friday, Mar 7, 2025 by honeycombio
honeycombio/terraform-provider-honeycombio

    # Data Source: honeycombio.getAuthMetadata

    The honeycombio.getAuthMetadata data source retreives information about the API key used to authenticate the provider.

    Example Usage

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

const current = honeycombio.getAuthMetadata({});
export const teamName = current.then(current => current.team?.name);
export const environmentSlug = current.then(current => current.environment?.slug);
export const sloManagementAccess = current.then(current => current.apiKeyAccess?.slos);

    import pulumi
import pulumi_honeycombio as honeycombio

current = honeycombio.get_auth_metadata()
pulumi.export("teamName", current.team.name)
pulumi.export("environmentSlug", current.environment.slug)
pulumi.export("sloManagementAccess", current.api_key_access.slos)

    package main

import (
	"github.com/pulumi/pulumi-terraform-provider/sdks/go/honeycombio/honeycombio"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		current, err := honeycombio.GetAuthMetadata(ctx, &honeycombio.GetAuthMetadataArgs{}, nil)
		if err != nil {
			return err
		}
		ctx.Export("teamName", current.Team.Name)
		ctx.Export("environmentSlug", current.Environment.Slug)
		ctx.Export("sloManagementAccess", current.ApiKeyAccess.Slos)
		return nil
	})
}

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

return await Deployment.RunAsync(() => 
{
    var current = Honeycombio.GetAuthMetadata.Invoke();

    return new Dictionary<string, object?>
    {
        ["teamName"] = current.Apply(getAuthMetadataResult => getAuthMetadataResult.Team?.Name),
        ["environmentSlug"] = current.Apply(getAuthMetadataResult => getAuthMetadataResult.Environment?.Slug),
        ["sloManagementAccess"] = current.Apply(getAuthMetadataResult => getAuthMetadataResult.ApiKeyAccess?.Slos),
    };
});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.honeycombio.HoneycombioFunctions;
import com.pulumi.honeycombio.inputs.GetAuthMetadataArgs;
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 current = HoneycombioFunctions.getAuthMetadata();

        ctx.export("teamName", current.applyValue(getAuthMetadataResult -> getAuthMetadataResult.team().name()));
        ctx.export("environmentSlug", current.applyValue(getAuthMetadataResult -> getAuthMetadataResult.environment().slug()));
        ctx.export("sloManagementAccess", current.applyValue(getAuthMetadataResult -> getAuthMetadataResult.apiKeyAccess().slos()));
    }
}

    variables:
  current:
    fn::invoke:
      function: honeycombio:getAuthMetadata
      arguments: {}
outputs:
  teamName: ${current.team.name}
  environmentSlug: ${current.environment.slug}
  sloManagementAccess: ${current.apiKeyAccess.slos}

    Using getAuthMetadata

    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 getAuthMetadata(args: GetAuthMetadataArgs, opts?: InvokeOptions): Promise<GetAuthMetadataResult>
function getAuthMetadataOutput(args: GetAuthMetadataOutputArgs, opts?: InvokeOptions): Output<GetAuthMetadataResult>
    def get_auth_metadata(api_key_access: Optional[GetAuthMetadataApiKeyAccess] = None,
                      environment: Optional[GetAuthMetadataEnvironment] = None,
                      team: Optional[GetAuthMetadataTeam] = None,
                      opts: Optional[InvokeOptions] = None) -> GetAuthMetadataResult
def get_auth_metadata_output(api_key_access: Optional[pulumi.Input[GetAuthMetadataApiKeyAccessArgs]] = None,
                      environment: Optional[pulumi.Input[GetAuthMetadataEnvironmentArgs]] = None,
                      team: Optional[pulumi.Input[GetAuthMetadataTeamArgs]] = None,
                      opts: Optional[InvokeOptions] = None) -> Output[GetAuthMetadataResult]
    func GetAuthMetadata(ctx *Context, args *GetAuthMetadataArgs, opts ...InvokeOption) (*GetAuthMetadataResult, error)
func GetAuthMetadataOutput(ctx *Context, args *GetAuthMetadataOutputArgs, opts ...InvokeOption) GetAuthMetadataResultOutput

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

    public static class GetAuthMetadata 
{
    public static Task<GetAuthMetadataResult> InvokeAsync(GetAuthMetadataArgs args, InvokeOptions? opts = null)
    public static Output<GetAuthMetadataResult> Invoke(GetAuthMetadataInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetAuthMetadataResult> getAuthMetadata(GetAuthMetadataArgs args, InvokeOptions options)
public static Output<GetAuthMetadataResult> getAuthMetadata(GetAuthMetadataArgs args, InvokeOptions options)

    fn::invoke:
  function: honeycombio:index/getAuthMetadata:getAuthMetadata
  arguments:
    # arguments dictionary

    The following arguments are supported:

    ApiKeyAccess GetAuthMetadataApiKeyAccess
    The authorizations granted for the API key used to authenticate the provider. See the documentation for more information.
    Environment GetAuthMetadataEnvironment
    Information about the Environment the API key is scoped to.
    Team GetAuthMetadataTeam
    Information about the Team the API key is scoped to.
    ApiKeyAccess GetAuthMetadataApiKeyAccess
    The authorizations granted for the API key used to authenticate the provider. See the documentation for more information.
    Environment GetAuthMetadataEnvironment
    Information about the Environment the API key is scoped to.
    Team GetAuthMetadataTeam
    Information about the Team the API key is scoped to.
    apiKeyAccess GetAuthMetadataApiKeyAccess
    The authorizations granted for the API key used to authenticate the provider. See the documentation for more information.
    environment GetAuthMetadataEnvironment
    Information about the Environment the API key is scoped to.
    team GetAuthMetadataTeam
    Information about the Team the API key is scoped to.
    apiKeyAccess GetAuthMetadataApiKeyAccess
    The authorizations granted for the API key used to authenticate the provider. See the documentation for more information.
    environment GetAuthMetadataEnvironment
    Information about the Environment the API key is scoped to.
    team GetAuthMetadataTeam
    Information about the Team the API key is scoped to.
    api_key_access GetAuthMetadataApiKeyAccess
    The authorizations granted for the API key used to authenticate the provider. See the documentation for more information.
    environment GetAuthMetadataEnvironment
    Information about the Environment the API key is scoped to.
    team GetAuthMetadataTeam
    Information about the Team the API key is scoped to.
    apiKeyAccess Property Map
    The authorizations granted for the API key used to authenticate the provider. See the documentation for more information.
    environment Property Map
    Information about the Environment the API key is scoped to.
    team Property Map
    Information about the Team the API key is scoped to.

    getAuthMetadata Result

    The following output properties are available:

    Id string
    The provider-assigned unique ID for this managed resource.
    ApiKeyAccess GetAuthMetadataApiKeyAccess
    The authorizations granted for the API key used to authenticate the provider. See the documentation for more information.
    Environment GetAuthMetadataEnvironment
    Information about the Environment the API key is scoped to.
    Team GetAuthMetadataTeam
    Information about the Team the API key is scoped to.
    Id string
    The provider-assigned unique ID for this managed resource.
    ApiKeyAccess GetAuthMetadataApiKeyAccess
    The authorizations granted for the API key used to authenticate the provider. See the documentation for more information.
    Environment GetAuthMetadataEnvironment
    Information about the Environment the API key is scoped to.
    Team GetAuthMetadataTeam
    Information about the Team the API key is scoped to.
    id String
    The provider-assigned unique ID for this managed resource.
    apiKeyAccess GetAuthMetadataApiKeyAccess
    The authorizations granted for the API key used to authenticate the provider. See the documentation for more information.
    environment GetAuthMetadataEnvironment
    Information about the Environment the API key is scoped to.
    team GetAuthMetadataTeam
    Information about the Team the API key is scoped to.
    id string
    The provider-assigned unique ID for this managed resource.
    apiKeyAccess GetAuthMetadataApiKeyAccess
    The authorizations granted for the API key used to authenticate the provider. See the documentation for more information.
    environment GetAuthMetadataEnvironment
    Information about the Environment the API key is scoped to.
    team GetAuthMetadataTeam
    Information about the Team the API key is scoped to.
    id str
    The provider-assigned unique ID for this managed resource.
    api_key_access GetAuthMetadataApiKeyAccess
    The authorizations granted for the API key used to authenticate the provider. See the documentation for more information.
    environment GetAuthMetadataEnvironment
    Information about the Environment the API key is scoped to.
    team GetAuthMetadataTeam
    Information about the Team the API key is scoped to.
    id String
    The provider-assigned unique ID for this managed resource.
    apiKeyAccess Property Map
    The authorizations granted for the API key used to authenticate the provider. See the documentation for more information.
    environment Property Map
    Information about the Environment the API key is scoped to.
    team Property Map
    Information about the Team the API key is scoped to.

    Supporting Types

    GetAuthMetadataApiKeyAccess

    Boards bool
    true if this API key can create and manage Boards.
    Columns bool
    true if this API key can create and manage can create and manage Queries, Columns, Derived Columns, and Query Annotations
    Datasets bool
    true if this API key can create and manage Datasets.
    Events bool
    true if this API key can key can send events to Honeycomb.
    Markers bool
    true if this API key can create and manage Markers.
    Queries bool
    true if this API key can execute existing Queries via the Query Data API.
    Recipients bool
    true if this API key can create and manage Recipients.
    Slos bool
    true if this API key can create and manage SLOs.
    Triggers bool
    true if this API key can create and manage Triggers.
    Boards bool
    true if this API key can create and manage Boards.
    Columns bool
    true if this API key can create and manage can create and manage Queries, Columns, Derived Columns, and Query Annotations
    Datasets bool
    true if this API key can create and manage Datasets.
    Events bool
    true if this API key can key can send events to Honeycomb.
    Markers bool
    true if this API key can create and manage Markers.
    Queries bool
    true if this API key can execute existing Queries via the Query Data API.
    Recipients bool
    true if this API key can create and manage Recipients.
    Slos bool
    true if this API key can create and manage SLOs.
    Triggers bool
    true if this API key can create and manage Triggers.
    boards Boolean
    true if this API key can create and manage Boards.
    columns Boolean
    true if this API key can create and manage can create and manage Queries, Columns, Derived Columns, and Query Annotations
    datasets Boolean
    true if this API key can create and manage Datasets.
    events Boolean
    true if this API key can key can send events to Honeycomb.
    markers Boolean
    true if this API key can create and manage Markers.
    queries Boolean
    true if this API key can execute existing Queries via the Query Data API.
    recipients Boolean
    true if this API key can create and manage Recipients.
    slos Boolean
    true if this API key can create and manage SLOs.
    triggers Boolean
    true if this API key can create and manage Triggers.
    boards boolean
    true if this API key can create and manage Boards.
    columns boolean
    true if this API key can create and manage can create and manage Queries, Columns, Derived Columns, and Query Annotations
    datasets boolean
    true if this API key can create and manage Datasets.
    events boolean
    true if this API key can key can send events to Honeycomb.
    markers boolean
    true if this API key can create and manage Markers.
    queries boolean
    true if this API key can execute existing Queries via the Query Data API.
    recipients boolean
    true if this API key can create and manage Recipients.
    slos boolean
    true if this API key can create and manage SLOs.
    triggers boolean
    true if this API key can create and manage Triggers.
    boards bool
    true if this API key can create and manage Boards.
    columns bool
    true if this API key can create and manage can create and manage Queries, Columns, Derived Columns, and Query Annotations
    datasets bool
    true if this API key can create and manage Datasets.
    events bool
    true if this API key can key can send events to Honeycomb.
    markers bool
    true if this API key can create and manage Markers.
    queries bool
    true if this API key can execute existing Queries via the Query Data API.
    recipients bool
    true if this API key can create and manage Recipients.
    slos bool
    true if this API key can create and manage SLOs.
    triggers bool
    true if this API key can create and manage Triggers.
    boards Boolean
    true if this API key can create and manage Boards.
    columns Boolean
    true if this API key can create and manage can create and manage Queries, Columns, Derived Columns, and Query Annotations
    datasets Boolean
    true if this API key can create and manage Datasets.
    events Boolean
    true if this API key can key can send events to Honeycomb.
    markers Boolean
    true if this API key can create and manage Markers.
    queries Boolean
    true if this API key can execute existing Queries via the Query Data API.
    recipients Boolean
    true if this API key can create and manage Recipients.
    slos Boolean
    true if this API key can create and manage SLOs.
    triggers Boolean
    true if this API key can create and manage Triggers.

    GetAuthMetadataEnvironment

    Classic bool
    true if this API key belongs to a Honeycomb Classic environment.
    Name string
    The name of the Team.
    Slug string
    The slug of the Team.
    Classic bool
    true if this API key belongs to a Honeycomb Classic environment.
    Name string
    The name of the Team.
    Slug string
    The slug of the Team.
    classic Boolean
    true if this API key belongs to a Honeycomb Classic environment.
    name String
    The name of the Team.
    slug String
    The slug of the Team.
    classic boolean
    true if this API key belongs to a Honeycomb Classic environment.
    name string
    The name of the Team.
    slug string
    The slug of the Team.
    classic bool
    true if this API key belongs to a Honeycomb Classic environment.
    name str
    The name of the Team.
    slug str
    The slug of the Team.
    classic Boolean
    true if this API key belongs to a Honeycomb Classic environment.
    name String
    The name of the Team.
    slug String
    The slug of the Team.

    GetAuthMetadataTeam

    Name string
    The name of the Team.
    Slug string
    The slug of the Team.
    Name string
    The name of the Team.
    Slug string
    The slug of the Team.
    name String
    The name of the Team.
    slug String
    The slug of the Team.
    name string
    The name of the Team.
    slug string
    The slug of the Team.
    name str
    The name of the Team.
    slug str
    The slug of the Team.
    name String
    The name of the Team.
    slug String
    The slug of the Team.

    Package Details

    Repository
    honeycombio honeycombio/terraform-provider-honeycombio
    License
    Notes
    This Pulumi package is based on the honeycombio Terraform Provider.
    honeycombio logo
    honeycombio 0.31.0 published on Friday, Mar 7, 2025 by honeycombio
    honeycombio/terraform-provider-honeycombio