group

package
v4.8.1 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Apr 18, 2024 License: Apache-2.0 Imports: 7 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type GetEveryoneGroupArgs 

type GetEveryoneGroupArgs struct {
	// whether to retrieve all member ids.
	IncludeUsers *bool `pulumi:"includeUsers"`
}

A collection of arguments for invoking getEveryoneGroup.

type GetEveryoneGroupOutputArgs 

type GetEveryoneGroupOutputArgs struct {
	// whether to retrieve all member ids.
	IncludeUsers pulumi.BoolPtrInput `pulumi:"includeUsers"`
}

A collection of arguments for invoking getEveryoneGroup.

func (GetEveryoneGroupOutputArgs) ElementType 

func (GetEveryoneGroupOutputArgs) ElementType() reflect.Type

type GetEveryoneGroupResult 

type GetEveryoneGroupResult struct {
	// description of group.
	Description string `pulumi:"description"`
	// The provider-assigned unique ID for this managed resource.
	Id           string `pulumi:"id"`
	IncludeUsers *bool  `pulumi:"includeUsers"`
}

A collection of values returned by getEveryoneGroup.

func GetEveryoneGroup 

func GetEveryoneGroup(ctx *pulumi.Context, args *GetEveryoneGroupArgs, opts ...pulumi.InvokeOption) (*GetEveryoneGroupResult, error)

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.

## Example Usage

<!--Start PulumiCodeChooser --> ```go 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.GetEveryoneGroup(ctx, nil, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

``` <!--End PulumiCodeChooser -->

type GetEveryoneGroupResultOutput 

type GetEveryoneGroupResultOutput struct{ *pulumi.OutputState }

A collection of values returned by getEveryoneGroup.

func GetEveryoneGroupOutput 

func GetEveryoneGroupOutput(ctx *pulumi.Context, args GetEveryoneGroupOutputArgs, opts ...pulumi.InvokeOption) GetEveryoneGroupResultOutput

func (GetEveryoneGroupResultOutput) Description 

func (o GetEveryoneGroupResultOutput) Description() pulumi.StringOutput

description of group.

func (GetEveryoneGroupResultOutput) ElementType 

func (GetEveryoneGroupResultOutput) ElementType() reflect.Type

func (GetEveryoneGroupResultOutput) Id 

func (o GetEveryoneGroupResultOutput) Id() pulumi.StringOutput

The provider-assigned unique ID for this managed resource.

func (GetEveryoneGroupResultOutput) IncludeUsers 

func (o GetEveryoneGroupResultOutput) IncludeUsers() pulumi.BoolPtrOutput

func (GetEveryoneGroupResultOutput) ToGetEveryoneGroupResultOutput 

func (o GetEveryoneGroupResultOutput) ToGetEveryoneGroupResultOutput() GetEveryoneGroupResultOutput

func (GetEveryoneGroupResultOutput) ToGetEveryoneGroupResultOutputWithContext 

func (o GetEveryoneGroupResultOutput) ToGetEveryoneGroupResultOutputWithContext(ctx context.Context) GetEveryoneGroupResultOutput

type Group 

type Group struct {
	pulumi.CustomResourceState

	// raw JSON containing all custom profile attributes.
	CustomProfileAttributes pulumi.StringPtrOutput `pulumi:"customProfileAttributes"`
	// The description of the Okta Group.
	Description pulumi.StringPtrOutput `pulumi:"description"`
	// The name of the Okta Group.
	Name pulumi.StringOutput `pulumi:"name"`
	// 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
	SkipUsers pulumi.BoolPtrOutput `pulumi:"skipUsers"`
}

Creates an Okta Group.

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

## Example Usage

<!--Start PulumiCodeChooser --> ```go 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
	})
}

``` <!--End PulumiCodeChooser -->

Custom profile attributes <!--Start PulumiCodeChooser --> ```go 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
	})
}

``` <!--End PulumiCodeChooser -->

## Import

An Okta Group can be imported via the Okta ID.

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

func GetGroup 

func GetGroup(ctx *pulumi.Context,
	name string, id pulumi.IDInput, state *GroupState, opts ...pulumi.ResourceOption) (*Group, error)

GetGroup gets an existing Group resource's state with the given name, ID, and optional state properties that are used to uniquely qualify the lookup (nil if not required).

func NewGroup 

func NewGroup(ctx *pulumi.Context,
	name string, args *GroupArgs, opts ...pulumi.ResourceOption) (*Group, error)

NewGroup registers a new resource with the given unique name, arguments, and options.

func (*Group) ElementType 

func (*Group) ElementType() reflect.Type

func (*Group) ToGroupOutput 

func (i *Group) ToGroupOutput() GroupOutput

func (*Group) ToGroupOutputWithContext 

func (i *Group) ToGroupOutputWithContext(ctx context.Context) GroupOutput

type GroupArgs 

type GroupArgs struct {
	// raw JSON containing all custom profile attributes.
	CustomProfileAttributes pulumi.StringPtrInput
	// The description of the Okta Group.
	Description pulumi.StringPtrInput
	// The name of the Okta Group.
	Name pulumi.StringPtrInput
	// 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
	SkipUsers pulumi.BoolPtrInput
}

