Documentation
¶
Overview ¶
nolint: lll
nolint: lll
nolint: lll
nolint: lll
nolint: lll
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type GetEveryoneGroupArgs ¶
type GetEveryoneGroupArgs struct {
IncludeUsers *bool `pulumi:"includeUsers"`
}
A collection of arguments for invoking getEveryoneGroup.
type GetEveryoneGroupResult ¶
type GetEveryoneGroupResult struct {
// id is 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 ¶ added in v1.4.0
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.
> This content is derived from https://github.com/articulate/terraform-provider-okta/blob/master/website/docs/d/everyone_group.html.markdown.
type Group ¶
type Group struct {
pulumi.CustomResourceState
// The description of the Okta Group.
Description pulumi.StringPtrOutput `pulumi:"description"`
// The name of the Okta Group.
Name pulumi.StringOutput `pulumi:"name"`
// Users associated with the group. This can also be done per user.
Users pulumi.StringArrayOutput `pulumi:"users"`
}
Creates an Okta Group.
This resource allows you to create and configure an Okta Group.
> This content is derived from https://github.com/articulate/terraform-provider-okta/blob/master/website/docs/r/group.html.markdown.
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).
type GroupArgs ¶
type GroupArgs struct {
// The description of the Okta Group.
Description pulumi.StringPtrInput
// The name of the Okta Group.
Name pulumi.StringPtrInput
// Users associated with the group. This can also be done per user.
Users pulumi.StringArrayInput
}
The set of arguments for constructing a Group resource.
func (GroupArgs) ElementType ¶ added in v1.4.0
type GroupState ¶
type GroupState struct {
// The description of the Okta Group.
Description pulumi.StringPtrInput
// The name of the Okta Group.
Name pulumi.StringPtrInput
// Users associated with the group. This can also be done per user.
Users pulumi.StringArrayInput
}
func (GroupState) ElementType ¶ added in v1.4.0
func (GroupState) ElementType() reflect.Type
type LookupGroupArgs ¶ added in v1.4.0
type LookupGroupArgs struct {
// whether or not to retrieve all member ids.
IncludeUsers *bool `pulumi:"includeUsers"`
// name of group to retrieve.
Name string `pulumi:"name"`
}
A collection of arguments for invoking getGroup.
type LookupGroupResult ¶ added in v1.4.0
type LookupGroupResult struct {
// description of group.
Description string `pulumi:"description"`
// id is the provider-assigned unique ID for this managed resource.
Id string `pulumi:"id"`
IncludeUsers *bool `pulumi:"includeUsers"`
// name of group.
Name string `pulumi:"name"`
// 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.
> This content is derived from https://github.com/articulate/terraform-provider-okta/blob/master/website/docs/d/group.html.markdown.
type Roles ¶
type Roles struct {
pulumi.CustomResourceState
// 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"`.
AdminRoles pulumi.StringArrayOutput `pulumi:"adminRoles"`
// The ID of group to attach admin roles to.
GroupId pulumi.StringOutput `pulumi:"groupId"`
}
Creates Group level Admin Role Assignments.
This resource allows you to create and configure Group level Admin Role Assignments.
> This content is derived from https://github.com/articulate/terraform-provider-okta/blob/master/website/docs/r/group_roles.html.markdown.
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).
type RolesArgs ¶
type RolesArgs struct {
// 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"`.
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 ¶ added in v1.4.0
type RolesState ¶
type RolesState struct {
// 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"`.
AdminRoles pulumi.StringArrayInput
// The ID of group to attach admin roles to.
GroupId pulumi.StringPtrInput
}
func (RolesState) ElementType ¶ added in v1.4.0
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.
Name pulumi.StringOutput `pulumi:"name"`
// The status of the group rule.
Status pulumi.StringPtrOutput `pulumi:"status"`
}
Creates an Okta Group Rule.
This resource allows you to create and configure an Okta Group Rule.
> This content is derived from https://github.com/articulate/terraform-provider-okta/blob/master/website/docs/r/group_rule.html.markdown.
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).
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.
Name pulumi.StringPtrInput
// The status of the group rule.
Status pulumi.StringPtrInput
}
The set of arguments for constructing a Rule resource.
func (RuleArgs) ElementType ¶ added in v1.4.0
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.
Name pulumi.StringPtrInput
// The status of the group rule.
Status pulumi.StringPtrInput
}
Source Files