Documentation ¶
Index ¶
- type GetEveryoneGroupArgs
- type GetEveryoneGroupOutputArgs
- type GetEveryoneGroupResult
- type GetEveryoneGroupResultOutput
- func (o GetEveryoneGroupResultOutput) Description() pulumi.StringOutput
- func (GetEveryoneGroupResultOutput) ElementType() reflect.Type
- func (o GetEveryoneGroupResultOutput) Id() pulumi.StringOutput
- func (o GetEveryoneGroupResultOutput) IncludeUsers() pulumi.BoolPtrOutput
- func (o GetEveryoneGroupResultOutput) ToGetEveryoneGroupResultOutput() GetEveryoneGroupResultOutput
- func (o GetEveryoneGroupResultOutput) ToGetEveryoneGroupResultOutputWithContext(ctx context.Context) GetEveryoneGroupResultOutput
- type Group
- type GroupArgs
- type GroupArray
- type GroupArrayInput
- type GroupArrayOutput
- type GroupInput
- type GroupMap
- type GroupMapInput
- type GroupMapOutput
- type GroupOutput
- func (o GroupOutput) CustomProfileAttributes() pulumi.StringPtrOutput
- func (o GroupOutput) Description() pulumi.StringPtrOutput
- func (GroupOutput) ElementType() reflect.Type
- func (o GroupOutput) Name() pulumi.StringOutput
- func (o GroupOutput) SkipUsers() pulumi.BoolPtrOutput
- func (o GroupOutput) ToGroupOutput() GroupOutput
- func (o GroupOutput) ToGroupOutputWithContext(ctx context.Context) GroupOutput
- func (o GroupOutput) Users() pulumi.StringArrayOutputdeprecated
- type GroupState
- type LookupGroupArgs
- type LookupGroupOutputArgs
- type LookupGroupResult
- type LookupGroupResultOutput
- func (o LookupGroupResultOutput) DelayReadSeconds() pulumi.StringPtrOutput
- func (o LookupGroupResultOutput) Description() pulumi.StringOutput
- func (LookupGroupResultOutput) ElementType() reflect.Type
- func (o LookupGroupResultOutput) Id() pulumi.StringPtrOutput
- func (o LookupGroupResultOutput) IncludeUsers() pulumi.BoolPtrOutput
- func (o LookupGroupResultOutput) Name() pulumi.StringPtrOutput
- func (o LookupGroupResultOutput) ToLookupGroupResultOutput() LookupGroupResultOutput
- func (o LookupGroupResultOutput) ToLookupGroupResultOutputWithContext(ctx context.Context) LookupGroupResultOutput
- func (o LookupGroupResultOutput) Type() pulumi.StringPtrOutput
- func (o LookupGroupResultOutput) Users() pulumi.StringArrayOutput
- type Membership
- type MembershipArgs
- type MembershipArray
- type MembershipArrayInput
- type MembershipArrayOutput
- func (MembershipArrayOutput) ElementType() reflect.Type
- func (o MembershipArrayOutput) Index(i pulumi.IntInput) MembershipOutput
- func (o MembershipArrayOutput) ToMembershipArrayOutput() MembershipArrayOutput
- func (o MembershipArrayOutput) ToMembershipArrayOutputWithContext(ctx context.Context) MembershipArrayOutput
- type MembershipInput
- type MembershipMap
- type MembershipMapInput
- type MembershipMapOutput
- func (MembershipMapOutput) ElementType() reflect.Type
- func (o MembershipMapOutput) MapIndex(k pulumi.StringInput) MembershipOutput
- func (o MembershipMapOutput) ToMembershipMapOutput() MembershipMapOutput
- func (o MembershipMapOutput) ToMembershipMapOutputWithContext(ctx context.Context) MembershipMapOutput
- type MembershipOutput
- func (MembershipOutput) ElementType() reflect.Type
- func (o MembershipOutput) GroupId() pulumi.StringOutput
- func (o MembershipOutput) ToMembershipOutput() MembershipOutput
- func (o MembershipOutput) ToMembershipOutputWithContext(ctx context.Context) MembershipOutput
- func (o MembershipOutput) UserId() pulumi.StringOutput
- type MembershipState
- type Role
- type RoleArgs
- type RoleArray
- type RoleArrayInput
- type RoleArrayOutput
- type RoleInput
- type RoleMap
- type RoleMapInput
- type RoleMapOutput
- type RoleOutput
- func (o RoleOutput) DisableNotifications() pulumi.BoolPtrOutput
- func (RoleOutput) ElementType() reflect.Type
- func (o RoleOutput) GroupId() pulumi.StringOutput
- func (o RoleOutput) RoleType() pulumi.StringOutput
- func (o RoleOutput) TargetAppLists() pulumi.StringArrayOutput
- func (o RoleOutput) TargetGroupLists() pulumi.StringArrayOutput
- func (o RoleOutput) ToRoleOutput() RoleOutput
- func (o RoleOutput) ToRoleOutputWithContext(ctx context.Context) RoleOutput
- type RoleState
- type Roles
- type RolesArgs
- type RolesArray
- type RolesArrayInput
- type RolesArrayOutput
- type RolesInput
- type RolesMap
- type RolesMapInput
- type RolesMapOutput
- type RolesOutput
- type RolesState
- type Rule
- type RuleArgs
- type RuleArray
- type RuleArrayInput
- type RuleArrayOutput
- type RuleInput
- type RuleMap
- type RuleMapInput
- type RuleMapOutput
- type RuleOutput
- func (RuleOutput) ElementType() reflect.Type
- func (o RuleOutput) ExpressionType() pulumi.StringPtrOutput
- func (o RuleOutput) ExpressionValue() pulumi.StringOutput
- func (o RuleOutput) GroupAssignments() pulumi.StringArrayOutput
- func (o RuleOutput) Name() pulumi.StringOutput
- func (o RuleOutput) RemoveAssignedUsers() pulumi.BoolPtrOutput
- func (o RuleOutput) Status() pulumi.StringPtrOutput
- func (o RuleOutput) ToRuleOutput() RuleOutput
- func (o RuleOutput) ToRuleOutputWithContext(ctx context.Context) RuleOutput
- func (o RuleOutput) UsersExcludeds() pulumi.StringArrayOutput
- type RuleState
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 ¶ added in v3.2.0
type GetEveryoneGroupOutputArgs struct { // whether to retrieve all member ids. IncludeUsers pulumi.BoolPtrInput `pulumi:"includeUsers"` }
A collection of arguments for invoking getEveryoneGroup.
func (GetEveryoneGroupOutputArgs) ElementType ¶ added in v3.2.0
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
```go 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 }) }
```
type GetEveryoneGroupResultOutput ¶ added in v3.2.0
type GetEveryoneGroupResultOutput struct{ *pulumi.OutputState }
A collection of values returned by getEveryoneGroup.
func GetEveryoneGroupOutput ¶ added in v3.2.0
func GetEveryoneGroupOutput(ctx *pulumi.Context, args GetEveryoneGroupOutputArgs, opts ...pulumi.InvokeOption) GetEveryoneGroupResultOutput
func (GetEveryoneGroupResultOutput) Description ¶ added in v3.2.0
func (o GetEveryoneGroupResultOutput) Description() pulumi.StringOutput
description of group.
func (GetEveryoneGroupResultOutput) ElementType ¶ added in v3.2.0
func (GetEveryoneGroupResultOutput) ElementType() reflect.Type
func (GetEveryoneGroupResultOutput) Id ¶ added in v3.2.0
func (o GetEveryoneGroupResultOutput) Id() pulumi.StringOutput
The provider-assigned unique ID for this managed resource.
func (GetEveryoneGroupResultOutput) IncludeUsers ¶ added in v3.2.0
func (o GetEveryoneGroupResultOutput) IncludeUsers() pulumi.BoolPtrOutput
func (GetEveryoneGroupResultOutput) ToGetEveryoneGroupResultOutput ¶ added in v3.2.0
func (o GetEveryoneGroupResultOutput) ToGetEveryoneGroupResultOutput() GetEveryoneGroupResultOutput
func (GetEveryoneGroupResultOutput) ToGetEveryoneGroupResultOutputWithContext ¶ added in v3.2.0
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"` // Indicator that allows a group to skip `users` sync (it's also can be provided during import). Default is `false`. SkipUsers pulumi.BoolPtrOutput `pulumi:"skipUsers"` // The users associated with the group. This can also be done per user. // `DEPRECATED`: Please replace usage with the `GroupMemberships` resource. // // Deprecated: The `users` field is now deprecated for the resource `okta_group`, please replace all uses of this with: `okta_group_memberships` Users pulumi.StringArrayOutput `pulumi:"users"` }
Creates an Okta Group.
This resource allows you to create and configure an Okta Group.
## Example Usage
```go 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.NewGroup(ctx, "example", &group.GroupArgs{ Description: pulumi.String("My Example Group"), }) if err != nil { return err } return nil }) }
```
Ignore users sync ```go 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.NewGroup(ctx, "exampleSkip", &group.GroupArgs{ Description: pulumi.String("My Example Group"), SkipUsers: pulumi.Bool(true), }) if err != nil { return err } return nil }) }
```
Custom profile attributes ```go package main
import (
"encoding/json" "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 { 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 }) }
```
## Import
An Okta Group can be imported via the Okta ID.
```sh
$ pulumi import okta:group/group:Group example <group id>
```
It's also possible to import group without users. In this case ID will look like this
```sh
$ pulumi import okta:group/group:Group example <group id>/skip_users
```
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) 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 // Indicator that allows a group to skip `users` sync (it's also can be provided during import). Default is `false`. SkipUsers pulumi.BoolPtrInput // The users associated with the group. This can also be done per user. // `DEPRECATED`: Please replace usage with the `GroupMemberships` resource. // // Deprecated: The `users` field is now deprecated for the resource `okta_group`, please replace all uses of this with: `okta_group_memberships` Users pulumi.StringArrayInput }
The set of arguments for constructing a Group resource.
func (GroupArgs) ElementType ¶
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) 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 ¶ added in v3.9.0
func (o GroupOutput) CustomProfileAttributes() pulumi.StringPtrOutput
raw JSON containing all custom profile attributes.
func (GroupOutput) Description ¶ added in v3.9.0
func (o GroupOutput) Description() pulumi.StringPtrOutput
The description of the Okta Group.
func (GroupOutput) ElementType ¶
func (GroupOutput) ElementType() reflect.Type
func (GroupOutput) Name ¶ added in v3.9.0
func (o GroupOutput) Name() pulumi.StringOutput
The name of the Okta Group.
func (GroupOutput) SkipUsers ¶ added in v3.9.0
func (o GroupOutput) SkipUsers() pulumi.BoolPtrOutput
Indicator that allows a group to skip `users` sync (it's also can be provided during import). Default is `false`.
func (GroupOutput) ToGroupOutput ¶
func (o GroupOutput) ToGroupOutput() GroupOutput
func (GroupOutput) ToGroupOutputWithContext ¶
func (o GroupOutput) ToGroupOutputWithContext(ctx context.Context) GroupOutput
func (GroupOutput) Users
deprecated
added in
v3.9.0
func (o GroupOutput) Users() pulumi.StringArrayOutput
The users associated with the group. This can also be done per user. `DEPRECATED`: Please replace usage with the `GroupMemberships` resource.
Deprecated: The `users` field is now deprecated for the resource `okta_group`, please replace all uses of this with: `okta_group_memberships`
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 // Indicator that allows a group to skip `users` sync (it's also can be provided during import). Default is `false`. SkipUsers pulumi.BoolPtrInput // The users associated with the group. This can also be done per user. // `DEPRECATED`: Please replace usage with the `GroupMemberships` resource. // // Deprecated: The `users` field is now deprecated for the resource `okta_group`, please replace all uses of this with: `okta_group_memberships` Users pulumi.StringArrayInput }
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. 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 ¶ added in v3.2.0
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. 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 ¶ added in v3.2.0
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
```go 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.LookupGroup(ctx, &group.LookupGroupArgs{ Name: pulumi.StringRef("Example App"), }, nil) if err != nil { return err } return nil }) }
```
type LookupGroupResultOutput ¶ added in v3.2.0
type LookupGroupResultOutput struct{ *pulumi.OutputState }
A collection of values returned by getGroup.
func LookupGroupOutput ¶ added in v3.2.0
func LookupGroupOutput(ctx *pulumi.Context, args LookupGroupOutputArgs, opts ...pulumi.InvokeOption) LookupGroupResultOutput
func (LookupGroupResultOutput) DelayReadSeconds ¶ added in v3.10.0
func (o LookupGroupResultOutput) DelayReadSeconds() pulumi.StringPtrOutput
func (LookupGroupResultOutput) Description ¶ added in v3.2.0
func (o LookupGroupResultOutput) Description() pulumi.StringOutput
description of group.
func (LookupGroupResultOutput) ElementType ¶ added in v3.2.0
func (LookupGroupResultOutput) ElementType() reflect.Type
func (LookupGroupResultOutput) Id ¶ added in v3.2.0
func (o LookupGroupResultOutput) Id() pulumi.StringPtrOutput
ID of group.
func (LookupGroupResultOutput) IncludeUsers ¶ added in v3.2.0
func (o LookupGroupResultOutput) IncludeUsers() pulumi.BoolPtrOutput
func (LookupGroupResultOutput) Name ¶ added in v3.2.0
func (o LookupGroupResultOutput) Name() pulumi.StringPtrOutput
name of group.
func (LookupGroupResultOutput) ToLookupGroupResultOutput ¶ added in v3.2.0
func (o LookupGroupResultOutput) ToLookupGroupResultOutput() LookupGroupResultOutput
func (LookupGroupResultOutput) ToLookupGroupResultOutputWithContext ¶ added in v3.2.0
func (o LookupGroupResultOutput) ToLookupGroupResultOutputWithContext(ctx context.Context) LookupGroupResultOutput
func (LookupGroupResultOutput) Type ¶ added in v3.2.0
func (o LookupGroupResultOutput) Type() pulumi.StringPtrOutput
type of group.
func (LookupGroupResultOutput) Users ¶ added in v3.2.0
func (o LookupGroupResultOutput) Users() pulumi.StringArrayOutput
user ids that are members of this group, only included if `includeUsers` is set to `true`.
type Membership ¶
type Membership struct { pulumi.CustomResourceState // The ID of the Okta Group. GroupId pulumi.StringOutput `pulumi:"groupId"` // The ID of the Okta User. UserId pulumi.StringOutput `pulumi:"userId"` }
## Example Usage
```go 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.NewMembership(ctx, "example", &group.MembershipArgs{ GroupId: pulumi.String("00g1mana0vCrxzQY84x7"), UserId: pulumi.String("00u1manxvp7QBAGgk4x7"), }) if err != nil { return err } return nil }) }
```
func GetMembership ¶
func GetMembership(ctx *pulumi.Context, name string, id pulumi.IDInput, state *MembershipState, opts ...pulumi.ResourceOption) (*Membership, error)
GetMembership gets an existing Membership 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 NewMembership ¶
func NewMembership(ctx *pulumi.Context, name string, args *MembershipArgs, opts ...pulumi.ResourceOption) (*Membership, error)
NewMembership registers a new resource with the given unique name, arguments, and options.
func (*Membership) ElementType ¶
func (*Membership) ElementType() reflect.Type
func (*Membership) ToMembershipOutput ¶
func (i *Membership) ToMembershipOutput() MembershipOutput
func (*Membership) ToMembershipOutputWithContext ¶
func (i *Membership) ToMembershipOutputWithContext(ctx context.Context) MembershipOutput
type MembershipArgs ¶
type MembershipArgs struct { // The ID of the Okta Group. GroupId pulumi.StringInput // The ID of the Okta User. UserId pulumi.StringInput }
The set of arguments for constructing a Membership resource.
func (MembershipArgs) ElementType ¶
func (MembershipArgs) ElementType() reflect.Type
type MembershipArray ¶
type MembershipArray []MembershipInput
func (MembershipArray) ElementType ¶
func (MembershipArray) ElementType() reflect.Type
func (MembershipArray) ToMembershipArrayOutput ¶
func (i MembershipArray) ToMembershipArrayOutput() MembershipArrayOutput
func (MembershipArray) ToMembershipArrayOutputWithContext ¶
func (i MembershipArray) ToMembershipArrayOutputWithContext(ctx context.Context) MembershipArrayOutput
type MembershipArrayInput ¶
type MembershipArrayInput interface { pulumi.Input ToMembershipArrayOutput() MembershipArrayOutput ToMembershipArrayOutputWithContext(context.Context) MembershipArrayOutput }
MembershipArrayInput is an input type that accepts MembershipArray and MembershipArrayOutput values. You can construct a concrete instance of `MembershipArrayInput` via:
MembershipArray{ MembershipArgs{...} }
type MembershipArrayOutput ¶
type MembershipArrayOutput struct{ *pulumi.OutputState }
func (MembershipArrayOutput) ElementType ¶
func (MembershipArrayOutput) ElementType() reflect.Type
func (MembershipArrayOutput) Index ¶
func (o MembershipArrayOutput) Index(i pulumi.IntInput) MembershipOutput
func (MembershipArrayOutput) ToMembershipArrayOutput ¶
func (o MembershipArrayOutput) ToMembershipArrayOutput() MembershipArrayOutput
func (MembershipArrayOutput) ToMembershipArrayOutputWithContext ¶
func (o MembershipArrayOutput) ToMembershipArrayOutputWithContext(ctx context.Context) MembershipArrayOutput
type MembershipInput ¶
type MembershipInput interface { pulumi.Input ToMembershipOutput() MembershipOutput ToMembershipOutputWithContext(ctx context.Context) MembershipOutput }
type MembershipMap ¶
type MembershipMap map[string]MembershipInput
func (MembershipMap) ElementType ¶
func (MembershipMap) ElementType() reflect.Type
func (MembershipMap) ToMembershipMapOutput ¶
func (i MembershipMap) ToMembershipMapOutput() MembershipMapOutput
func (MembershipMap) ToMembershipMapOutputWithContext ¶
func (i MembershipMap) ToMembershipMapOutputWithContext(ctx context.Context) MembershipMapOutput
type MembershipMapInput ¶
type MembershipMapInput interface { pulumi.Input ToMembershipMapOutput() MembershipMapOutput ToMembershipMapOutputWithContext(context.Context) MembershipMapOutput }
MembershipMapInput is an input type that accepts MembershipMap and MembershipMapOutput values. You can construct a concrete instance of `MembershipMapInput` via:
MembershipMap{ "key": MembershipArgs{...} }
type MembershipMapOutput ¶
type MembershipMapOutput struct{ *pulumi.OutputState }
func (MembershipMapOutput) ElementType ¶
func (MembershipMapOutput) ElementType() reflect.Type
func (MembershipMapOutput) MapIndex ¶
func (o MembershipMapOutput) MapIndex(k pulumi.StringInput) MembershipOutput
func (MembershipMapOutput) ToMembershipMapOutput ¶
func (o MembershipMapOutput) ToMembershipMapOutput() MembershipMapOutput
func (MembershipMapOutput) ToMembershipMapOutputWithContext ¶
func (o MembershipMapOutput) ToMembershipMapOutputWithContext(ctx context.Context) MembershipMapOutput
type MembershipOutput ¶
type MembershipOutput struct{ *pulumi.OutputState }
func (MembershipOutput) ElementType ¶
func (MembershipOutput) ElementType() reflect.Type
func (MembershipOutput) GroupId ¶ added in v3.9.0
func (o MembershipOutput) GroupId() pulumi.StringOutput
The ID of the Okta Group.
func (MembershipOutput) ToMembershipOutput ¶
func (o MembershipOutput) ToMembershipOutput() MembershipOutput
func (MembershipOutput) ToMembershipOutputWithContext ¶
func (o MembershipOutput) ToMembershipOutputWithContext(ctx context.Context) MembershipOutput
func (MembershipOutput) UserId ¶ added in v3.9.0
func (o MembershipOutput) UserId() pulumi.StringOutput
The ID of the Okta User.
type MembershipState ¶
type MembershipState struct { // The ID of the Okta Group. GroupId pulumi.StringPtrInput // The ID of the Okta User. UserId pulumi.StringPtrInput }
func (MembershipState) ElementType ¶
func (MembershipState) ElementType() reflect.Type
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_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). 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
```go 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.NewRole(ctx, "example", &group.RoleArgs{ GroupId: pulumi.String("<group id>"), RoleType: pulumi.String("READ_ONLY_ADMIN"), }) if err != nil { return err } return nil }) }
```
## 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 <group id>/<role id>
```
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) 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_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). 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 ¶
type RoleArray ¶
type RoleArray []RoleInput
func (RoleArray) ElementType ¶
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 ¶
func (RoleMap) ElementType ¶
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 ¶ added in v3.9.0
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 ¶ added in v3.9.0
func (o RoleOutput) GroupId() pulumi.StringOutput
The ID of group to attach admin roles to.
func (RoleOutput) RoleType ¶ added in v3.9.0
func (o RoleOutput) RoleType() pulumi.StringOutput
Admin role assigned to the group. It can be any one of the following values: `"API_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).
func (RoleOutput) TargetAppLists ¶ added in v3.9.0
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 ¶ added in v3.9.0
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_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). 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 ¶
type Roles ¶
type Roles struct { pulumi.CustomResourceState // Admin roles associated with the group. It can be any of the following values: // `"API_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). AdminRoles pulumi.StringArrayOutput `pulumi:"adminRoles"` // The ID of group to attach admin roles to. GroupId pulumi.StringOutput `pulumi:"groupId"` }
> **DEPRECATED:** This resource is deprecated and will be removed in favor of using `group.Role`, please migrate as soon as possible
This resource allows you to create and configure Group level Admin Role Assignments.
## Example Usage
```go 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.NewRoles(ctx, "example", &group.RolesArgs{ AdminRoles: pulumi.StringArray{ pulumi.String("SUPER_ADMIN"), }, GroupId: pulumi.String("<group id>"), }) if err != nil { return err } return nil }) }
```
## Import
Group Role Assignment can be imported via the Okta Group ID.
```sh
$ pulumi import okta:group/roles:Roles example <group id>
```
func GetRoles ¶
func GetRoles(ctx *pulumi.Context, name string, id pulumi.IDInput, state *RolesState, opts ...pulumi.ResourceOption) (*Roles, error)
GetRoles gets an existing Roles 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 NewRoles ¶
func NewRoles(ctx *pulumi.Context, name string, args *RolesArgs, opts ...pulumi.ResourceOption) (*Roles, error)
NewRoles registers a new resource with the given unique name, arguments, and options.
func (*Roles) ElementType ¶
func (*Roles) ToRolesOutput ¶
func (i *Roles) ToRolesOutput() RolesOutput
func (*Roles) ToRolesOutputWithContext ¶
func (i *Roles) ToRolesOutputWithContext(ctx context.Context) RolesOutput
type RolesArgs ¶
type RolesArgs struct { // Admin roles associated with the group. It can be any of the following values: // `"API_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). AdminRoles pulumi.StringArrayInput // The ID of group to attach admin roles to. GroupId pulumi.StringInput }
The set of arguments for constructing a Roles resource.
func (RolesArgs) ElementType ¶
type RolesArray ¶
type RolesArray []RolesInput
func (RolesArray) ElementType ¶
func (RolesArray) ElementType() reflect.Type
func (RolesArray) ToRolesArrayOutput ¶
func (i RolesArray) ToRolesArrayOutput() RolesArrayOutput
func (RolesArray) ToRolesArrayOutputWithContext ¶
func (i RolesArray) ToRolesArrayOutputWithContext(ctx context.Context) RolesArrayOutput
type RolesArrayInput ¶
type RolesArrayInput interface { pulumi.Input ToRolesArrayOutput() RolesArrayOutput ToRolesArrayOutputWithContext(context.Context) RolesArrayOutput }
RolesArrayInput is an input type that accepts RolesArray and RolesArrayOutput values. You can construct a concrete instance of `RolesArrayInput` via:
RolesArray{ RolesArgs{...} }
type RolesArrayOutput ¶
type RolesArrayOutput struct{ *pulumi.OutputState }
func (RolesArrayOutput) ElementType ¶
func (RolesArrayOutput) ElementType() reflect.Type
func (RolesArrayOutput) Index ¶
func (o RolesArrayOutput) Index(i pulumi.IntInput) RolesOutput
func (RolesArrayOutput) ToRolesArrayOutput ¶
func (o RolesArrayOutput) ToRolesArrayOutput() RolesArrayOutput
func (RolesArrayOutput) ToRolesArrayOutputWithContext ¶
func (o RolesArrayOutput) ToRolesArrayOutputWithContext(ctx context.Context) RolesArrayOutput
type RolesInput ¶
type RolesInput interface { pulumi.Input ToRolesOutput() RolesOutput ToRolesOutputWithContext(ctx context.Context) RolesOutput }
type RolesMap ¶
type RolesMap map[string]RolesInput
func (RolesMap) ElementType ¶
func (RolesMap) ToRolesMapOutput ¶
func (i RolesMap) ToRolesMapOutput() RolesMapOutput
func (RolesMap) ToRolesMapOutputWithContext ¶
func (i RolesMap) ToRolesMapOutputWithContext(ctx context.Context) RolesMapOutput
type RolesMapInput ¶
type RolesMapInput interface { pulumi.Input ToRolesMapOutput() RolesMapOutput ToRolesMapOutputWithContext(context.Context) RolesMapOutput }
RolesMapInput is an input type that accepts RolesMap and RolesMapOutput values. You can construct a concrete instance of `RolesMapInput` via:
RolesMap{ "key": RolesArgs{...} }
type RolesMapOutput ¶
type RolesMapOutput struct{ *pulumi.OutputState }
func (RolesMapOutput) ElementType ¶
func (RolesMapOutput) ElementType() reflect.Type
func (RolesMapOutput) MapIndex ¶
func (o RolesMapOutput) MapIndex(k pulumi.StringInput) RolesOutput
func (RolesMapOutput) ToRolesMapOutput ¶
func (o RolesMapOutput) ToRolesMapOutput() RolesMapOutput
func (RolesMapOutput) ToRolesMapOutputWithContext ¶
func (o RolesMapOutput) ToRolesMapOutputWithContext(ctx context.Context) RolesMapOutput
type RolesOutput ¶
type RolesOutput struct{ *pulumi.OutputState }
func (RolesOutput) AdminRoles ¶ added in v3.9.0
func (o RolesOutput) AdminRoles() pulumi.StringArrayOutput
Admin roles associated with the group. It can be any of the following values: `"API_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).
func (RolesOutput) ElementType ¶
func (RolesOutput) ElementType() reflect.Type
func (RolesOutput) GroupId ¶ added in v3.9.0
func (o RolesOutput) GroupId() pulumi.StringOutput
The ID of group to attach admin roles to.
func (RolesOutput) ToRolesOutput ¶
func (o RolesOutput) ToRolesOutput() RolesOutput
func (RolesOutput) ToRolesOutputWithContext ¶
func (o RolesOutput) ToRolesOutputWithContext(ctx context.Context) RolesOutput
type RolesState ¶
type RolesState struct { // Admin roles associated with the group. It can be any of the following values: // `"API_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). AdminRoles pulumi.StringArrayInput // The ID of group to attach admin roles to. GroupId pulumi.StringPtrInput }
func (RolesState) ElementType ¶
func (RolesState) 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"` }
Creates an Okta Group Rule.
This resource allows you to create and configure an Okta Group Rule.
## Example Usage
```go 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.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 }) }
```
## Import
An Okta Group Rule can be imported via the Okta ID.
```sh
$ pulumi import okta:group/rule:Rule example <group rule id>
```
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) 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 ¶
type RuleArray ¶
type RuleArray []RuleInput
func (RuleArray) ElementType ¶
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 ¶
func (RuleMap) ElementType ¶
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 ¶ added in v3.9.0
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 ¶ added in v3.9.0
func (o RuleOutput) ExpressionValue() pulumi.StringOutput
The expression value.
func (RuleOutput) GroupAssignments ¶ added in v3.9.0
func (o RuleOutput) GroupAssignments() pulumi.StringArrayOutput
The list of group ids to assign the users to.
func (RuleOutput) Name ¶ added in v3.9.0
func (o RuleOutput) Name() pulumi.StringOutput
The name of the Group Rule (min character 1; max characters 50).
func (RuleOutput) RemoveAssignedUsers ¶ added in v3.9.0
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 ¶ added in v3.9.0
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 ¶ added in v3.9.0
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 }