The set of arguments for constructing a Group resource.

func (GroupArgs) ElementType 

func (GroupArgs) ElementType() reflect.Type

type GroupArray 

type GroupArray []GroupInput

func (GroupArray) ElementType 

func (GroupArray) ElementType() reflect.Type

func (GroupArray) ToGroupArrayOutput 

func (i GroupArray) ToGroupArrayOutput() GroupArrayOutput

func (GroupArray) ToGroupArrayOutputWithContext 

func (i GroupArray) ToGroupArrayOutputWithContext(ctx context.Context) GroupArrayOutput

type GroupArrayInput 

type GroupArrayInput interface {
	pulumi.Input

	ToGroupArrayOutput() GroupArrayOutput
	ToGroupArrayOutputWithContext(context.Context) GroupArrayOutput
}

GroupArrayInput is an input type that accepts GroupArray and GroupArrayOutput values. You can construct a concrete instance of `GroupArrayInput` via: 

GroupArray{ GroupArgs{...} }

type GroupArrayOutput 

type GroupArrayOutput struct{ *pulumi.OutputState }

func (GroupArrayOutput) ElementType 

func (GroupArrayOutput) ElementType() reflect.Type

func (GroupArrayOutput) Index 

func (o GroupArrayOutput) Index(i pulumi.IntInput) GroupOutput

func (GroupArrayOutput) ToGroupArrayOutput 

func (o GroupArrayOutput) ToGroupArrayOutput() GroupArrayOutput

func (GroupArrayOutput) ToGroupArrayOutputWithContext 

func (o GroupArrayOutput) ToGroupArrayOutputWithContext(ctx context.Context) GroupArrayOutput

type GroupInput 

type GroupInput interface {
	pulumi.Input

	ToGroupOutput() GroupOutput
	ToGroupOutputWithContext(ctx context.Context) GroupOutput
}

type GroupMap 

type GroupMap map[string]GroupInput

func (GroupMap) ElementType 

func (GroupMap) ElementType() reflect.Type

func (GroupMap) ToGroupMapOutput 

func (i GroupMap) ToGroupMapOutput() GroupMapOutput

func (GroupMap) ToGroupMapOutputWithContext 

func (i GroupMap) ToGroupMapOutputWithContext(ctx context.Context) GroupMapOutput

type GroupMapInput 

type GroupMapInput interface {
	pulumi.Input

	ToGroupMapOutput() GroupMapOutput
	ToGroupMapOutputWithContext(context.Context) GroupMapOutput
}

GroupMapInput is an input type that accepts GroupMap and GroupMapOutput values. You can construct a concrete instance of `GroupMapInput` via: 

GroupMap{ "key": GroupArgs{...} }

type GroupMapOutput 

type GroupMapOutput struct{ *pulumi.OutputState }

func (GroupMapOutput) ElementType 

func (GroupMapOutput) ElementType() reflect.Type

func (GroupMapOutput) MapIndex 

func (o GroupMapOutput) MapIndex(k pulumi.StringInput) GroupOutput

func (GroupMapOutput) ToGroupMapOutput 

func (o GroupMapOutput) ToGroupMapOutput() GroupMapOutput

func (GroupMapOutput) ToGroupMapOutputWithContext 

func (o GroupMapOutput) ToGroupMapOutputWithContext(ctx context.Context) GroupMapOutput

type GroupOutput 

type GroupOutput struct{ *pulumi.OutputState }

func (GroupOutput) CustomProfileAttributes 

func (o GroupOutput) CustomProfileAttributes() pulumi.StringPtrOutput

raw JSON containing all custom profile attributes.

func (GroupOutput) Description 

func (o GroupOutput) Description() pulumi.StringPtrOutput

The description of the Okta Group.

func (GroupOutput) ElementType 

func (GroupOutput) ElementType() reflect.Type

func (GroupOutput) Name 

func (o GroupOutput) Name() pulumi.StringOutput

The name of the Okta Group.

func (GroupOutput) SkipUsers deprecated added in v4.0.2 

func (o GroupOutput) SkipUsers() pulumi.BoolPtrOutput

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

func (GroupOutput) ToGroupOutput 

func (o GroupOutput) ToGroupOutput() GroupOutput

func (GroupOutput) ToGroupOutputWithContext 

func (o GroupOutput) ToGroupOutputWithContext(ctx context.Context) GroupOutput

type GroupState 

type GroupState struct {
	// raw JSON containing all custom profile attributes.
	CustomProfileAttributes pulumi.StringPtrInput
	// The description of the Okta Group.
	Description pulumi.StringPtrInput
	// The name of the Okta Group.
	Name pulumi.StringPtrInput
	// 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
	SkipUsers pulumi.BoolPtrInput
}

func (GroupState) ElementType 

func (GroupState) ElementType() reflect.Type

type LookupGroupArgs 

