Docs Home
Okta v4.15.0 published on Friday, Mar 7, 2025 by Pulumi
okta.group.Group
Explore with Pulumi AI
Creates an Okta Group. This resource allows you to create and configure an Okta Group.
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)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.
Constructor 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
In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.
The Group resource accepts the following input properties:
- Custom
Profile stringAttributes - JSON formatted custom attributes for a group. It must be JSON due to various types Okta allows.
- Description string
- The description of the Okta Group.
- Name string
- 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
- Custom
Profile stringAttributes - JSON formatted custom attributes for a group. It must be JSON due to various types Okta allows.
- Description string
- The description of the Okta Group.
- Name string
- 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
- custom
Profile StringAttributes - JSON formatted custom attributes for a group. It must be JSON due to various types Okta allows.
- description String
- The description of the Okta Group.
- name String
- The name of the Okta Group.
- skip
Users Boolean - Ignore users sync. This is a temporary solution until 'users' field is supported in all the app-like resources
- custom
Profile stringAttributes - JSON formatted custom attributes for a group. It must be JSON due to various types Okta allows.
- description string
- The description of the Okta Group.
- name string
- The name of the Okta Group.
- skip
Users boolean - Ignore users sync. This is a temporary solution until 'users' field is supported in all the app-like resources
- custom_
profile_ strattributes - JSON formatted custom attributes for a group. It must be JSON due to various types Okta allows.
- 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
- custom
Profile StringAttributes - JSON formatted custom attributes for a group. It must be JSON due to various types Okta allows.
- description String
- The description of the Okta Group.
- name String
- The name of the Okta Group.
- skip
Users Boolean - Ignore users sync. This is a temporary solution until 'users' field is supported in all the app-like resources
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) -> Groupfunc 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)resources: _: type: okta:group:Group get: id: ${id}- 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.
- Custom
Profile stringAttributes - JSON formatted custom attributes for a group. It must be JSON due to various types Okta allows.
- Description string
- The description of the Okta Group.
- Name string
- 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
- Custom
Profile stringAttributes - JSON formatted custom attributes for a group. It must be JSON due to various types Okta allows.
- Description string
- The description of the Okta Group.
- Name string
- 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
- custom
Profile StringAttributes - JSON formatted custom attributes for a group. It must be JSON due to various types Okta allows.
- description String
- The description of the Okta Group.
- name String
- The name of the Okta Group.
- skip
Users Boolean - Ignore users sync. This is a temporary solution until 'users' field is supported in all the app-like resources
- custom
Profile stringAttributes - JSON formatted custom attributes for a group. It must be JSON due to various types Okta allows.
- description string
- The description of the Okta Group.
- name string
- The name of the Okta Group.
- skip
Users boolean - Ignore users sync. This is a temporary solution until 'users' field is supported in all the app-like resources
- custom_
profile_ strattributes - JSON formatted custom attributes for a group. It must be JSON due to various types Okta allows.
- 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
- custom
Profile StringAttributes - JSON formatted custom attributes for a group. It must be JSON due to various types Okta allows.
- description String
- The description of the Okta Group.
- name String
- The name of the Okta Group.
- skip
Users Boolean - Ignore users sync. This is a temporary solution until 'users' field is supported in all the app-like resources
Import
$ pulumi import okta:group/group:Group example <group_id>
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
oktaTerraform Provider.