Okta v4.9.2, Jun 25 24

Okta v4.9.2 published on Tuesday, Jun 25, 2024 by Pulumi

okta.getGroups

Explore with Pulumi AI

Okta v4.9.2 published on Tuesday, Jun 25, 2024 by Pulumi

Example Usage

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

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

import pulumi
import pulumi_okta as okta

example = okta.get_groups(q="Engineering - ")

package main

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

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

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

return await Deployment.RunAsync(() => 
{
    var example = Okta.GetGroups.Invoke(new()
    {
        Q = "Engineering - ",
    });

});

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.okta.OktaFunctions;
import com.pulumi.okta.inputs.GetGroupsArgs;
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 = OktaFunctions.getGroups(GetGroupsArgs.builder()
            .q("Engineering - ")
            .build());

    }
}

variables:
  example:
    fn::invoke:
      Function: okta:getGroups
      Arguments:
        q: 'Engineering - '

Using getGroups

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 getGroups(args: GetGroupsArgs, opts?: InvokeOptions): Promise<GetGroupsResult>
function getGroupsOutput(args: GetGroupsOutputArgs, opts?: InvokeOptions): Output<GetGroupsResult>

def get_groups(q: Optional[str] = None,
               search: Optional[str] = None,
               type: Optional[str] = None,
               opts: Optional[InvokeOptions] = None) -> GetGroupsResult
def get_groups_output(q: Optional[pulumi.Input[str]] = None,
               search: Optional[pulumi.Input[str]] = None,
               type: Optional[pulumi.Input[str]] = None,
               opts: Optional[InvokeOptions] = None) -> Output[GetGroupsResult]

func GetGroups(ctx *Context, args *GetGroupsArgs, opts ...InvokeOption) (*GetGroupsResult, error)
func GetGroupsOutput(ctx *Context, args *GetGroupsOutputArgs, opts ...InvokeOption) GetGroupsResultOutput

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

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

public static CompletableFuture<GetGroupsResult> getGroups(GetGroupsArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet

fn::invoke:
  function: okta:index/getGroups:getGroups
  arguments:
    # arguments dictionary

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

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

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

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

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

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

getGroups Result

The following output properties are available:

Groups List<GetGroupsGroup>
Id string: The provider-assigned unique ID for this managed resource.
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

Groups []GetGroupsGroup
Id string: The provider-assigned unique ID for this managed resource.
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

groups List<GetGroupsGroup>
id String: The provider-assigned unique ID for this managed resource.
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

groups GetGroupsGroup[]
id string: The provider-assigned unique ID for this managed resource.
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

groups Sequence[GetGroupsGroup]
id str: The provider-assigned unique ID for this managed resource.
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

groups List<Property Map>
id String: The provider-assigned unique ID for this managed resource.
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

Supporting Types

GetGroupsGroup

CustomProfileAttributes string: Raw JSON containing all custom profile attributes. Likely only useful on groups of type
Description string: Group description.
Id string: Group ID.
Name string: Group name.
Type string: Group type.

CustomProfileAttributes string: Raw JSON containing all custom profile attributes. Likely only useful on groups of type
Description string: Group description.
Id string: Group ID.
Name string: Group name.
Type string: Group type.

customProfileAttributes String: Raw JSON containing all custom profile attributes. Likely only useful on groups of type
description String: Group description.
id String: Group ID.
name String: Group name.
type String: Group type.

customProfileAttributes string: Raw JSON containing all custom profile attributes. Likely only useful on groups of type
description string: Group description.
id string: Group ID.
name string: Group name.
type string: Group type.

custom_profile_attributes str: Raw JSON containing all custom profile attributes. Likely only useful on groups of type
description str: Group description.
id str: Group ID.
name str: Group name.
type str: Group type.

customProfileAttributes String: Raw JSON containing all custom profile attributes. Likely only useful on groups of type
description String: Group description.
id String: Group ID.
name String: Group name.
type String: Group type.

Package Details

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

Okta v4.9.2 published on Tuesday, Jun 25, 2024 by Pulumi

pulumi/pulumi-okta

okta.getGroups

On this page

On this page

Example Usage

Using getGroups

getGroups Result

Supporting Types

GetGroupsGroup

Package Details

On this page

On this page