type LookupGroupArgs struct {
	// Force delay of the group read by N seconds. Useful when eventual consistency of group information needs to be allowed for; for instance, when group rules are known to have been applied.
	DelayReadSeconds *string `pulumi:"delayReadSeconds"`
	// ID of the group. Conflicts with `"name"` and `"type"`.
	Id *string `pulumi:"id"`
	// whether to retrieve all member ids.
	IncludeUsers *bool `pulumi:"includeUsers"`
	// name of group to retrieve.
	//
	// > Okta API treats `name` as a starts with query. Therefore a name argument "My" will match any group starting with "My" such as "My Group" and "My Office"
	Name *string `pulumi:"name"`
	// type of the group to retrieve. Can only be one of `OKTA_GROUP` (Native Okta Groups), `APP_GROUP`
	// (Imported App Groups), or `BUILT_IN` (Okta System Groups).
	Type *string `pulumi:"type"`
}

A collection of arguments for invoking getGroup.

type LookupGroupOutputArgs 

type LookupGroupOutputArgs struct {
	// Force delay of the group read by N seconds. Useful when eventual consistency of group information needs to be allowed for; for instance, when group rules are known to have been applied.
	DelayReadSeconds pulumi.StringPtrInput `pulumi:"delayReadSeconds"`
	// ID of the group. Conflicts with `"name"` and `"type"`.
	Id pulumi.StringPtrInput `pulumi:"id"`
	// whether to retrieve all member ids.
	IncludeUsers pulumi.BoolPtrInput `pulumi:"includeUsers"`
	// name of group to retrieve.
	//
	// > Okta API treats `name` as a starts with query. Therefore a name argument "My" will match any group starting with "My" such as "My Group" and "My Office"
	Name pulumi.StringPtrInput `pulumi:"name"`
	// type of the group to retrieve. Can only be one of `OKTA_GROUP` (Native Okta Groups), `APP_GROUP`
	// (Imported App Groups), or `BUILT_IN` (Okta System Groups).
	Type pulumi.StringPtrInput `pulumi:"type"`
}

A collection of arguments for invoking getGroup.

func (LookupGroupOutputArgs) ElementType 

func (LookupGroupOutputArgs) ElementType() reflect.Type

type LookupGroupResult 

type LookupGroupResult struct {
	DelayReadSeconds *string `pulumi:"delayReadSeconds"`
	// description of group.
	Description string `pulumi:"description"`
	// ID of group.
	Id           string `pulumi:"id"`
	IncludeUsers *bool  `pulumi:"includeUsers"`
	// name of group.
	Name string `pulumi:"name"`
	// type of group.
	Type *string `pulumi:"type"`
	// user ids that are members of this group, only included if `includeUsers` is set to `true`.
	Users []string `pulumi:"users"`
}

A collection of values returned by getGroup.

func LookupGroup 

func LookupGroup(ctx *pulumi.Context, args *LookupGroupArgs, opts ...pulumi.InvokeOption) (*LookupGroupResult, error)

Use this data source to retrieve a group from Okta.

## Example Usage

<!--Start PulumiCodeChooser --> ```go 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.LookupGroup(ctx, &group.LookupGroupArgs{
			Name: pulumi.StringRef("Example App"),
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

``` <!--End PulumiCodeChooser -->

type LookupGroupResultOutput 

type LookupGroupResultOutput struct{ *pulumi.OutputState }

A collection of values returned by getGroup.

func LookupGroupOutput 

func LookupGroupOutput(ctx *pulumi.Context, args LookupGroupOutputArgs, opts ...pulumi.InvokeOption) LookupGroupResultOutput

func (LookupGroupResultOutput) DelayReadSeconds 

func (o LookupGroupResultOutput) DelayReadSeconds() pulumi.StringPtrOutput

func (LookupGroupResultOutput) Description 

func (o LookupGroupResultOutput) Description() pulumi.StringOutput

description of group.

func (LookupGroupResultOutput) ElementType 

func (LookupGroupResultOutput) ElementType() reflect.Type

func (LookupGroupResultOutput) Id 

func (o LookupGroupResultOutput) Id() pulumi.StringOutput

ID of group.

func (LookupGroupResultOutput) IncludeUsers 

func (o LookupGroupResultOutput) IncludeUsers() pulumi.BoolPtrOutput

func (LookupGroupResultOutput) Name 

func (o LookupGroupResultOutput) Name() pulumi.StringOutput

name of group.

func (LookupGroupResultOutput) ToLookupGroupResultOutput 

func (o LookupGroupResultOutput) ToLookupGroupResultOutput() LookupGroupResultOutput

func (LookupGroupResultOutput) ToLookupGroupResultOutputWithContext 

func (o LookupGroupResultOutput) ToLookupGroupResultOutputWithContext(ctx context.Context) LookupGroupResultOutput

func (LookupGroupResultOutput) Type 

func (o LookupGroupResultOutput) Type() pulumi.StringPtrOutput

type of group.

func (LookupGroupResultOutput) Users 

func (o LookupGroupResultOutput) Users() pulumi.StringArrayOutput

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

type LookupRuleArgs added in v4.1.0 

type LookupRuleArgs struct {
	// The ID of the group rule to retrieve.
	Id *string `pulumi:"id"`
	// The name of the Group Rule to retrieve.
	Name *string `pulumi:"name"`
	// The status of the group rule.
	Status *string `pulumi:"status"`
}

A collection of arguments for invoking getRule.

type LookupRuleOutputArgs added in v4.1.0 

