getGroups

Use this data source to retrieve a list of groups from Okta.

Example Usage

using Pulumi;
using Okta = Pulumi.Okta;

class MyStack : Stack
{
    public MyStack()
    {
        var example = Output.Create(Okta.GetGroups.InvokeAsync(new Okta.GetGroupsArgs
        {
            Q = "Engineering - ",
        }));
    }

}
package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		opt0 := "Engineering - "
		_, err := okta.GetGroups(ctx, &okta.GetGroupsArgs{
			Q: &opt0,
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}
import pulumi
import pulumi_okta as okta

example = okta.get_groups(q="Engineering - ")
import * as pulumi from "@pulumi/pulumi";
import * as okta from "@pulumi/okta";

const example = pulumi.output(okta.getGroups({
    q: "Engineering - ",
}, { async: true }));

Using getGroups

function getGroups(args: GetGroupsArgs, opts?: InvokeOptions): Promise<GetGroupsResult>
def get_groups(q: Optional[str] = None,
               search: Optional[str] = None,
               type: Optional[str] = None,
               opts: Optional[InvokeOptions] = None) -> GetGroupsResult
func GetGroups(ctx *Context, args *GetGroupsArgs, opts ...InvokeOption) (*GetGroupsResult, error)

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

public static class GetGroups {
    public static Task<GetGroupsResult> InvokeAsync(GetGroupsArgs args, InvokeOptions? opts = null)
}

The following arguments are supported:

Q string
Searches the name property of groups for matching value.
Search string
Searches for groups with a supported filtering expression for all attributes except for "_embedded", "_links", and "objectClass"
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).
Q string
Searches the name property of groups for matching value.
Search string
Searches for groups with a supported filtering expression for all attributes except for "_embedded", "_links", and "objectClass"
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).
q string
Searches the name property of groups for matching value.
search string
Searches for groups with a supported filtering expression for all attributes except for "_embedded", "_links", and "objectClass"
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).
q str
Searches the name property of groups for matching value.
search str
Searches for groups with a supported filtering expression for all attributes except for "_embedded", "_links", and "objectClass"
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).

getGroups Result

The following output properties are available:

Groups List<GetGroupsGroup>
collection of groups retrieved from Okta with the following properties.
Id string
The provider-assigned unique ID for this managed resource.
Q string
Search string
Type string
Group type.
Groups []GetGroupsGroup
collection of groups retrieved from Okta with the following properties.
Id string
The provider-assigned unique ID for this managed resource.
Q string
Search string
Type string
Group type.
groups GetGroupsGroup[]
collection of groups retrieved from Okta with the following properties.
id string
The provider-assigned unique ID for this managed resource.
q string
search string
type string
Group type.
groups Sequence[GetGroupsGroup]
collection of groups retrieved from Okta with the following properties.
id str
The provider-assigned unique ID for this managed resource.
q str
search str
type str
Group type.

Supporting Types

GetGroupsGroup

Description string
Group description.
Id string
Group ID.
Name string
Group name.
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).
Description string
Group description.
Id string
Group ID.
Name string
Group name.
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).
description string
Group description.
id string
Group ID.
name string
Group name.
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).
description str
Group description.
id str
Group ID.
name str
Group name.
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).

Package Details

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