Docs Packages
  1. Packages
  2. Okta
  3. API Docs
  4. group
  5. Group
Okta v4.8.1 published on Thursday, Apr 18, 2024 by Pulumi
pulumi/pulumi-okta

okta.group.Group

Explore with Pulumi AI

okta logo
Okta v4.8.1 published on Thursday, Apr 18, 2024 by Pulumi
pulumi/pulumi-okta

    Creates an Okta Group.

    This resource allows you to create and configure an Okta Group.

    Example Usage

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

const example = new okta.group.Group("example", {description: "My Example Group"});

    import pulumi
import pulumi_okta as okta

example = okta.group.Group("example", description="My Example Group")

    package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := group.NewGroup(ctx, "example", &group.GroupArgs{
			Description: pulumi.String("My Example Group"),
		})
		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 = new Okta.Group.Group("example", new()
    {
        Description = "My Example Group",
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.okta.group.Group;
import com.pulumi.okta.group.GroupArgs;
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) {
        var example = new Group("example", GroupArgs.builder()        
            .description("My Example Group")
            .build());

    }
}

    resources:
  example:
    type: okta:group:Group
    properties:
      description: My Example Group

    Custom profile attributes

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

const example = new okta.group.Group("example", {
    description: "My Example Group",
    customProfileAttributes: JSON.stringify({
        example1: "testing1234",
        example2: true,
        example3: 54321,
    }),
});

    import pulumi
import json
import pulumi_okta as okta

example = okta.group.Group("example",
    description="My Example Group",
    custom_profile_attributes=json.dumps({
        "example1": "testing1234",
        "example2": True,
        "example3": 54321,
    }))

    package main