type LookupRuleOutputArgs struct {
	// The ID of the group rule to retrieve.
	Id pulumi.StringPtrInput `pulumi:"id"`
	// The name of the Group Rule to retrieve.
	Name pulumi.StringPtrInput `pulumi:"name"`
	// The status of the group rule.
	Status pulumi.StringPtrInput `pulumi:"status"`
}

A collection of arguments for invoking getRule.

func (LookupRuleOutputArgs) ElementType added in v4.1.0 

func (LookupRuleOutputArgs) ElementType() reflect.Type

type LookupRuleResult added in v4.1.0 

type LookupRuleResult struct {
	// The expression type to use to invoke the rule.
	ExpressionType string `pulumi:"expressionType"`
	// The expression value.
	ExpressionValue string `pulumi:"expressionValue"`
	// The list of group ids to assign the users to.
	GroupAssignments []string `pulumi:"groupAssignments"`
	// The ID of the Group Rule.
	Id *string `pulumi:"id"`
	// The name of the Group Rule.
	Name *string `pulumi:"name"`
	// The status of the group rule.
	Status *string `pulumi:"status"`
	// The list of user IDs that would be excluded when rules are processed.
	UsersExcludeds []string `pulumi:"usersExcludeds"`
}

A collection of values returned by getRule.

func LookupRule added in v4.1.0 

func LookupRule(ctx *pulumi.Context, args *LookupRuleArgs, opts ...pulumi.InvokeOption) (*LookupRuleResult, error)

Use this data source to retrieve a group rule from Okta.

## Example Usage

<!--Start PulumiCodeChooser --> ```go 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.LookupRule(ctx, &group.LookupRuleArgs{
			Id: pulumi.StringRef(okta_group_rule.Example.Id),
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

``` <!--End PulumiCodeChooser -->

type LookupRuleResultOutput added in v4.1.0 

type LookupRuleResultOutput struct{ *pulumi.OutputState }

A collection of values returned by getRule.

func LookupRuleOutput added in v4.1.0 

func LookupRuleOutput(ctx *pulumi.Context, args LookupRuleOutputArgs, opts ...pulumi.InvokeOption) LookupRuleResultOutput

func (LookupRuleResultOutput) ElementType added in v4.1.0 

func (LookupRuleResultOutput) ElementType() reflect.Type

func (LookupRuleResultOutput) ExpressionType added in v4.1.0 

func (o LookupRuleResultOutput) ExpressionType() pulumi.StringOutput

The expression type to use to invoke the rule.

func (LookupRuleResultOutput) ExpressionValue added in v4.1.0 

func (o LookupRuleResultOutput) ExpressionValue() pulumi.StringOutput

The expression value.

func (LookupRuleResultOutput) GroupAssignments added in v4.1.0 

func (o LookupRuleResultOutput) GroupAssignments() pulumi.StringArrayOutput

The list of group ids to assign the users to.

func (LookupRuleResultOutput) Id added in v4.1.0 

func (o LookupRuleResultOutput) Id() pulumi.StringPtrOutput

The ID of the Group Rule.

func (LookupRuleResultOutput) Name added in v4.1.0 

func (o LookupRuleResultOutput) Name() pulumi.StringPtrOutput

The name of the Group Rule.

func (LookupRuleResultOutput) Status added in v4.1.0 

func (o LookupRuleResultOutput) Status() pulumi.StringPtrOutput

The status of the group rule.

func (LookupRuleResultOutput) ToLookupRuleResultOutput added in v4.1.0 

func (o LookupRuleResultOutput) ToLookupRuleResultOutput() LookupRuleResultOutput

func (LookupRuleResultOutput) ToLookupRuleResultOutputWithContext added in v4.1.0 

func (o LookupRuleResultOutput) ToLookupRuleResultOutputWithContext(ctx context.Context) LookupRuleResultOutput

func (LookupRuleResultOutput) UsersExcludeds added in v4.1.0 

func (o LookupRuleResultOutput) UsersExcludeds() pulumi.StringArrayOutput

The list of user IDs that would be excluded when rules are processed.

type Role 

type Role struct {
	pulumi.CustomResourceState

	// When this setting is enabled, the admins won't receive any of the default Okta
	// administrator emails. These admins also won't have access to contact Okta Support and open support cases on behalf of your org.
	DisableNotifications pulumi.BoolPtrOutput `pulumi:"disableNotifications"`
	// The ID of group to attach admin roles to.
	GroupId pulumi.StringOutput `pulumi:"groupId"`
	// Admin role assigned to the group. It can be any one of the following values:
	// `"API_ACCESS_MANAGEMENT_ADMIN"`,
	// `"APP_ADMIN"`,
	// `"CUSTOM"`,
	// `"GROUP_MEMBERSHIP_ADMIN"`,
	// `"HELP_DESK_ADMIN"`,
	// `"MOBILE_ADMIN"`,
	// `"ORG_ADMIN"`,
	// `"READ_ONLY_ADMIN"`,
	// `"REPORT_ADMIN"`,
	// `"SUPER_ADMIN"`,
	// `"USER_ADMIN"`
	// . See [API Docs](https://developer.okta.com/docs/reference/api/roles/#role-types).
	//
	// - `"USER_ADMIN"` is the Group Administrator.
	RoleType pulumi.StringOutput `pulumi:"roleType"`
	// A list of app names (name represents set of app instances, like 'salesforce' or '
	// facebook'), or a combination of app name and app instance ID (like 'facebook.0oapsqQ6dv19pqyEo0g3') you would like as
	// the targets of the admin role.
	// - Only supported when used with the role type `"APP_ADMIN"`.
	TargetAppLists pulumi.StringArrayOutput `pulumi:"targetAppLists"`
	// A list of group IDs you would like as the targets of the admin role.
	// - Only supported when used with the role types: `GROUP_MEMBERSHIP_ADMIN`, `HELP_DESK_ADMIN`, or `USER_ADMIN`.
	TargetGroupLists pulumi.StringArrayOutput `pulumi:"targetGroupLists"`
}

