1. Docs
  2. Reference
  3. API
  4. Okta
  5. group
  6. GetGroup

GetGroup

Use this data source to retrieve a group from Okta.

Example Usage

using Pulumi;
using Okta = Pulumi.Okta;

class MyStack : Stack
{
    public MyStack()
    {
        var example = Output.Create(Okta.Group.GetGroup.InvokeAsync(new Okta.Group.GetGroupArgs
        {
            Name = "Example App",
        }));
    }

}

Coming soon!

import pulumi
import pulumi_okta as okta

example = okta.group.get_group(name="Example App")
import * as pulumi from "@pulumi/pulumi";
import * as okta from "@pulumi/okta";

const example = pulumi.output(okta.group.getGroup({
    name: "Example App",
}, { async: true }));

Using GetGroup

function getGroup(args: GetGroupArgs, opts?: InvokeOptions): Promise<GetGroupResult>
function  get_group(include_users=None, name=None, opts=None)
func LookupGroup(ctx *Context, args *LookupGroupArgs, opts ...InvokeOption) (*LookupGroupResult, error)

Note: This function is named LookupGroup in the Go SDK.

public static class GetGroup {
    public static Task<GetGroupResult> InvokeAsync(GetGroupArgs args, InvokeOptions? opts = null)
}

The following arguments are supported:

Name string

name of group to retrieve.

IncludeUsers bool

whether or not to retrieve all member ids.

Name string

name of group to retrieve.

IncludeUsers bool

whether or not to retrieve all member ids.

name string

name of group to retrieve.

includeUsers boolean

whether or not to retrieve all member ids.

name str

name of group to retrieve.

include_users bool

whether or not to retrieve all member ids.

GetGroup Result

The following output properties are available:

Description string

description of group.

Id string

The provider-assigned unique ID for this managed resource.

Name string

name of group.

Users List<string>

user ids that are members of this group, only included if include_users is set to true.

IncludeUsers bool
Description string

description of group.

Id string

The provider-assigned unique ID for this managed resource.

Name string

name of group.

Users []string

user ids that are members of this group, only included if include_users is set to true.

IncludeUsers bool
description string

description of group.

id string

The provider-assigned unique ID for this managed resource.

name string

name of group.

users string[]

user ids that are members of this group, only included if include_users is set to true.

includeUsers boolean
description str

description of group.

id str

The provider-assigned unique ID for this managed resource.

name str

name of group.

users List[str]

user ids that are members of this group, only included if include_users is set to true.

include_users bool

Package Details

Repository
https://github.com/pulumi/pulumi-okta
License
Apache-2.0
Notes
This Pulumi package is based on the okta Terraform Provider.