Come join Pulumi for the industry's first Cloud Engineering Summit! October 7–8. Save Your Spot

group

This provider is a derived work of the Terraform Provider distributed under MPL 2.0. If you encounter a bug or missing feature, first check the pulumi/pulumi-okta repo; however, if that doesn’t turn up anything, please consult the source terraform-providers/terraform-provider-okta repo.

class pulumi_okta.group.AwaitableGetEveryoneGroupResult(id=None, include_users=None)
class pulumi_okta.group.AwaitableGetGroupResult(description=None, id=None, include_users=None, name=None, users=None)
class pulumi_okta.group.GetEveryoneGroupResult(id=None, include_users=None)

A collection of values returned by getEveryoneGroup.

id = None

The provider-assigned unique ID for this managed resource.

class pulumi_okta.group.GetGroupResult(description=None, id=None, include_users=None, name=None, users=None)

A collection of values returned by getGroup.

description = None

description of group.

id = None

The provider-assigned unique ID for this managed resource.

name = None

name of group.

users = None

user ids that are members of this group, only included if include_users is set to true.

class pulumi_okta.group.Group(resource_name, opts=None, description=None, name=None, users=None, __props__=None, __name__=None, __opts__=None)

Creates an Okta Group.

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

import pulumi
import pulumi_okta as okta

example = okta.group.Group("example", description="My Example Group")
Parameters
  • resource_name (str) – The name of the resource.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • description (pulumi.Input[str]) – The description of the Okta Group.

  • name (pulumi.Input[str]) – The name of the Okta Group.

  • users (pulumi.Input[list]) – Users associated with the group. This can also be done per user.

description: pulumi.Output[str] = None

The description of the Okta Group.

name: pulumi.Output[str] = None

The name of the Okta Group.

users: pulumi.Output[list] = None

Users associated with the group. This can also be done per user.

static get(resource_name, id, opts=None, description=None, name=None, users=None)

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

Parameters
  • resource_name (str) – The unique name of the resulting resource.

  • id (str) – The unique provider ID of the resource to lookup.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • description (pulumi.Input[str]) – The description of the Okta Group.

  • name (pulumi.Input[str]) – The name of the Okta Group.

  • users (pulumi.Input[list]) – Users associated with the group. This can also be done per user.

translate_output_property(prop)

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

translate_input_property(prop)

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

class pulumi_okta.group.Roles(resource_name, opts=None, admin_roles=None, group_id=None, __props__=None, __name__=None, __opts__=None)

Creates Group level Admin Role Assignments.

This resource allows you to create and configure Group level Admin Role Assignments.

import pulumi
import pulumi_okta as okta

example = okta.group.Roles("example",
    admin_roles=["SUPER_ADMIN"],
    group_id="<group id>")
Parameters
  • resource_name (str) – The name of the resource.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • admin_roles (pulumi.Input[list]) – Admin roles associated with the group. It can be any of the following values "SUPER_ADMIN", "ORG_ADMIN", "APP_ADMIN", "USER_ADMIN", "HELP_DESK_ADMIN", "READ_ONLY_ADMIN", "MOBILE_ADMIN", "API_ACCESS_MANAGEMENT_ADMIN", "REPORT_ADMIN".

  • group_id (pulumi.Input[str]) – The ID of group to attach admin roles to.

admin_roles: pulumi.Output[list] = None

Admin roles associated with the group. It can be any of the following values "SUPER_ADMIN", "ORG_ADMIN", "APP_ADMIN", "USER_ADMIN", "HELP_DESK_ADMIN", "READ_ONLY_ADMIN", "MOBILE_ADMIN", "API_ACCESS_MANAGEMENT_ADMIN", "REPORT_ADMIN".

group_id: pulumi.Output[str] = None

The ID of group to attach admin roles to.

static get(resource_name, id, opts=None, admin_roles=None, group_id=None)

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

Parameters
  • resource_name (str) – The unique name of the resulting resource.

  • id (str) – The unique provider ID of the resource to lookup.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • admin_roles (pulumi.Input[list]) – Admin roles associated with the group. It can be any of the following values "SUPER_ADMIN", "ORG_ADMIN", "APP_ADMIN", "USER_ADMIN", "HELP_DESK_ADMIN", "READ_ONLY_ADMIN", "MOBILE_ADMIN", "API_ACCESS_MANAGEMENT_ADMIN", "REPORT_ADMIN".

  • group_id (pulumi.Input[str]) – The ID of group to attach admin roles to.

translate_output_property(prop)

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

translate_input_property(prop)

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

class pulumi_okta.group.Rule(resource_name, opts=None, expression_type=None, expression_value=None, group_assignments=None, name=None, status=None, __props__=None, __name__=None, __opts__=None)

Creates an Okta Group Rule.

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

import pulumi
import pulumi_okta as okta

example = okta.group.Rule("example",
    expression_type="urn:okta:expression:1.0",
    expression_value="String.startsWith(user.firstName,"andy")",
    group_assignments=["<group id>"],
    status="ACTIVE")
Parameters
  • resource_name (str) – The name of the resource.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • expression_type (pulumi.Input[str]) – The expression type to use to invoke the rule. The default is "urn:okta:expression:1.0".

  • expression_value (pulumi.Input[str]) – The expression value.

  • group_assignments (pulumi.Input[list]) – The list of group ids to assign the users to.

  • name (pulumi.Input[str]) – The name of the Group Rule.

  • status (pulumi.Input[str]) – The status of the group rule.

expression_type: pulumi.Output[str] = None

The expression type to use to invoke the rule. The default is "urn:okta:expression:1.0".

expression_value: pulumi.Output[str] = None

The expression value.

group_assignments: pulumi.Output[list] = None

The list of group ids to assign the users to.

name: pulumi.Output[str] = None

The name of the Group Rule.

status: pulumi.Output[str] = None

The status of the group rule.

static get(resource_name, id, opts=None, expression_type=None, expression_value=None, group_assignments=None, name=None, status=None)

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

Parameters
  • resource_name (str) – The unique name of the resulting resource.

  • id (str) – The unique provider ID of the resource to lookup.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • expression_type (pulumi.Input[str]) – The expression type to use to invoke the rule. The default is "urn:okta:expression:1.0".

  • expression_value (pulumi.Input[str]) – The expression value.

  • group_assignments (pulumi.Input[list]) – The list of group ids to assign the users to.

  • name (pulumi.Input[str]) – The name of the Group Rule.

  • status (pulumi.Input[str]) – The status of the group rule.

translate_output_property(prop)

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

translate_input_property(prop)

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

pulumi_okta.group.get_everyone_group(include_users=None, opts=None)

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

import pulumi
import pulumi_okta as okta

example = okta.group.get_everyone_group()
pulumi_okta.group.get_group(include_users=None, name=None, opts=None)

Use this data source to retrieve a group from Okta.

import pulumi
import pulumi_okta as okta

example = okta.group.get_group(name="Example App")
Parameters
  • include_users (bool) – whether or not to retrieve all member ids.

  • name (str) – name of group to retrieve.