Assigns Admin roles to Okta Groups.

This resource allows you to assign Okta administrator roles to Okta Groups. This resource provides a one-to-one interface between the Okta group and the admin role.

## Example Usage

<!--Start PulumiCodeChooser --> ```go 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.NewRole(ctx, "example", &group.RoleArgs{
			GroupId:  pulumi.String("<group id>"),
			RoleType: pulumi.String("READ_ONLY_ADMIN"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

``` <!--End PulumiCodeChooser -->

## Import

Individual admin role assignment can be imported by passing the group and role assignment IDs as follows:

```sh $ pulumi import okta:group/role:Role example &#60;group id&#62;/&#60;role id&#62; ```

func GetRole 

func GetRole(ctx *pulumi.Context,
	name string, id pulumi.IDInput, state *RoleState, opts ...pulumi.ResourceOption) (*Role, error)

GetRole gets an existing Role resource's state with the given name, ID, and optional state properties that are used to uniquely qualify the lookup (nil if not required).

func NewRole 

func NewRole(ctx *pulumi.Context,
	name string, args *RoleArgs, opts ...pulumi.ResourceOption) (*Role, error)

NewRole registers a new resource with the given unique name, arguments, and options.

func (*Role) ElementType 

func (*Role) ElementType() reflect.Type

func (*Role) ToRoleOutput 

func (i *Role) ToRoleOutput() RoleOutput

func (*Role) ToRoleOutputWithContext 

func (i *Role) ToRoleOutputWithContext(ctx context.Context) RoleOutput

type RoleArgs 

type RoleArgs struct {
	// When this setting is enabled, the admins won't receive any of the default Okta
	// administrator emails. These admins also won't have access to contact Okta Support and open support cases on behalf of your org.
	DisableNotifications pulumi.BoolPtrInput
	// The ID of group to attach admin roles to.
	GroupId pulumi.StringInput
	// Admin role assigned to the group. It can be any one of the following values:
	// `"API_ACCESS_MANAGEMENT_ADMIN"`,
	// `"APP_ADMIN"`,
	// `"CUSTOM"`,
	// `"GROUP_MEMBERSHIP_ADMIN"`,
	// `"HELP_DESK_ADMIN"`,
	// `"MOBILE_ADMIN"`,
	// `"ORG_ADMIN"`,
	// `"READ_ONLY_ADMIN"`,
	// `"REPORT_ADMIN"`,
	// `"SUPER_ADMIN"`,
	// `"USER_ADMIN"`
	// . See [API Docs](https://developer.okta.com/docs/reference/api/roles/#role-types).
	//
	// - `"USER_ADMIN"` is the Group Administrator.
	RoleType pulumi.StringInput
	// A list of app names (name represents set of app instances, like 'salesforce' or '
	// facebook'), or a combination of app name and app instance ID (like 'facebook.0oapsqQ6dv19pqyEo0g3') you would like as
	// the targets of the admin role.
	// - Only supported when used with the role type `"APP_ADMIN"`.
	TargetAppLists pulumi.StringArrayInput
	// A list of group IDs you would like as the targets of the admin role.
	// - Only supported when used with the role types: `GROUP_MEMBERSHIP_ADMIN`, `HELP_DESK_ADMIN`, or `USER_ADMIN`.
	TargetGroupLists pulumi.StringArrayInput
}

The set of arguments for constructing a Role resource.

func (RoleArgs) ElementType 

func (RoleArgs) ElementType() reflect.Type

type RoleArray 

type RoleArray []RoleInput

func (RoleArray) ElementType 

func (RoleArray) ElementType() reflect.Type

func (RoleArray) ToRoleArrayOutput 

func (i RoleArray) ToRoleArrayOutput() RoleArrayOutput

func (RoleArray) ToRoleArrayOutputWithContext 

func (i RoleArray) ToRoleArrayOutputWithContext(ctx context.Context) RoleArrayOutput

type RoleArrayInput 

type RoleArrayInput interface {
	pulumi.Input

	ToRoleArrayOutput() RoleArrayOutput
	ToRoleArrayOutputWithContext(context.Context) RoleArrayOutput
}

RoleArrayInput is an input type that accepts RoleArray and RoleArrayOutput values. You can construct a concrete instance of `RoleArrayInput` via: 

RoleArray{ RoleArgs{...} }

type RoleArrayOutput 

type RoleArrayOutput struct{ *pulumi.OutputState }

func (RoleArrayOutput) ElementType 

