Okta

Pulumi Official
Package maintained by Pulumi
v3.14.0 published on Thursday, Aug 4, 2022 by Pulumi

getEveryoneGroup

Use this data source to retrieve the Everyone group from Okta. The same can be achieved with the okta.group.Group data source with name = "Everyone". This is simply a shortcut.

Example Usage

using Pulumi;
using Okta = Pulumi.Okta;

class MyStack : Stack
{
    public MyStack()
    {
        var example = Output.Create(Okta.Group.GetEveryoneGroup.InvokeAsync());
    }

}
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.GetEveryoneGroup(ctx, nil, 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.GetEveryoneGroupArgs;
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.getEveryoneGroup();

    }
}
import pulumi
import pulumi_okta as okta

example = okta.group.get_everyone_group()
import * as pulumi from "@pulumi/pulumi";
import * as okta from "@pulumi/okta";

const example = pulumi.output(okta.group.getEveryoneGroup());
variables:
  example:
    Fn::Invoke:
      Function: okta:group:getEveryoneGroup
      Arguments: {}

Using getEveryoneGroup

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 getEveryoneGroup(args: GetEveryoneGroupArgs, opts?: InvokeOptions): Promise<GetEveryoneGroupResult>
function getEveryoneGroupOutput(args: GetEveryoneGroupOutputArgs, opts?: InvokeOptions): Output<GetEveryoneGroupResult>
def get_everyone_group(include_users: Optional[bool] = None,
                       opts: Optional[InvokeOptions] = None) -> GetEveryoneGroupResult
def get_everyone_group_output(include_users: Optional[pulumi.Input[bool]] = None,
                       opts: Optional[InvokeOptions] = None) -> Output[GetEveryoneGroupResult]
func GetEveryoneGroup(ctx *Context, args *GetEveryoneGroupArgs, opts ...InvokeOption) (*GetEveryoneGroupResult, error)
func GetEveryoneGroupOutput(ctx *Context, args *GetEveryoneGroupOutputArgs, opts ...InvokeOption) GetEveryoneGroupResultOutput

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

public static class GetEveryoneGroup 
{
    public static Task<GetEveryoneGroupResult> InvokeAsync(GetEveryoneGroupArgs args, InvokeOptions? opts = null)
    public static Output<GetEveryoneGroupResult> Invoke(GetEveryoneGroupInvokeArgs args, InvokeOptions? opts = null)
}
public static CompletableFuture<GetEveryoneGroupResult> getEveryoneGroup(GetEveryoneGroupArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet
Fn::Invoke:
  Function: okta:group/getEveryoneGroup:getEveryoneGroup
  Arguments:
    # Arguments dictionary

The following arguments are supported:

IncludeUsers bool

whether to retrieve all member ids.

IncludeUsers bool

whether to retrieve all member ids.

includeUsers Boolean

whether to retrieve all member ids.

includeUsers boolean

whether to retrieve all member ids.

include_users bool

whether to retrieve all member ids.

includeUsers Boolean

whether to retrieve all member ids.

getEveryoneGroup Result

The following output properties are available:

Description string

description of group.

Id string

The provider-assigned unique ID for this managed resource.

IncludeUsers bool
Description string

description of group.

Id string

The provider-assigned unique ID for this managed resource.

IncludeUsers bool
description String

description of group.

id String

The provider-assigned unique ID for this managed resource.

includeUsers Boolean
description string

description of group.

id string

The provider-assigned unique ID for this managed resource.

includeUsers boolean
description str

description of group.

id str

The provider-assigned unique ID for this managed resource.

include_users bool
description String

description of group.

id String

The provider-assigned unique ID for this managed resource.

includeUsers Boolean

Package Details

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

This Pulumi package is based on the okta Terraform Provider.