getUsergroup

Use this data source to get information about a usergroups for use in other resources. The data source returns enabled groups only.

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")
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 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
})
}
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

Return

A collection of values returned by getUsergroup.

Parameters

argument

A collection of arguments for invoking getUsergroup.


suspend fun getUsergroup(name: String? = null, usergroupId: String? = null): GetUsergroupResult

Return

A collection of values returned by getUsergroup.

Parameters

name

The name of the usergroup

usergroupId

The id of the usergroup The data source expects exactly one of these fields, you can't set both.

See also


Return

A collection of values returned by getUsergroup.

Parameters

argument

Builder for com.pulumi.slack.kotlin.inputs.GetUsergroupPlainArgs.

See also