slack.getUsergroup

Explore with Pulumi AI

Slack v0.4.8 published on Monday, Oct 7, 2024 by Pulumi

pulumi/pulumi-slack

Required scopes

This resource requires the following scopes:

usergroups:read

The Slack API methods used by the resource are:

usergroups.list

If you get missing_scope errors while using this resource check the scopes against the documentation for the methods above.

Example Usage

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

const byName = slack.getUsergroup({
    name: "my-usergroup",
});
const byId = slack.getUsergroup({
    usergroupId: "USERGROUP00",
});

import pulumi
import pulumi_slack as slack

by_name = slack.get_usergroup(name="my-usergroup")
by_id = slack.get_usergroup(usergroup_id="USERGROUP00")

package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := slack.LookupUsergroup(ctx, &slack.LookupUsergroupArgs{
			Name: pulumi.StringRef("my-usergroup"),
		}, nil)
		if err != nil {
			return err
		}
		_, err = slack.LookupUsergroup(ctx, &slack.LookupUsergroupArgs{
			UsergroupId: pulumi.StringRef("USERGROUP00"),
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

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

return await Deployment.RunAsync(() => 
{
    var byName = Slack.GetUsergroup.Invoke(new()
    {
        Name = "my-usergroup",
    });

    var byId = Slack.GetUsergroup.Invoke(new()
    {
        UsergroupId = "USERGROUP00",
    });

});

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.slack.SlackFunctions;
import com.pulumi.slack.inputs.GetUsergroupArgs;
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 byName = SlackFunctions.getUsergroup(GetUsergroupArgs.builder()
            .name("my-usergroup")
            .build());

        final var byId = SlackFunctions.getUsergroup(GetUsergroupArgs.builder()
            .usergroupId("USERGROUP00")
            .build());

    }
}

variables:
  byName:
    fn::invoke:
      Function: slack:getUsergroup
      Arguments:
        name: my-usergroup
  byId:
    fn::invoke:
      Function: slack:getUsergroup
      Arguments:
        usergroupId: USERGROUP00

Using getUsergroup

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 getUsergroup(args: GetUsergroupArgs, opts?: InvokeOptions): Promise<GetUsergroupResult>
function getUsergroupOutput(args: GetUsergroupOutputArgs, opts?: InvokeOptions): Output<GetUsergroupResult>

def get_usergroup(name: Optional[str] = None,
                  usergroup_id: Optional[str] = None,
                  opts: Optional[InvokeOptions] = None) -> GetUsergroupResult
def get_usergroup_output(name: Optional[pulumi.Input[str]] = None,
                  usergroup_id: Optional[pulumi.Input[str]] = None,
                  opts: Optional[InvokeOptions] = None) -> Output[GetUsergroupResult]

func LookupUsergroup(ctx *Context, args *LookupUsergroupArgs, opts ...InvokeOption) (*LookupUsergroupResult, error)
func LookupUsergroupOutput(ctx *Context, args *LookupUsergroupOutputArgs, opts ...InvokeOption) LookupUsergroupResultOutput

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

public static class GetUsergroup 
{
    public static Task<GetUsergroupResult> InvokeAsync(GetUsergroupArgs args, InvokeOptions? opts = null)
    public static Output<GetUsergroupResult> Invoke(GetUsergroupInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetUsergroupResult> getUsergroup(GetUsergroupArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet

fn::invoke:
  function: slack:index/getUsergroup:getUsergroup
  arguments:
    # arguments dictionary

The following arguments are supported:

Name string

The name of the usergroup

UsergroupId string

The id of the usergroup