func (RoleArrayOutput) ElementType() reflect.Type

func (RoleArrayOutput) Index 

func (o RoleArrayOutput) Index(i pulumi.IntInput) RoleOutput

func (RoleArrayOutput) ToRoleArrayOutput 

func (o RoleArrayOutput) ToRoleArrayOutput() RoleArrayOutput

func (RoleArrayOutput) ToRoleArrayOutputWithContext 

func (o RoleArrayOutput) ToRoleArrayOutputWithContext(ctx context.Context) RoleArrayOutput

type RoleInput 

type RoleInput interface {
	pulumi.Input

	ToRoleOutput() RoleOutput
	ToRoleOutputWithContext(ctx context.Context) RoleOutput
}

type RoleMap 

type RoleMap map[string]RoleInput

func (RoleMap) ElementType 

func (RoleMap) ElementType() reflect.Type

func (RoleMap) ToRoleMapOutput 

func (i RoleMap) ToRoleMapOutput() RoleMapOutput

func (RoleMap) ToRoleMapOutputWithContext 

func (i RoleMap) ToRoleMapOutputWithContext(ctx context.Context) RoleMapOutput

type RoleMapInput 

type RoleMapInput interface {
	pulumi.Input

	ToRoleMapOutput() RoleMapOutput
	ToRoleMapOutputWithContext(context.Context) RoleMapOutput
}

RoleMapInput is an input type that accepts RoleMap and RoleMapOutput values. You can construct a concrete instance of `RoleMapInput` via: 

RoleMap{ "key": RoleArgs{...} }

type RoleMapOutput 

type RoleMapOutput struct{ *pulumi.OutputState }

func (RoleMapOutput) ElementType 

func (RoleMapOutput) ElementType() reflect.Type

func (RoleMapOutput) MapIndex 

func (o RoleMapOutput) MapIndex(k pulumi.StringInput) RoleOutput

func (RoleMapOutput) ToRoleMapOutput 

func (o RoleMapOutput) ToRoleMapOutput() RoleMapOutput

func (RoleMapOutput) ToRoleMapOutputWithContext 

func (o RoleMapOutput) ToRoleMapOutputWithContext(ctx context.Context) RoleMapOutput

type RoleOutput 

type RoleOutput struct{ *pulumi.OutputState }

func (RoleOutput) DisableNotifications 

func (o RoleOutput) DisableNotifications() pulumi.BoolPtrOutput

When this setting is enabled, the admins won't receive any of the default Okta administrator emails. These admins also won't have access to contact Okta Support and open support cases on behalf of your org.

func (RoleOutput) ElementType 

func (RoleOutput) ElementType() reflect.Type

func (RoleOutput) GroupId 

func (o RoleOutput) GroupId() pulumi.StringOutput

The ID of group to attach admin roles to.

func (RoleOutput) RoleType 

func (o RoleOutput) RoleType() pulumi.StringOutput