import (
	"encoding/json"

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		tmpJSON0, err := json.Marshal(map[string]interface{}{
			"example1": "testing1234",
			"example2": true,
			"example3": 54321,
		})
		if err != nil {
			return err
		}
		json0 := string(tmpJSON0)
		_, err = group.NewGroup(ctx, "example", &group.GroupArgs{
			Description:             pulumi.String("My Example Group"),
			CustomProfileAttributes: pulumi.String(json0),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

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

return await Deployment.RunAsync(() => 
{
    var example = new Okta.Group.Group("example", new()
    {
        Description = "My Example Group",
        CustomProfileAttributes = JsonSerializer.Serialize(new Dictionary<string, object?>
        {
            ["example1"] = "testing1234",
            ["example2"] = true,
            ["example3"] = 54321,
        }),
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.okta.group.Group;
import com.pulumi.okta.group.GroupArgs;
import static com.pulumi.codegen.internal.Serialization.*;
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) {
        var example = new Group("example", GroupArgs.builder()        
            .description("My Example Group")
            .customProfileAttributes(serializeJson(
                jsonObject(
                    jsonProperty("example1", "testing1234"),
                    jsonProperty("example2", true),
                    jsonProperty("example3", 54321)
                )))
            .build());

    }
}

    resources:
  example:
    type: okta:group:Group
    properties:
      description: My Example Group
      customProfileAttributes:
        fn::toJSON:
          example1: testing1234
          example2: true
          example3: 54321

    Create Group Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new Group(name: string, args?: GroupArgs, opts?: CustomResourceOptions);
    @overload
def Group(resource_name: str,
          args: Optional[GroupArgs] = None,
          opts: Optional[ResourceOptions] = None)

@overload
def Group(resource_name: str,
          opts: Optional[ResourceOptions] = None,
          custom_profile_attributes: Optional[str] = None,
          description: Optional[str] = None,
          name: Optional[str] = None,
          skip_users: Optional[bool] = None)
    func NewGroup(ctx *Context, name string, args *GroupArgs, opts ...ResourceOption) (*Group, error)
    public Group(string name, GroupArgs? args = null, CustomResourceOptions? opts = null)
    public Group(String name, GroupArgs args)
public Group(String name, GroupArgs args, CustomResourceOptions options)

    type: okta:group:Group
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

    Parameters

    name string
    The unique name of the resource.
    args GroupArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args GroupArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args GroupArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args GroupArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args GroupArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Example

    The following reference example uses placeholder values for all input properties.

    var groupResource = new Okta.Group.Group("groupResource", new()
{
    CustomProfileAttributes = "string",
    Description = "string",
    Name = "string",
});

    example, err := group.NewGroup(ctx, "groupResource", &group.GroupArgs{
	CustomProfileAttributes: pulumi.String("string"),
	Description:             pulumi.String("string"),
	Name:                    pulumi.String("string"),
})

    var groupResource = new Group("groupResource", GroupArgs.builder()        
    .customProfileAttributes("string")
    .description("string")
    .name("string")
    .build());

    group_resource = okta.group.Group("groupResource",
    custom_profile_attributes="string",
    description="string",
    name="string")

    const groupResource = new okta.group.Group("groupResource", {
    customProfileAttributes: "string",
    description: "string",
    name: "string",
});

    type: okta:group:Group
properties:
    customProfileAttributes: string
    description: string
    name: string

    Group Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    The Group resource accepts the following input properties:

    CustomProfileAttributes string
    raw JSON containing all custom profile attributes.
    Description string
    The description of the Okta Group.
    Name string
    The name of the Okta Group.
    SkipUsers bool
    Ignore users sync. This is a temporary solution until 'users' field is supported in all the app-like resources

    Deprecated: Because users has been removed, this attribute is a no op and will be removed

    CustomProfileAttributes string
    raw JSON containing all custom profile attributes.
    Description string
    The description of the Okta Group.
    Name string
    The name of the Okta Group.
    SkipUsers bool
    Ignore users sync. This is a temporary solution until 'users' field is supported in all the app-like resources

    Deprecated: Because users has been removed, this attribute is a no op and will be removed

    customProfileAttributes String
    raw JSON containing all custom profile attributes.
    description String
    The description of the Okta Group.
    name String
    The name of the Okta Group.
    skipUsers Boolean
    Ignore users sync. This is a temporary solution until 'users' field is supported in all the app-like resources

    Deprecated: Because users has been removed, this attribute is a no op and will be removed

    customProfileAttributes string
    raw JSON containing all custom profile attributes.
    description string
    The description of the Okta Group.
    name string
    The name of the Okta Group.
    skipUsers boolean
    Ignore users sync. This is a temporary solution until 'users' field is supported in all the app-like resources

    Deprecated: Because users has been removed, this attribute is a no op and will be removed

    custom_profile_attributes str
    raw JSON containing all custom profile attributes.
    description str
    The description of the Okta Group.
    name str
    The name of the Okta Group.
    skip_users bool
    Ignore users sync. This is a temporary solution until 'users' field is supported in all the app-like resources

    Deprecated: Because users has been removed, this attribute is a no op and will be removed

    customProfileAttributes String
    raw JSON containing all custom profile attributes.
    description String
    The description of the Okta Group.
    name String
    The name of the Okta Group.
    skipUsers Boolean
    Ignore users sync. This is a temporary solution until 'users' field is supported in all the app-like resources

    Deprecated: Because users has been removed, this attribute is a no op and will be removed

    Outputs

    All input properties are implicitly available as output properties. Additionally, the Group resource produces the following output properties:

    Id string
    The provider-assigned unique ID for this managed resource.
    Id string
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.
    id string
    The provider-assigned unique ID for this managed resource.
    id str
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.

    Look up Existing Group Resource

    Get an existing Group resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: GroupState, opts?: CustomResourceOptions): Group
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        custom_profile_attributes: Optional[str] = None,
        description: Optional[str] = None,
        name: Optional[str] = None,
        skip_users: Optional[bool] = None) -> Group
    func GetGroup(ctx *Context, name string, id IDInput, state *GroupState, opts ...ResourceOption) (*Group, error)
    public static Group Get(string name, Input<string> id, GroupState? state, CustomResourceOptions? opts = null)
    public static Group get(String name, Output<String> id, GroupState state, CustomResourceOptions options)
    Resource lookup is not supported in YAML
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    CustomProfileAttributes string
    raw JSON containing all custom profile attributes.
    Description string
    The description of the Okta Group.
    Name string
    The name of the Okta Group.
    SkipUsers bool
    Ignore users sync. This is a temporary solution until 'users' field is supported in all the app-like resources

    Deprecated: Because users has been removed, this attribute is a no op and will be removed

    CustomProfileAttributes string
    raw JSON containing all custom profile attributes.
    Description string
    The description of the Okta Group.
    Name string
    The name of the Okta Group.
    SkipUsers bool
    Ignore users sync. This is a temporary solution until 'users' field is supported in all the app-like resources

    Deprecated: Because users has been removed, this attribute is a no op and will be removed

    customProfileAttributes String
    raw JSON containing all custom profile attributes.
    description String
    The description of the Okta Group.
    name String
    The name of the Okta Group.
    skipUsers Boolean
    Ignore users sync. This is a temporary solution until 'users' field is supported in all the app-like resources

    Deprecated: Because users has been removed, this attribute is a no op and will be removed

    customProfileAttributes string
    raw JSON containing all custom profile attributes.
    description string
    The description of the Okta Group.
    name string
    The name of the Okta Group.
    skipUsers boolean
    Ignore users sync. This is a temporary solution until 'users' field is supported in all the app-like resources

    Deprecated: Because users has been removed, this attribute is a no op and will be removed

    custom_profile_attributes str
    raw JSON containing all custom profile attributes.
    description str
    The description of the Okta Group.
    name str
    The name of the Okta Group.
    skip_users bool
    Ignore users sync. This is a temporary solution until 'users' field is supported in all the app-like resources

    Deprecated: Because users has been removed, this attribute is a no op and will be removed

    customProfileAttributes String
    raw JSON containing all custom profile attributes.
    description String
    The description of the Okta Group.
    name String
    The name of the Okta Group.
    skipUsers Boolean
    Ignore users sync. This is a temporary solution until 'users' field is supported in all the app-like resources

    Deprecated: Because users has been removed, this attribute is a no op and will be removed

    Import

    An Okta Group can be imported via the Okta ID.

    $ pulumi import okta:group/group:Group example &#60;group id&#62;

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    Okta pulumi/pulumi-okta
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the okta Terraform Provider.
    okta logo
    Okta v4.8.1 published on Thursday, Apr 18, 2024 by Pulumi
    pulumi/pulumi-okta