Okta

v3.16.0 published on Wednesday, Sep 28, 2022 by Pulumi

getGroup

Use this data source to retrieve a group from Okta.

Example Usage

using System.Collections.Generic;
using Pulumi;
using Okta = Pulumi.Okta;

return await Deployment.RunAsync(() => 
{
    var example = Okta.Group.GetGroup.Invoke(new()
    {
        Name = "Example App",
    });

});
package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := group.LookupGroup(ctx, &group.LookupGroupArgs{
			Name: pulumi.StringRef("Example App"),
		}, 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.okta.group.GroupFunctions;
import com.pulumi.okta.group.inputs.GetGroupArgs;
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 example = GroupFunctions.getGroup(GetGroupArgs.builder()
            .name("Example App")
            .build());

    }
}
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",
}));
variables:
  example:
    Fn::Invoke:
      Function: okta:group:getGroup
      Arguments:
        name: Example App

Using getGroup

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 getGroup(args: GetGroupArgs, opts?: InvokeOptions): Promise<GetGroupResult>
function getGroupOutput(args: GetGroupOutputArgs, opts?: InvokeOptions): Output<GetGroupResult>
def get_group(delay_read_seconds: Optional[str] = None,
              id: Optional[str] = None,
              include_users: Optional[bool] = None,
              name: Optional[str] = None,
              type: Optional[str] = None,
              opts: Optional[InvokeOptions] = None) -> GetGroupResult
def get_group_output(delay_read_seconds: Optional[pulumi.Input[str]] = None,
              id: Optional[pulumi.Input[str]] = None,
              include_users: Optional[pulumi.Input[bool]] = None,
              name: Optional[pulumi.Input[str]] = None,
              type: Optional[pulumi.Input[str]] = None,
              opts: Optional[InvokeOptions] = None) -> Output[GetGroupResult]
func LookupGroup(ctx *Context, args *LookupGroupArgs, opts ...InvokeOption) (*LookupGroupResult, error)
func LookupGroupOutput(ctx *Context, args *LookupGroupOutputArgs, opts ...InvokeOption) LookupGroupResultOutput

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

public static class GetGroup 
{
    public static Task<GetGroupResult> InvokeAsync(GetGroupArgs args, InvokeOptions? opts = null)
    public static Output<GetGroupResult> Invoke(GetGroupInvokeArgs args, InvokeOptions? opts = null)
}
public static CompletableFuture<GetGroupResult> getGroup(GetGroupArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet
fn::invoke:
  function: okta:group/getGroup:getGroup
  arguments:
    # arguments dictionary

The following arguments are supported:

DelayReadSeconds string

Force delay of the group read by N seconds. Useful when eventual consistency of group information needs to be allowed for; for instance, when group rules are known to have been applied.

Id string

ID of the group. Conflicts with "name" and "type".

IncludeUsers bool

whether to retrieve all member ids.

Name string

name of group to retrieve.

Type string

type of the group to retrieve. Can only be one of OKTA_GROUP (Native Okta Groups), APP_GROUP (Imported App Groups), or BUILT_IN (Okta System Groups).

DelayReadSeconds string

Force delay of the group read by N seconds. Useful when eventual consistency of group information needs to be allowed for; for instance, when group rules are known to have been applied.

Id string

ID of the group. Conflicts with "name" and "type".

IncludeUsers bool

whether to retrieve all member ids.

Name string

name of group to retrieve.

Type string

type of the group to retrieve. Can only be one of OKTA_GROUP (Native Okta Groups), APP_GROUP (Imported App Groups), or BUILT_IN (Okta System Groups).

delayReadSeconds String

Force delay of the group read by N seconds. Useful when eventual consistency of group information needs to be allowed for; for instance, when group rules are known to have been applied.

id String

ID of the group. Conflicts with "name" and "type".

includeUsers Boolean

whether to retrieve all member ids.

name String

name of group to retrieve.

type String

type of the group to retrieve. Can only be one of OKTA_GROUP (Native Okta Groups), APP_GROUP (Imported App Groups), or BUILT_IN (Okta System Groups).

delayReadSeconds string

Force delay of the group read by N seconds. Useful when eventual consistency of group information needs to be allowed for; for instance, when group rules are known to have been applied.

id string

ID of the group. Conflicts with "name" and "type".

includeUsers boolean

whether to retrieve all member ids.

name string

name of group to retrieve.

type string

type of the group to retrieve. Can only be one of OKTA_GROUP (Native Okta Groups), APP_GROUP (Imported App Groups), or BUILT_IN (Okta System Groups).

delay_read_seconds str

Force delay of the group read by N seconds. Useful when eventual consistency of group information needs to be allowed for; for instance, when group rules are known to have been applied.

id str

ID of the group. Conflicts with "name" and "type".

include_users bool

whether to retrieve all member ids.

name str

name of group to retrieve.

type str

type of the group to retrieve. Can only be one of OKTA_GROUP (Native Okta Groups), APP_GROUP (Imported App Groups), or BUILT_IN (Okta System Groups).

delayReadSeconds String

Force delay of the group read by N seconds. Useful when eventual consistency of group information needs to be allowed for; for instance, when group rules are known to have been applied.

id String

ID of the group. Conflicts with "name" and "type".

includeUsers Boolean

whether to retrieve all member ids.

name String

name of group to retrieve.

type String

type of the group to retrieve. Can only be one of OKTA_GROUP (Native Okta Groups), APP_GROUP (Imported App Groups), or BUILT_IN (Okta System Groups).

getGroup Result

The following output properties are available:

Description string

description of group.

Users List<string>

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

DelayReadSeconds string
Id string

ID of group.

IncludeUsers bool
Name string

name of group.

Type string

type of group.

Description string

description of group.

Users []string

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

DelayReadSeconds string
Id string

ID of group.

IncludeUsers bool
Name string

name of group.

Type string

type of group.

description String

description of group.

users List<String>

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

delayReadSeconds String
id String

ID of group.

includeUsers Boolean
name String

name of group.

type String

type of group.

description string

description of group.

users string[]

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

delayReadSeconds string
id string

ID of group.

includeUsers boolean
name string

name of group.

type string

type of group.

description str

description of group.

users Sequence[str]

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

delay_read_seconds str
id str

ID of group.

include_users bool
name str

name of group.

type str

type of group.

description String

description of group.

users List<String>

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

delayReadSeconds String
id String

ID of group.

includeUsers Boolean
name String

name of group.

type String

type of group.

Package Details

Repository
https://github.com/pulumi/pulumi-okta
License
Apache-2.0
Notes

This Pulumi package is based on the okta Terraform Provider.