Admin role assigned to the group. It can be any one of the following values: `"API_ACCESS_MANAGEMENT_ADMIN"`, `"APP_ADMIN"`, `"CUSTOM"`, `"GROUP_MEMBERSHIP_ADMIN"`, `"HELP_DESK_ADMIN"`, `"MOBILE_ADMIN"`, `"ORG_ADMIN"`, `"READ_ONLY_ADMIN"`, `"REPORT_ADMIN"`, `"SUPER_ADMIN"`, `"USER_ADMIN"` . See [API Docs](https://developer.okta.com/docs/reference/api/roles/#role-types).

- `"USER_ADMIN"` is the Group Administrator.

func (RoleOutput) TargetAppLists 

func (o RoleOutput) TargetAppLists() pulumi.StringArrayOutput

A list of app names (name represents set of app instances, like 'salesforce' or ' facebook'), or a combination of app name and app instance ID (like 'facebook.0oapsqQ6dv19pqyEo0g3') you would like as the targets of the admin role. - Only supported when used with the role type `"APP_ADMIN"`.

func (RoleOutput) TargetGroupLists 

func (o RoleOutput) TargetGroupLists() pulumi.StringArrayOutput

A list of group IDs you would like as the targets of the admin role. - Only supported when used with the role types: `GROUP_MEMBERSHIP_ADMIN`, `HELP_DESK_ADMIN`, or `USER_ADMIN`.

func (RoleOutput) ToRoleOutput 

func (o RoleOutput) ToRoleOutput() RoleOutput

func (RoleOutput) ToRoleOutputWithContext 

func (o RoleOutput) ToRoleOutputWithContext(ctx context.Context) RoleOutput

type RoleState 

type RoleState struct {
	// When this setting is enabled, the admins won't receive any of the default Okta
	// administrator emails. These admins also won't have access to contact Okta Support and open support cases on behalf of your org.
	DisableNotifications pulumi.BoolPtrInput
	// The ID of group to attach admin roles to.
	GroupId pulumi.StringPtrInput
	// Admin role assigned to the group. It can be any one of the following values:
	// `"API_ACCESS_MANAGEMENT_ADMIN"`,
	// `"APP_ADMIN"`,
	// `"CUSTOM"`,
	// `"GROUP_MEMBERSHIP_ADMIN"`,
	// `"HELP_DESK_ADMIN"`,
	// `"MOBILE_ADMIN"`,
	// `"ORG_ADMIN"`,
	// `"READ_ONLY_ADMIN"`,
	// `"REPORT_ADMIN"`,
	// `"SUPER_ADMIN"`,
	// `"USER_ADMIN"`
	// . See [API Docs](https://developer.okta.com/docs/reference/api/roles/#role-types).
	//
	// - `"USER_ADMIN"` is the Group Administrator.
	RoleType pulumi.StringPtrInput
	// A list of app names (name represents set of app instances, like 'salesforce' or '
	// facebook'), or a combination of app name and app instance ID (like 'facebook.0oapsqQ6dv19pqyEo0g3') you would like as
	// the targets of the admin role.
	// - Only supported when used with the role type `"APP_ADMIN"`.
	TargetAppLists pulumi.StringArrayInput
	// A list of group IDs you would like as the targets of the admin role.
	// - Only supported when used with the role types: `GROUP_MEMBERSHIP_ADMIN`, `HELP_DESK_ADMIN`, or `USER_ADMIN`.
	TargetGroupLists pulumi.StringArrayInput
}

func (RoleState) ElementType 

func (RoleState) ElementType() reflect.Type

type Rule 

type Rule struct {
	pulumi.CustomResourceState

	// The expression type to use to invoke the rule. The default
	// is `"urn:okta:expression:1.0"`.
	ExpressionType pulumi.StringPtrOutput `pulumi:"expressionType"`
	// The expression value.
	ExpressionValue pulumi.StringOutput `pulumi:"expressionValue"`
	// The list of group ids to assign the users to.
	GroupAssignments pulumi.StringArrayOutput `pulumi:"groupAssignments"`
	// The name of the Group Rule (min character 1; max characters 50).
	Name pulumi.StringOutput `pulumi:"name"`
	// This tells the provider to remove users added by this rule from the assigned
	// group after destroying this resource. Default is `false`.
	RemoveAssignedUsers pulumi.BoolPtrOutput `pulumi:"removeAssignedUsers"`
	// The status of the group rule.
	Status pulumi.StringPtrOutput `pulumi:"status"`
	// The list of user IDs that would be excluded when rules are processed.
	UsersExcludeds pulumi.StringArrayOutput `pulumi:"usersExcludeds"`
}

## Example Usage

<!--Start PulumiCodeChooser --> ```go 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.NewRule(ctx, "example", &group.RuleArgs{
			ExpressionType:  pulumi.String("urn:okta:expression:1.0"),
			ExpressionValue: pulumi.String("String.startsWith(user.firstName,\"andy\")"),
			GroupAssignments: pulumi.StringArray{
				pulumi.String("<group id>"),
			},
			Status: pulumi.String("ACTIVE"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

``` <!--End PulumiCodeChooser -->

## Import

An Okta Group Rule can be imported via the Okta ID.

```sh $ pulumi import okta:group/rule:Rule example &#60;group rule id&#62; ```

func GetRule 

func GetRule(ctx *pulumi.Context,
	name string, id pulumi.IDInput, state *RuleState, opts ...pulumi.ResourceOption) (*Rule, error)

GetRule gets an existing Rule resource's state with the given name, ID, and optional state properties that are used to uniquely qualify the lookup (nil if not required).

func NewRule 

func NewRule(ctx *pulumi.Context,
	name string, args *RuleArgs, opts ...pulumi.ResourceOption) (*Rule, error)

NewRule registers a new resource with the given unique name, arguments, and options.

func (*Rule) ElementType 

func (*Rule) ElementType() reflect.Type

func (*Rule) ToRuleOutput 

func (i *Rule) ToRuleOutput() RuleOutput

func (*Rule) ToRuleOutputWithContext 

func (i *Rule) ToRuleOutputWithContext(ctx context.Context) RuleOutput

type RuleArgs 

type RuleArgs struct {
	// The expression type to use to invoke the rule. The default
	// is `"urn:okta:expression:1.0"`.
	ExpressionType pulumi.StringPtrInput
	// The expression value.
	ExpressionValue pulumi.StringInput
	// The list of group ids to assign the users to.
	GroupAssignments pulumi.StringArrayInput
	// The name of the Group Rule (min character 1; max characters 50).
	Name pulumi.StringPtrInput
	// This tells the provider to remove users added by this rule from the assigned
	// group after destroying this resource. Default is `false`.
	RemoveAssignedUsers pulumi.BoolPtrInput
	// The status of the group rule.
	Status pulumi.StringPtrInput
	// The list of user IDs that would be excluded when rules are processed.
	UsersExcludeds pulumi.StringArrayInput
}

The set of arguments for constructing a Rule resource.

func (RuleArgs) ElementType 

func (RuleArgs) ElementType() reflect.Type

type RuleArray 

type RuleArray []RuleInput

func (RuleArray) ElementType 

func (RuleArray) ElementType() reflect.Type

func (RuleArray) ToRuleArrayOutput 

func (i RuleArray) ToRuleArrayOutput() RuleArrayOutput

func (RuleArray) ToRuleArrayOutputWithContext 

func (i RuleArray) ToRuleArrayOutputWithContext(ctx context.Context) RuleArrayOutput

type RuleArrayInput 

type RuleArrayInput interface {
	pulumi.Input

	ToRuleArrayOutput() RuleArrayOutput
	ToRuleArrayOutputWithContext(context.Context) RuleArrayOutput
}

RuleArrayInput is an input type that accepts RuleArray and RuleArrayOutput values. You can construct a concrete instance of `RuleArrayInput` via: 

RuleArray{ RuleArgs{...} }

type RuleArrayOutput 

type RuleArrayOutput struct{ *pulumi.OutputState }

func (RuleArrayOutput) ElementType 

func (RuleArrayOutput) ElementType() reflect.Type

func (RuleArrayOutput) Index 

func (o RuleArrayOutput) Index(i pulumi.IntInput) RuleOutput

func (RuleArrayOutput) ToRuleArrayOutput 

func (o RuleArrayOutput) ToRuleArrayOutput() RuleArrayOutput

func (RuleArrayOutput) ToRuleArrayOutputWithContext 

func (o RuleArrayOutput) ToRuleArrayOutputWithContext(ctx context.Context) RuleArrayOutput

type RuleInput 

type RuleInput interface {
	pulumi.Input

	ToRuleOutput() RuleOutput
	ToRuleOutputWithContext(ctx context.Context) RuleOutput
}

type RuleMap 

type RuleMap map[string]RuleInput

func (RuleMap) ElementType 

func (RuleMap) ElementType() reflect.Type

func (RuleMap) ToRuleMapOutput 

func (i RuleMap) ToRuleMapOutput() RuleMapOutput

func (RuleMap) ToRuleMapOutputWithContext 

func (i RuleMap) ToRuleMapOutputWithContext(ctx context.Context) RuleMapOutput

type RuleMapInput 

type RuleMapInput interface {
	pulumi.Input

	ToRuleMapOutput() RuleMapOutput
	ToRuleMapOutputWithContext(context.Context) RuleMapOutput
}

RuleMapInput is an input type that accepts RuleMap and RuleMapOutput values. You can construct a concrete instance of `RuleMapInput` via: 

RuleMap{ "key": RuleArgs{...} }

type RuleMapOutput 

type RuleMapOutput struct{ *pulumi.OutputState }

func (RuleMapOutput) ElementType 

func (RuleMapOutput) ElementType() reflect.Type

func (RuleMapOutput) MapIndex 

func (o RuleMapOutput) MapIndex(k pulumi.StringInput) RuleOutput

func (RuleMapOutput) ToRuleMapOutput 

func (o RuleMapOutput) ToRuleMapOutput() RuleMapOutput

func (RuleMapOutput) ToRuleMapOutputWithContext 

func (o RuleMapOutput) ToRuleMapOutputWithContext(ctx context.Context) RuleMapOutput

type RuleOutput 

type RuleOutput struct{ *pulumi.OutputState }

func (RuleOutput) ElementType 

func (RuleOutput) ElementType() reflect.Type

func (RuleOutput) ExpressionType 

func (o RuleOutput) ExpressionType() pulumi.StringPtrOutput

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

func (RuleOutput) ExpressionValue 

func (o RuleOutput) ExpressionValue() pulumi.StringOutput

The expression value.

func (RuleOutput) GroupAssignments 

func (o RuleOutput) GroupAssignments() pulumi.StringArrayOutput

The list of group ids to assign the users to.

func (RuleOutput) Name 

func (o RuleOutput) Name() pulumi.StringOutput

The name of the Group Rule (min character 1; max characters 50).

func (RuleOutput) RemoveAssignedUsers 

func (o RuleOutput) RemoveAssignedUsers() pulumi.BoolPtrOutput

This tells the provider to remove users added by this rule from the assigned group after destroying this resource. Default is `false`.

func (RuleOutput) Status 

func (o RuleOutput) Status() pulumi.StringPtrOutput

The status of the group rule.

func (RuleOutput) ToRuleOutput 

func (o RuleOutput) ToRuleOutput() RuleOutput

func (RuleOutput) ToRuleOutputWithContext 

func (o RuleOutput) ToRuleOutputWithContext(ctx context.Context) RuleOutput

func (RuleOutput) UsersExcludeds 

func (o RuleOutput) UsersExcludeds() pulumi.StringArrayOutput

The list of user IDs that would be excluded when rules are processed.

type RuleState 

type RuleState struct {
	// The expression type to use to invoke the rule. The default
	// is `"urn:okta:expression:1.0"`.
	ExpressionType pulumi.StringPtrInput
	// The expression value.
	ExpressionValue pulumi.StringPtrInput
	// The list of group ids to assign the users to.
	GroupAssignments pulumi.StringArrayInput
	// The name of the Group Rule (min character 1; max characters 50).
	Name pulumi.StringPtrInput
	// This tells the provider to remove users added by this rule from the assigned
	// group after destroying this resource. Default is `false`.
	RemoveAssignedUsers pulumi.BoolPtrInput
	// The status of the group rule.
	Status pulumi.StringPtrInput
	// The list of user IDs that would be excluded when rules are processed.
	UsersExcludeds pulumi.StringArrayInput
}

func (RuleState) ElementType 

func (RuleState) ElementType() reflect.Type

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.