user

package
v3.23.0 Latest Latest
Warning

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

 Go to latest Published: Apr 20, 2023 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 BaseSchema 

type BaseSchema struct {
	pulumi.CustomResourceState

	// The property name.
	Index pulumi.StringOutput `pulumi:"index"`
	// Master priority for the user schema property. It can be set to `"PROFILE_MASTER"` or `"OKTA"`.
	Master pulumi.StringPtrOutput `pulumi:"master"`
	// The validation pattern to use for the subschema, only available for `login` property. Must be in form of `.+`, or `[<pattern>]+`.
	Pattern pulumi.StringPtrOutput `pulumi:"pattern"`
	// Access control permissions for the property. It can be set to `"READ_WRITE"`, `"READ_ONLY"`, `"HIDE"`.
	Permissions pulumi.StringPtrOutput `pulumi:"permissions"`
	// Whether the property is required for this application's users.
	Required pulumi.BoolPtrOutput `pulumi:"required"`
	// The property display name.
	Title pulumi.StringOutput `pulumi:"title"`
	// The type of the schema property. It can be `"string"`, `"boolean"`, `"number"`, `"integer"`, `"array"`, or `"object"`.
	Type pulumi.StringOutput `pulumi:"type"`
	// User type ID
	UserType pulumi.StringPtrOutput `pulumi:"userType"`
}

> **DEPRECATED** use `UserBaseSchemaProperty` instead.

This resource allows you to configure a base user schema property.

## Example Usage

```go package main

import ( 

"github.com/pulumi/pulumi-okta/sdk/v3/go/okta/user"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"

) 

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := user.NewBaseSchema(ctx, "example", &user.BaseSchemaArgs{
			Index:    pulumi.String("customPropertyName"),
			Master:   pulumi.String("OKTA"),
			Title:    pulumi.String("customPropertyName"),
			Type:     pulumi.String("string"),
			UserType: pulumi.Any(data.Okta_user_type.Example.Id),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

```

## Import

User schema property of default user type can be imported via the property index.

```sh 

$ pulumi import okta:user/baseSchema:BaseSchema example &#60;property name&#62;

``` 

User schema property of custom user type can be imported via user type id and property index

```sh 

$ pulumi import okta:user/baseSchema:BaseSchema example &#60;user type id&#62;.&#60;property name&#62;

```

func GetBaseSchema 

func GetBaseSchema(ctx *pulumi.Context,
	name string, id pulumi.IDInput, state *BaseSchemaState, opts ...pulumi.ResourceOption) (*BaseSchema, error)

GetBaseSchema gets an existing BaseSchema 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 NewBaseSchema 

func NewBaseSchema(ctx *pulumi.Context,
	name string, args *BaseSchemaArgs, opts ...pulumi.ResourceOption) (*BaseSchema, error)

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

func (*BaseSchema) ElementType 

func (*BaseSchema) ElementType() reflect.Type

func (*BaseSchema) ToBaseSchemaOutput 

func (i *BaseSchema) ToBaseSchemaOutput() BaseSchemaOutput

func (*BaseSchema) ToBaseSchemaOutputWithContext 

func (i *BaseSchema) ToBaseSchemaOutputWithContext(ctx context.Context) BaseSchemaOutput

type BaseSchemaArgs 

type BaseSchemaArgs struct {
	// The property name.
	Index pulumi.StringInput
	// Master priority for the user schema property. It can be set to `"PROFILE_MASTER"` or `"OKTA"`.
	Master pulumi.StringPtrInput
	// The validation pattern to use for the subschema, only available for `login` property. Must be in form of `.+`, or `[<pattern>]+`.
	Pattern pulumi.StringPtrInput
	// Access control permissions for the property. It can be set to `"READ_WRITE"`, `"READ_ONLY"`, `"HIDE"`.
	Permissions pulumi.StringPtrInput
	// Whether the property is required for this application's users.
	Required pulumi.BoolPtrInput
	// The property display name.
	Title pulumi.StringInput
	// The type of the schema property. It can be `"string"`, `"boolean"`, `"number"`, `"integer"`, `"array"`, or `"object"`.
	Type pulumi.StringInput
	// User type ID
	UserType pulumi.StringPtrInput
}

The set of arguments for constructing a BaseSchema resource.

func (BaseSchemaArgs) ElementType 

func (BaseSchemaArgs) ElementType() reflect.Type

type BaseSchemaArray 

type BaseSchemaArray []BaseSchemaInput

func (BaseSchemaArray) ElementType 

func (BaseSchemaArray) ElementType() reflect.Type

func (BaseSchemaArray) ToBaseSchemaArrayOutput 

func (i BaseSchemaArray) ToBaseSchemaArrayOutput() BaseSchemaArrayOutput

func (BaseSchemaArray) ToBaseSchemaArrayOutputWithContext 

func (i BaseSchemaArray) ToBaseSchemaArrayOutputWithContext(ctx context.Context) BaseSchemaArrayOutput

type BaseSchemaArrayInput 

type BaseSchemaArrayInput interface {
	pulumi.Input

	ToBaseSchemaArrayOutput() BaseSchemaArrayOutput
	ToBaseSchemaArrayOutputWithContext(context.Context) BaseSchemaArrayOutput
}

BaseSchemaArrayInput is an input type that accepts BaseSchemaArray and BaseSchemaArrayOutput values. You can construct a concrete instance of `BaseSchemaArrayInput` via: 

BaseSchemaArray{ BaseSchemaArgs{...} }

type BaseSchemaArrayOutput 

type BaseSchemaArrayOutput struct{ *pulumi.OutputState }

func (BaseSchemaArrayOutput) ElementType 

func (BaseSchemaArrayOutput) ElementType() reflect.Type

func (BaseSchemaArrayOutput) Index 

func (o BaseSchemaArrayOutput) Index(i pulumi.IntInput) BaseSchemaOutput

func (BaseSchemaArrayOutput) ToBaseSchemaArrayOutput 

func (o BaseSchemaArrayOutput) ToBaseSchemaArrayOutput() BaseSchemaArrayOutput

func (BaseSchemaArrayOutput) ToBaseSchemaArrayOutputWithContext 

func (o BaseSchemaArrayOutput) ToBaseSchemaArrayOutputWithContext(ctx context.Context) BaseSchemaArrayOutput

type BaseSchemaInput 

type BaseSchemaInput interface {
	pulumi.Input

	ToBaseSchemaOutput() BaseSchemaOutput
	ToBaseSchemaOutputWithContext(ctx context.Context) BaseSchemaOutput
}

type BaseSchemaMap 

type BaseSchemaMap map[string]BaseSchemaInput

func (BaseSchemaMap) ElementType 

func (BaseSchemaMap) ElementType() reflect.Type

func (BaseSchemaMap) ToBaseSchemaMapOutput 

func (i BaseSchemaMap) ToBaseSchemaMapOutput() BaseSchemaMapOutput

func (BaseSchemaMap) ToBaseSchemaMapOutputWithContext 

func (i BaseSchemaMap) ToBaseSchemaMapOutputWithContext(ctx context.Context) BaseSchemaMapOutput

type BaseSchemaMapInput 

type BaseSchemaMapInput interface {
	pulumi.Input

	ToBaseSchemaMapOutput() BaseSchemaMapOutput
	ToBaseSchemaMapOutputWithContext(context.Context) BaseSchemaMapOutput
}

BaseSchemaMapInput is an input type that accepts BaseSchemaMap and BaseSchemaMapOutput values. You can construct a concrete instance of `BaseSchemaMapInput` via: 

BaseSchemaMap{ "key": BaseSchemaArgs{...} }

type BaseSchemaMapOutput 

type BaseSchemaMapOutput struct{ *pulumi.OutputState }

func (BaseSchemaMapOutput) ElementType 

func (BaseSchemaMapOutput) ElementType() reflect.Type

func (BaseSchemaMapOutput) MapIndex 

func (o BaseSchemaMapOutput) MapIndex(k pulumi.StringInput) BaseSchemaOutput

func (BaseSchemaMapOutput) ToBaseSchemaMapOutput 

func (o BaseSchemaMapOutput) ToBaseSchemaMapOutput() BaseSchemaMapOutput

func (BaseSchemaMapOutput) ToBaseSchemaMapOutputWithContext 

func (o BaseSchemaMapOutput) ToBaseSchemaMapOutputWithContext(ctx context.Context) BaseSchemaMapOutput

type BaseSchemaOutput 

type BaseSchemaOutput struct{ *pulumi.OutputState }

func (BaseSchemaOutput) ElementType 

func (BaseSchemaOutput) ElementType() reflect.Type

func (BaseSchemaOutput) Index added in v3.9.0 

func (o BaseSchemaOutput) Index() pulumi.StringOutput

The property name.

func (BaseSchemaOutput) Master added in v3.9.0 

func (o BaseSchemaOutput) Master() pulumi.StringPtrOutput

Master priority for the user schema property. It can be set to `"PROFILE_MASTER"` or `"OKTA"`.

func (BaseSchemaOutput) Pattern added in v3.9.0 

func (o BaseSchemaOutput) Pattern() pulumi.StringPtrOutput

The validation pattern to use for the subschema, only available for `login` property. Must be in form of `.+`, or `[<pattern>]+`.

func (BaseSchemaOutput) Permissions added in v3.9.0 

func (o BaseSchemaOutput) Permissions() pulumi.StringPtrOutput

Access control permissions for the property. It can be set to `"READ_WRITE"`, `"READ_ONLY"`, `"HIDE"`.

func (BaseSchemaOutput) Required added in v3.9.0 

func (o BaseSchemaOutput) Required() pulumi.BoolPtrOutput

Whether the property is required for this application's users.

func (BaseSchemaOutput) Title added in v3.9.0 

func (o BaseSchemaOutput) Title() pulumi.StringOutput

The property display name.

func (BaseSchemaOutput) ToBaseSchemaOutput 

func (o BaseSchemaOutput) ToBaseSchemaOutput() BaseSchemaOutput

func (BaseSchemaOutput) ToBaseSchemaOutputWithContext 

func (o BaseSchemaOutput) ToBaseSchemaOutputWithContext(ctx context.Context) BaseSchemaOutput

func (BaseSchemaOutput) Type added in v3.9.0 

func (o BaseSchemaOutput) Type() pulumi.StringOutput

The type of the schema property. It can be `"string"`, `"boolean"`, `"number"`, `"integer"`, `"array"`, or `"object"`.

func (BaseSchemaOutput) UserType added in v3.9.0 

func (o BaseSchemaOutput) UserType() pulumi.StringPtrOutput

User type ID

type BaseSchemaState 

type BaseSchemaState struct {
	// The property name.
	Index pulumi.StringPtrInput
	// Master priority for the user schema property. It can be set to `"PROFILE_MASTER"` or `"OKTA"`.
	Master pulumi.StringPtrInput
	// The validation pattern to use for the subschema, only available for `login` property. Must be in form of `.+`, or `[<pattern>]+`.
	Pattern pulumi.StringPtrInput
	// Access control permissions for the property. It can be set to `"READ_WRITE"`, `"READ_ONLY"`, `"HIDE"`.
	Permissions pulumi.StringPtrInput
	// Whether the property is required for this application's users.
	Required pulumi.BoolPtrInput
	// The property display name.
	Title pulumi.StringPtrInput
	// The type of the schema property. It can be `"string"`, `"boolean"`, `"number"`, `"integer"`, `"array"`, or `"object"`.
	Type pulumi.StringPtrInput
	// User type ID
	UserType pulumi.StringPtrInput
}

func (BaseSchemaState) ElementType 

func (BaseSchemaState) ElementType() reflect.Type

type GetUserProfileMappingSourceResult 

type GetUserProfileMappingSourceResult struct {
	// id of the source.
	Id string `pulumi:"id"`
	// name of source.
	Name string `pulumi:"name"`
	// type of source.
	Type string `pulumi:"type"`
}

A collection of values returned by getUserProfileMappingSource.

func GetUserProfileMappingSource 

func GetUserProfileMappingSource(ctx *pulumi.Context, opts ...pulumi.InvokeOption) (*GetUserProfileMappingSourceResult, error)

Use this data source to retrieve the base user Profile Mapping source or target from Okta.

> **NOTE:** If using this resource with OAuth2 scopes, this resource requires `okta.profileMappings.read` scope.

## Example Usage

```go package main

import ( 

"github.com/pulumi/pulumi-okta/sdk/v3/go/okta/user"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"

) 

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := user.GetUserProfileMappingSource(ctx, nil, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

```

type GetUserSearch 

type GetUserSearch struct {
	// Comparison to use. Comparitors for strings: [`eq`, `ge`, `gt`, `le`, `lt`, `ne`, `pr`, `sw`](https://developer.okta.com/docs/reference/core-okta-api/#operators).
	Comparison *string `pulumi:"comparison"`
	// A raw search expression string. If present it will override name/comparison/value.
	Expression *string `pulumi:"expression"`
	// Name of property to search against.
	Name *string `pulumi:"name"`
	// Value to compare with.
	Value *string `pulumi:"value"`
}

type GetUserSearchArgs 

type GetUserSearchArgs struct {
	// Comparison to use. Comparitors for strings: [`eq`, `ge`, `gt`, `le`, `lt`, `ne`, `pr`, `sw`](https://developer.okta.com/docs/reference/core-okta-api/#operators).
	Comparison pulumi.StringPtrInput `pulumi:"comparison"`
	// A raw search expression string. If present it will override name/comparison/value.
	Expression pulumi.StringPtrInput `pulumi:"expression"`
	// Name of property to search against.
	Name pulumi.StringPtrInput `pulumi:"name"`
	// Value to compare with.
	Value pulumi.StringPtrInput `pulumi:"value"`
}

func (GetUserSearchArgs) ElementType 

func (GetUserSearchArgs) ElementType() reflect.Type

func (GetUserSearchArgs) ToGetUserSearchOutput 

func (i GetUserSearchArgs) ToGetUserSearchOutput() GetUserSearchOutput

func (GetUserSearchArgs) ToGetUserSearchOutputWithContext 

func (i GetUserSearchArgs) ToGetUserSearchOutputWithContext(ctx context.Context) GetUserSearchOutput

type GetUserSearchArray 

type GetUserSearchArray []GetUserSearchInput

func (GetUserSearchArray) ElementType 

func (GetUserSearchArray) ElementType() reflect.Type

func (GetUserSearchArray) ToGetUserSearchArrayOutput 

func (i GetUserSearchArray) ToGetUserSearchArrayOutput() GetUserSearchArrayOutput

func (GetUserSearchArray) ToGetUserSearchArrayOutputWithContext 

func (i GetUserSearchArray) ToGetUserSearchArrayOutputWithContext(ctx context.Context) GetUserSearchArrayOutput

type GetUserSearchArrayInput 

type GetUserSearchArrayInput interface {
	pulumi.Input

	ToGetUserSearchArrayOutput() GetUserSearchArrayOutput
	ToGetUserSearchArrayOutputWithContext(context.Context) GetUserSearchArrayOutput
}

GetUserSearchArrayInput is an input type that accepts GetUserSearchArray and GetUserSearchArrayOutput values. You can construct a concrete instance of `GetUserSearchArrayInput` via: 

GetUserSearchArray{ GetUserSearchArgs{...} }

type GetUserSearchArrayOutput 

type GetUserSearchArrayOutput struct{ *pulumi.OutputState }

func (GetUserSearchArrayOutput) ElementType 

func (GetUserSearchArrayOutput) ElementType() reflect.Type

func (GetUserSearchArrayOutput) Index 

func (o GetUserSearchArrayOutput) Index(i pulumi.IntInput) GetUserSearchOutput

func (GetUserSearchArrayOutput) ToGetUserSearchArrayOutput 

func (o GetUserSearchArrayOutput) ToGetUserSearchArrayOutput() GetUserSearchArrayOutput

func (GetUserSearchArrayOutput) ToGetUserSearchArrayOutputWithContext 

func (o GetUserSearchArrayOutput) ToGetUserSearchArrayOutputWithContext(ctx context.Context) GetUserSearchArrayOutput

type GetUserSearchInput 

type GetUserSearchInput interface {
	pulumi.Input

	ToGetUserSearchOutput() GetUserSearchOutput
	ToGetUserSearchOutputWithContext(context.Context) GetUserSearchOutput
}

GetUserSearchInput is an input type that accepts GetUserSearchArgs and GetUserSearchOutput values. You can construct a concrete instance of `GetUserSearchInput` via: 

GetUserSearchArgs{...}

type GetUserSearchOutput 

type GetUserSearchOutput struct{ *pulumi.OutputState }

func (GetUserSearchOutput) Comparison 

func (o GetUserSearchOutput) Comparison() pulumi.StringPtrOutput

Comparison to use. Comparitors for strings: [`eq`, `ge`, `gt`, `le`, `lt`, `ne`, `pr`, `sw`](https://developer.okta.com/docs/reference/core-okta-api/#operators).

func (GetUserSearchOutput) ElementType 

func (GetUserSearchOutput) ElementType() reflect.Type

func (GetUserSearchOutput) Expression added in v3.9.0 

func (o GetUserSearchOutput) Expression() pulumi.StringPtrOutput

A raw search expression string. If present it will override name/comparison/value.

func (GetUserSearchOutput) Name 

func (o GetUserSearchOutput) Name() pulumi.StringPtrOutput

Name of property to search against.

func (GetUserSearchOutput) ToGetUserSearchOutput 

func (o GetUserSearchOutput) ToGetUserSearchOutput() GetUserSearchOutput

func (GetUserSearchOutput) ToGetUserSearchOutputWithContext 

func (o GetUserSearchOutput) ToGetUserSearchOutputWithContext(ctx context.Context) GetUserSearchOutput

func (GetUserSearchOutput) Value 

func (o GetUserSearchOutput) Value() pulumi.StringPtrOutput

Value to compare with.

type GetUsersArgs 

type GetUsersArgs struct {
	// Given multiple search elements they will be compounded together with the op. Default is `and`, `or` is also valid.
	CompoundSearchOperator *string `pulumi:"compoundSearchOperator"`
	// Force delay of the users read by N seconds. Useful when eventual consistency of users information needs to be allowed for; for instance, when administrator roles are known to have been applied.
	DelayReadSeconds *string `pulumi:"delayReadSeconds"`
	// Id of group used to find users based on membership.
	GroupId *string `pulumi:"groupId"`
	// Fetch each user's group memberships. Defaults to `false`, in which case the `groupMemberships` user attribute will be empty.
	IncludeGroups *bool `pulumi:"includeGroups"`
	// Fetch each user's administrator roles. Defaults to `false`, in which case the `adminRoles` user attribute will be empty.
	IncludeRoles *bool `pulumi:"includeRoles"`
	// Map of search criteria. It supports the following properties.
	Searches []GetUsersSearch `pulumi:"searches"`
}

A collection of arguments for invoking getUsers.

type GetUsersOutputArgs added in v3.2.0 

type GetUsersOutputArgs struct {
	// Given multiple search elements they will be compounded together with the op. Default is `and`, `or` is also valid.
	CompoundSearchOperator pulumi.StringPtrInput `pulumi:"compoundSearchOperator"`
	// Force delay of the users read by N seconds. Useful when eventual consistency of users information needs to be allowed for; for instance, when administrator roles are known to have been applied.
	DelayReadSeconds pulumi.StringPtrInput `pulumi:"delayReadSeconds"`
	// Id of group used to find users based on membership.
	GroupId pulumi.StringPtrInput `pulumi:"groupId"`
	// Fetch each user's group memberships. Defaults to `false`, in which case the `groupMemberships` user attribute will be empty.
	IncludeGroups pulumi.BoolPtrInput `pulumi:"includeGroups"`
	// Fetch each user's administrator roles. Defaults to `false`, in which case the `adminRoles` user attribute will be empty.
	IncludeRoles pulumi.BoolPtrInput `pulumi:"includeRoles"`
	// Map of search criteria. It supports the following properties.
	Searches GetUsersSearchArrayInput `pulumi:"searches"`
}

A collection of arguments for invoking getUsers.

func (GetUsersOutputArgs) ElementType added in v3.2.0 

func (GetUsersOutputArgs) ElementType() reflect.Type

type GetUsersResult 

type GetUsersResult struct {
	CompoundSearchOperator *string `pulumi:"compoundSearchOperator"`
	DelayReadSeconds       *string `pulumi:"delayReadSeconds"`
	GroupId                *string `pulumi:"groupId"`
	// The provider-assigned unique ID for this managed resource.
	Id            string           `pulumi:"id"`
	IncludeGroups *bool            `pulumi:"includeGroups"`
	IncludeRoles  *bool            `pulumi:"includeRoles"`
	Searches      []GetUsersSearch `pulumi:"searches"`
	// collection of users retrieved from Okta with the following properties.
	Users []GetUsersUser `pulumi:"users"`
}

A collection of values returned by getUsers.

func GetUsers 

func GetUsers(ctx *pulumi.Context, args *GetUsersArgs, opts ...pulumi.InvokeOption) (*GetUsersResult, error)

Use this data source to retrieve a list of users from Okta.

## Example Usage ### Lookup Users by Search Criteria

```go package main

import ( 

"github.com/pulumi/pulumi-okta/sdk/v3/go/okta/user"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"

) 

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := user.GetUsers(ctx, &user.GetUsersArgs{
			Searches: []user.GetUsersSearch{
				{
					Expression: pulumi.StringRef("profile.department eq \"Engineering\" and (created lt \"2014-01-01T00:00:00.000Z\" or status eq \"ACTIVE\")"),
				},
			},
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

``` ### Lookup Users by Group Membership ```go package main

import ( 

"github.com/pulumi/pulumi-okta/sdk/v3/go/okta/group"
"github.com/pulumi/pulumi-okta/sdk/v3/go/okta/user"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"

) 

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		exampleGroup, err := group.NewGroup(ctx, "exampleGroup", nil)
		if err != nil {
			return err
		}
		_ = user.GetUsersOutput(ctx, user.GetUsersOutputArgs{
			GroupId:       exampleGroup.ID(),
			IncludeGroups: pulumi.Bool(true),
			IncludeRoles:  pulumi.Bool(true),
		}, nil)
		return nil
	})
}

```

type GetUsersResultOutput added in v3.2.0 

type GetUsersResultOutput struct{ *pulumi.OutputState }

A collection of values returned by getUsers.

func GetUsersOutput added in v3.2.0 

func GetUsersOutput(ctx *pulumi.Context, args GetUsersOutputArgs, opts ...pulumi.InvokeOption) GetUsersResultOutput

func (GetUsersResultOutput) CompoundSearchOperator added in v3.9.0 

func (o GetUsersResultOutput) CompoundSearchOperator() pulumi.StringPtrOutput

func (GetUsersResultOutput) DelayReadSeconds added in v3.14.0 

func (o GetUsersResultOutput) DelayReadSeconds() pulumi.StringPtrOutput

func (GetUsersResultOutput) ElementType added in v3.2.0 

func (GetUsersResultOutput) ElementType() reflect.Type

func (GetUsersResultOutput) GroupId added in v3.9.0 

func (o GetUsersResultOutput) GroupId() pulumi.StringPtrOutput

func (GetUsersResultOutput) Id added in v3.2.0 

func (o GetUsersResultOutput) Id() pulumi.StringOutput

The provider-assigned unique ID for this managed resource.

func (GetUsersResultOutput) IncludeGroups added in v3.9.0 

func (o GetUsersResultOutput) IncludeGroups() pulumi.BoolPtrOutput

func (GetUsersResultOutput) IncludeRoles added in v3.14.0 

func (o GetUsersResultOutput) IncludeRoles() pulumi.BoolPtrOutput

func (GetUsersResultOutput) Searches added in v3.2.0 

func (o GetUsersResultOutput) Searches() GetUsersSearchArrayOutput

func (GetUsersResultOutput) ToGetUsersResultOutput added in v3.2.0 

func (o GetUsersResultOutput) ToGetUsersResultOutput() GetUsersResultOutput

func (GetUsersResultOutput) ToGetUsersResultOutputWithContext added in v3.2.0 

func (o GetUsersResultOutput) ToGetUsersResultOutputWithContext(ctx context.Context) GetUsersResultOutput

func (GetUsersResultOutput) Users added in v3.2.0 

func (o GetUsersResultOutput) Users() GetUsersUserArrayOutput

collection of users retrieved from Okta with the following properties.

type GetUsersSearch 

type GetUsersSearch struct {
	// Comparison to use. Comparitors for strings: [`eq`, `ge`, `gt`, `le`, `lt`, `ne`, `pr`, `sw`](https://developer.okta.com/docs/reference/core-okta-api/#operators).
	Comparison *string `pulumi:"comparison"`
	// A raw search expression string. If present it will override name/comparison/value.
	Expression *string `pulumi:"expression"`
	// Name of property to search against.
	Name *string `pulumi:"name"`
	// Value to compare with.
	Value *string `pulumi:"value"`
}

type GetUsersSearchArgs 

type GetUsersSearchArgs struct {
	// Comparison to use. Comparitors for strings: [`eq`, `ge`, `gt`, `le`, `lt`, `ne`, `pr`, `sw`](https://developer.okta.com/docs/reference/core-okta-api/#operators).
	Comparison pulumi.StringPtrInput `pulumi:"comparison"`
	// A raw search expression string. If present it will override name/comparison/value.
	Expression pulumi.StringPtrInput `pulumi:"expression"`
	// Name of property to search against.
	Name pulumi.StringPtrInput `pulumi:"name"`
	// Value to compare with.
	Value pulumi.StringPtrInput `pulumi:"value"`
}

func (GetUsersSearchArgs) ElementType 

func (GetUsersSearchArgs) ElementType() reflect.Type

func (GetUsersSearchArgs) ToGetUsersSearchOutput 

func (i GetUsersSearchArgs) ToGetUsersSearchOutput() GetUsersSearchOutput

func (GetUsersSearchArgs) ToGetUsersSearchOutputWithContext 

func (i GetUsersSearchArgs) ToGetUsersSearchOutputWithContext(ctx context.Context) GetUsersSearchOutput

type GetUsersSearchArray 

type GetUsersSearchArray []GetUsersSearchInput

func (GetUsersSearchArray) ElementType 

func (GetUsersSearchArray) ElementType() reflect.Type

func (GetUsersSearchArray) ToGetUsersSearchArrayOutput 

func (i GetUsersSearchArray) ToGetUsersSearchArrayOutput() GetUsersSearchArrayOutput

func (GetUsersSearchArray) ToGetUsersSearchArrayOutputWithContext 

func (i GetUsersSearchArray) ToGetUsersSearchArrayOutputWithContext(ctx context.Context) GetUsersSearchArrayOutput

type GetUsersSearchArrayInput 

type GetUsersSearchArrayInput interface {
	pulumi.Input

	ToGetUsersSearchArrayOutput() GetUsersSearchArrayOutput
	ToGetUsersSearchArrayOutputWithContext(context.Context) GetUsersSearchArrayOutput
}

GetUsersSearchArrayInput is an input type that accepts GetUsersSearchArray and GetUsersSearchArrayOutput values. You can construct a concrete instance of `GetUsersSearchArrayInput` via: 

GetUsersSearchArray{ GetUsersSearchArgs{...} }

type GetUsersSearchArrayOutput 

type GetUsersSearchArrayOutput struct{ *pulumi.OutputState }

func (GetUsersSearchArrayOutput) ElementType 

func (GetUsersSearchArrayOutput) ElementType() reflect.Type

func (GetUsersSearchArrayOutput) Index 

func (o GetUsersSearchArrayOutput) Index(i pulumi.IntInput) GetUsersSearchOutput

func (GetUsersSearchArrayOutput) ToGetUsersSearchArrayOutput 

func (o GetUsersSearchArrayOutput) ToGetUsersSearchArrayOutput() GetUsersSearchArrayOutput

func (GetUsersSearchArrayOutput) ToGetUsersSearchArrayOutputWithContext 

func (o GetUsersSearchArrayOutput) ToGetUsersSearchArrayOutputWithContext(ctx context.Context) GetUsersSearchArrayOutput

type GetUsersSearchInput 

type GetUsersSearchInput interface {
	pulumi.Input

	ToGetUsersSearchOutput() GetUsersSearchOutput
	ToGetUsersSearchOutputWithContext(context.Context) GetUsersSearchOutput
}

GetUsersSearchInput is an input type that accepts GetUsersSearchArgs and GetUsersSearchOutput values. You can construct a concrete instance of `GetUsersSearchInput` via: 

GetUsersSearchArgs{...}

type GetUsersSearchOutput 

type GetUsersSearchOutput struct{ *pulumi.OutputState }

func (GetUsersSearchOutput) Comparison 

func (o GetUsersSearchOutput) Comparison() pulumi.StringPtrOutput

Comparison to use. Comparitors for strings: [`eq`, `ge`, `gt`, `le`, `lt`, `ne`, `pr`, `sw`](https://developer.okta.com/docs/reference/core-okta-api/#operators).

func (GetUsersSearchOutput) ElementType 

func (GetUsersSearchOutput) ElementType() reflect.Type

func (GetUsersSearchOutput) Expression added in v3.9.0 

func (o GetUsersSearchOutput) Expression() pulumi.StringPtrOutput

A raw search expression string. If present it will override name/comparison/value.

func (GetUsersSearchOutput) Name 

func (o GetUsersSearchOutput) Name() pulumi.StringPtrOutput

Name of property to search against.

func (GetUsersSearchOutput) ToGetUsersSearchOutput 

func (o GetUsersSearchOutput) ToGetUsersSearchOutput() GetUsersSearchOutput

func (GetUsersSearchOutput) ToGetUsersSearchOutputWithContext 

func (o GetUsersSearchOutput) ToGetUsersSearchOutputWithContext(ctx context.Context) GetUsersSearchOutput

func (GetUsersSearchOutput) Value 

func (o GetUsersSearchOutput) Value() pulumi.StringPtrOutput

Value to compare with.

type GetUsersUser 

type GetUsersUser struct {
	// Administrator roles assigned to user.
	AdminRoles []string `pulumi:"adminRoles"`
	// City or locality component of user's address.
	City string `pulumi:"city"`
	// Name of a cost center assigned to user.
	CostCenter string `pulumi:"costCenter"`
	// Country name component of user's address.
	CountryCode string `pulumi:"countryCode"`
	// Raw JSON containing all custom profile attributes.
	CustomProfileAttributes string `pulumi:"customProfileAttributes"`
	// Name of user's department.
	Department string `pulumi:"department"`
	// Name of the user, suitable for display to end users.
	DisplayName string `pulumi:"displayName"`
	// Name of user's division.
	Division string `pulumi:"division"`
	// Primary email address of user.
	Email string `pulumi:"email"`
	// Organization or company assigned unique identifier for the user.
	EmployeeNumber string `pulumi:"employeeNumber"`
	// Given name of the user.
	FirstName string `pulumi:"firstName"`
	// Groups user belongs to.
	GroupMemberships []string `pulumi:"groupMemberships"`
	// Honorific prefix(es) of the user, or title in most Western languages.
	HonorificPrefix string `pulumi:"honorificPrefix"`
	// Honorific suffix(es) of the user.
	HonorificSuffix string `pulumi:"honorificSuffix"`
	Id              string `pulumi:"id"`
	// Family name of the user.
	LastName string `pulumi:"lastName"`
	// User's default location for purposes of localizing items such as currency, date time format, numerical representations, etc.
	Locale string `pulumi:"locale"`
	// Unique identifier for the user.
	Login string `pulumi:"login"`
	// Display name of the user's manager.
	Manager string `pulumi:"manager"`
	// `id` of a user's manager.
	ManagerId string `pulumi:"managerId"`
	// Middle name(s) of the user.
	MiddleName string `pulumi:"middleName"`
	// Mobile phone number of user.
	MobilePhone string `pulumi:"mobilePhone"`
	// Casual way to address the user in real life.
	NickName string `pulumi:"nickName"`
	// Name of user's organization.
	Organization string `pulumi:"organization"`
	// Mailing address component of user's address.
	PostalAddress string `pulumi:"postalAddress"`
	// User's preferred written or spoken languages.
	PreferredLanguage string `pulumi:"preferredLanguage"`
	// Primary phone number of user such as home number.
	PrimaryPhone string `pulumi:"primaryPhone"`
	// URL of user's online profile (e.g. a web page).
	ProfileUrl string   `pulumi:"profileUrl"`
	Roles      []string `pulumi:"roles"`
	// Secondary email address of user typically used for account recovery.
	SecondEmail string `pulumi:"secondEmail"`
	// State or region component of user's address (region).
	State string `pulumi:"state"`
	// Current status of user.
	Status string `pulumi:"status"`
	// Full street address component of user's address.
	StreetAddress string `pulumi:"streetAddress"`
	// User's time zone.
	Timezone string `pulumi:"timezone"`
	// User's title, such as "Vice President".
	Title string `pulumi:"title"`
	// Used to describe the organization to user relationship such as "Employee" or "Contractor".
	UserType string `pulumi:"userType"`
	// Zipcode or postal code component of user's address (postalCode)
	ZipCode string `pulumi:"zipCode"`
}

type GetUsersUserArgs 

type GetUsersUserArgs struct {
	// Administrator roles assigned to user.
	AdminRoles pulumi.StringArrayInput `pulumi:"adminRoles"`
	// City or locality component of user's address.
	City pulumi.StringInput `pulumi:"city"`
	// Name of a cost center assigned to user.
	CostCenter pulumi.StringInput `pulumi:"costCenter"`
	// Country name component of user's address.
	CountryCode pulumi.StringInput `pulumi:"countryCode"`
	// Raw JSON containing all custom profile attributes.
	CustomProfileAttributes pulumi.StringInput `pulumi:"customProfileAttributes"`
	// Name of user's department.
	Department pulumi.StringInput `pulumi:"department"`
	// Name of the user, suitable for display to end users.
	DisplayName pulumi.StringInput `pulumi:"displayName"`
	// Name of user's division.
	Division pulumi.StringInput `pulumi:"division"`
	// Primary email address of user.
	Email pulumi.StringInput `pulumi:"email"`
	// Organization or company assigned unique identifier for the user.
	EmployeeNumber pulumi.StringInput `pulumi:"employeeNumber"`
	// Given name of the user.
	FirstName pulumi.StringInput `pulumi:"firstName"`
	// Groups user belongs to.
	GroupMemberships pulumi.StringArrayInput `pulumi:"groupMemberships"`
	// Honorific prefix(es) of the user, or title in most Western languages.
	HonorificPrefix pulumi.StringInput `pulumi:"honorificPrefix"`
	// Honorific suffix(es) of the user.
	HonorificSuffix pulumi.StringInput `pulumi:"honorificSuffix"`
	Id              pulumi.StringInput `pulumi:"id"`
	// Family name of the user.
	LastName pulumi.StringInput `pulumi:"lastName"`
	// User's default location for purposes of localizing items such as currency, date time format, numerical representations, etc.
	Locale pulumi.StringInput `pulumi:"locale"`
	// Unique identifier for the user.
	Login pulumi.StringInput `pulumi:"login"`
	// Display name of the user's manager.
	Manager pulumi.StringInput `pulumi:"manager"`
	// `id` of a user's manager.
	ManagerId pulumi.StringInput `pulumi:"managerId"`
	// Middle name(s) of the user.
	MiddleName pulumi.StringInput `pulumi:"middleName"`
	// Mobile phone number of user.
	MobilePhone pulumi.StringInput `pulumi:"mobilePhone"`
	// Casual way to address the user in real life.
	NickName pulumi.StringInput `pulumi:"nickName"`
	// Name of user's organization.
	Organization pulumi.StringInput `pulumi:"organization"`
	// Mailing address component of user's address.
	PostalAddress pulumi.StringInput `pulumi:"postalAddress"`
	// User's preferred written or spoken languages.
	PreferredLanguage pulumi.StringInput `pulumi:"preferredLanguage"`
	// Primary phone number of user such as home number.
	PrimaryPhone pulumi.StringInput `pulumi:"primaryPhone"`
	// URL of user's online profile (e.g. a web page).
	ProfileUrl pulumi.StringInput      `pulumi:"profileUrl"`
	Roles      pulumi.StringArrayInput `pulumi:"roles"`
	// Secondary email address of user typically used for account recovery.
	SecondEmail pulumi.StringInput `pulumi:"secondEmail"`
	// State or region component of user's address (region).
	State pulumi.StringInput `pulumi:"state"`
	// Current status of user.
	Status pulumi.StringInput `pulumi:"status"`
	// Full street address component of user's address.
	StreetAddress pulumi.StringInput `pulumi:"streetAddress"`
	// User's time zone.
	Timezone pulumi.StringInput `pulumi:"timezone"`
	// User's title, such as "Vice President".
	Title pulumi.StringInput `pulumi:"title"`
	// Used to describe the organization to user relationship such as "Employee" or "Contractor".
	UserType pulumi.StringInput `pulumi:"userType"`
	// Zipcode or postal code component of user's address (postalCode)
	ZipCode pulumi.StringInput `pulumi:"zipCode"`
}

func (GetUsersUserArgs) ElementType 

func (GetUsersUserArgs) ElementType() reflect.Type

func (GetUsersUserArgs) ToGetUsersUserOutput 

func (i GetUsersUserArgs) ToGetUsersUserOutput() GetUsersUserOutput

func (GetUsersUserArgs) ToGetUsersUserOutputWithContext 

func (i GetUsersUserArgs) ToGetUsersUserOutputWithContext(ctx context.Context) GetUsersUserOutput

type GetUsersUserArray 

type GetUsersUserArray []GetUsersUserInput

func (GetUsersUserArray) ElementType 

func (GetUsersUserArray) ElementType() reflect.Type

func (GetUsersUserArray) ToGetUsersUserArrayOutput 

func (i GetUsersUserArray) ToGetUsersUserArrayOutput() GetUsersUserArrayOutput

func (GetUsersUserArray) ToGetUsersUserArrayOutputWithContext 

func (i GetUsersUserArray) ToGetUsersUserArrayOutputWithContext(ctx context.Context) GetUsersUserArrayOutput

type GetUsersUserArrayInput 

type GetUsersUserArrayInput interface {
	pulumi.Input

	ToGetUsersUserArrayOutput() GetUsersUserArrayOutput
	ToGetUsersUserArrayOutputWithContext(context.Context) GetUsersUserArrayOutput
}

GetUsersUserArrayInput is an input type that accepts GetUsersUserArray and GetUsersUserArrayOutput values. You can construct a concrete instance of `GetUsersUserArrayInput` via: 

GetUsersUserArray{ GetUsersUserArgs{...} }

type GetUsersUserArrayOutput 

type GetUsersUserArrayOutput struct{ *pulumi.OutputState }

func (GetUsersUserArrayOutput) ElementType 

func (GetUsersUserArrayOutput) ElementType() reflect.Type

func (GetUsersUserArrayOutput) Index 

func (o GetUsersUserArrayOutput) Index(i pulumi.IntInput) GetUsersUserOutput

func (GetUsersUserArrayOutput) ToGetUsersUserArrayOutput 

func (o GetUsersUserArrayOutput) ToGetUsersUserArrayOutput() GetUsersUserArrayOutput

func (GetUsersUserArrayOutput) ToGetUsersUserArrayOutputWithContext 

func (o GetUsersUserArrayOutput) ToGetUsersUserArrayOutputWithContext(ctx context.Context) GetUsersUserArrayOutput

type GetUsersUserInput 

type GetUsersUserInput interface {
	pulumi.Input

	ToGetUsersUserOutput() GetUsersUserOutput
	ToGetUsersUserOutputWithContext(context.Context) GetUsersUserOutput
}

GetUsersUserInput is an input type that accepts GetUsersUserArgs and GetUsersUserOutput values. You can construct a concrete instance of `GetUsersUserInput` via: 

GetUsersUserArgs{...}

type GetUsersUserOutput 

type GetUsersUserOutput struct{ *pulumi.OutputState }

func (GetUsersUserOutput) AdminRoles 

func (o GetUsersUserOutput) AdminRoles() pulumi.StringArrayOutput

Administrator roles assigned to user.

func (GetUsersUserOutput) City 

func (o GetUsersUserOutput) City() pulumi.StringOutput

City or locality component of user's address.

func (GetUsersUserOutput) CostCenter 

func (o GetUsersUserOutput) CostCenter() pulumi.StringOutput

Name of a cost center assigned to user.

func (GetUsersUserOutput) CountryCode 

func (o GetUsersUserOutput) CountryCode() pulumi.StringOutput

Country name component of user's address.

func (GetUsersUserOutput) CustomProfileAttributes 

func (o GetUsersUserOutput) CustomProfileAttributes() pulumi.StringOutput

Raw JSON containing all custom profile attributes.

func (GetUsersUserOutput) Department 

func (o GetUsersUserOutput) Department() pulumi.StringOutput

Name of user's department.

func (GetUsersUserOutput) DisplayName 

func (o GetUsersUserOutput) DisplayName() pulumi.StringOutput

Name of the user, suitable for display to end users.

func (GetUsersUserOutput) Division 

func (o GetUsersUserOutput) Division() pulumi.StringOutput

Name of user's division.

func (GetUsersUserOutput) ElementType 

func (GetUsersUserOutput) ElementType() reflect.Type

func (GetUsersUserOutput) Email 

func (o GetUsersUserOutput) Email() pulumi.StringOutput

Primary email address of user.

func (GetUsersUserOutput) EmployeeNumber 

func (o GetUsersUserOutput) EmployeeNumber() pulumi.StringOutput

Organization or company assigned unique identifier for the user.

func (GetUsersUserOutput) FirstName 

func (o GetUsersUserOutput) FirstName() pulumi.StringOutput

Given name of the user.

func (GetUsersUserOutput) GroupMemberships 

func (o GetUsersUserOutput) GroupMemberships() pulumi.StringArrayOutput

Groups user belongs to.

func (GetUsersUserOutput) HonorificPrefix 

func (o GetUsersUserOutput) HonorificPrefix() pulumi.StringOutput

Honorific prefix(es) of the user, or title in most Western languages.

func (GetUsersUserOutput) HonorificSuffix 

func (o GetUsersUserOutput) HonorificSuffix() pulumi.StringOutput

Honorific suffix(es) of the user.

func (GetUsersUserOutput) Id 

func (o GetUsersUserOutput) Id() pulumi.StringOutput

func (GetUsersUserOutput) LastName 

func (o GetUsersUserOutput) LastName() pulumi.StringOutput

Family name of the user.

func (GetUsersUserOutput) Locale 

func (o GetUsersUserOutput) Locale() pulumi.StringOutput

User's default location for purposes of localizing items such as currency, date time format, numerical representations, etc.

func (GetUsersUserOutput) Login 

func (o GetUsersUserOutput) Login() pulumi.StringOutput

Unique identifier for the user.

func (GetUsersUserOutput) Manager 

func (o GetUsersUserOutput) Manager() pulumi.StringOutput

Display name of the user's manager.

func (GetUsersUserOutput) ManagerId 

func (o GetUsersUserOutput) ManagerId() pulumi.StringOutput

`id` of a user's manager.

func (GetUsersUserOutput) MiddleName 

func (o GetUsersUserOutput) MiddleName() pulumi.StringOutput

Middle name(s) of the user.

func (GetUsersUserOutput) MobilePhone 

func (o GetUsersUserOutput) MobilePhone() pulumi.StringOutput

Mobile phone number of user.

func (GetUsersUserOutput) NickName 

func (o GetUsersUserOutput) NickName() pulumi.StringOutput

Casual way to address the user in real life.

func (GetUsersUserOutput) Organization 

func (o GetUsersUserOutput) Organization() pulumi.StringOutput

Name of user's organization.

func (GetUsersUserOutput) PostalAddress 

func (o GetUsersUserOutput) PostalAddress() pulumi.StringOutput

Mailing address component of user's address.

func (GetUsersUserOutput) PreferredLanguage 

func (o GetUsersUserOutput) PreferredLanguage() pulumi.StringOutput

User's preferred written or spoken languages.

func (GetUsersUserOutput) PrimaryPhone 

func (o GetUsersUserOutput) PrimaryPhone() pulumi.StringOutput

Primary phone number of user such as home number.

func (GetUsersUserOutput) ProfileUrl 

func (o GetUsersUserOutput) ProfileUrl() pulumi.StringOutput

URL of user's online profile (e.g. a web page).

func (GetUsersUserOutput) Roles added in v3.19.0 

func (o GetUsersUserOutput) Roles() pulumi.StringArrayOutput

func (GetUsersUserOutput) SecondEmail 

func (o GetUsersUserOutput) SecondEmail() pulumi.StringOutput

Secondary email address of user typically used for account recovery.

func (GetUsersUserOutput) State 

func (o GetUsersUserOutput) State() pulumi.StringOutput

State or region component of user's address (region).

func (GetUsersUserOutput) Status 

func (o GetUsersUserOutput) Status() pulumi.StringOutput

Current status of user.

func (GetUsersUserOutput) StreetAddress 

func (o GetUsersUserOutput) StreetAddress() pulumi.StringOutput

Full street address component of user's address.

func (GetUsersUserOutput) Timezone 

func (o GetUsersUserOutput) Timezone() pulumi.StringOutput

User's time zone.

func (GetUsersUserOutput) Title 

func (o GetUsersUserOutput) Title() pulumi.StringOutput

User's title, such as "Vice President".

func (GetUsersUserOutput) ToGetUsersUserOutput 

func (o GetUsersUserOutput) ToGetUsersUserOutput() GetUsersUserOutput

func (GetUsersUserOutput) ToGetUsersUserOutputWithContext 

func (o GetUsersUserOutput) ToGetUsersUserOutputWithContext(ctx context.Context) GetUsersUserOutput

func (GetUsersUserOutput) UserType 

func (o GetUsersUserOutput) UserType() pulumi.StringOutput

Used to describe the organization to user relationship such as "Employee" or "Contractor".

func (GetUsersUserOutput) ZipCode 

func (o GetUsersUserOutput) ZipCode() pulumi.StringOutput

Zipcode or postal code component of user's address (postalCode)

type LookupUserArgs 

type LookupUserArgs struct {
	// Given multiple search elements they will be compounded together with the op. Default is `and`, `or` is also valid.
	CompoundSearchOperator *string `pulumi:"compoundSearchOperator"`
	// Force delay of the user read by N seconds. Useful when eventual consistency of user information needs to be allowed for.
	DelayReadSeconds *string `pulumi:"delayReadSeconds"`
	// Map of search criteria. It supports the following properties.
	Searches []GetUserSearch `pulumi:"searches"`
	// Additional API call to collect user's groups will not be made.
	SkipGroups *bool `pulumi:"skipGroups"`
	// Additional API call to collect user's roles will not be made. `adminRoles` will not be written to state if skipping roles.
	SkipRoles *bool `pulumi:"skipRoles"`
	// String representing a specific user's id value
	UserId *string `pulumi:"userId"`
}

A collection of arguments for invoking getUser.

type LookupUserOutputArgs added in v3.2.0 

type LookupUserOutputArgs struct {
	// Given multiple search elements they will be compounded together with the op. Default is `and`, `or` is also valid.
	CompoundSearchOperator pulumi.StringPtrInput `pulumi:"compoundSearchOperator"`
	// Force delay of the user read by N seconds. Useful when eventual consistency of user information needs to be allowed for.
	DelayReadSeconds pulumi.StringPtrInput `pulumi:"delayReadSeconds"`
	// Map of search criteria. It supports the following properties.
	Searches GetUserSearchArrayInput `pulumi:"searches"`
	// Additional API call to collect user's groups will not be made.
	SkipGroups pulumi.BoolPtrInput `pulumi:"skipGroups"`
	// Additional API call to collect user's roles will not be made. `adminRoles` will not be written to state if skipping roles.
	SkipRoles pulumi.BoolPtrInput `pulumi:"skipRoles"`
	// String representing a specific user's id value
	UserId pulumi.StringPtrInput `pulumi:"userId"`
}

A collection of arguments for invoking getUser.

func (LookupUserOutputArgs) ElementType added in v3.2.0 

func (LookupUserOutputArgs) ElementType() reflect.Type

type LookupUserResult 

type LookupUserResult struct {
	// Administrator roles assigned to user.
	AdminRoles []string `pulumi:"adminRoles"`
	// City or locality component of user's address.
	City                   string  `pulumi:"city"`
	CompoundSearchOperator *string `pulumi:"compoundSearchOperator"`
	// Name of a cost center assigned to user.
	CostCenter string `pulumi:"costCenter"`
	// Country name component of user's address.
	CountryCode string `pulumi:"countryCode"`
	// Raw JSON containing all custom profile attributes.
	CustomProfileAttributes string  `pulumi:"customProfileAttributes"`
	DelayReadSeconds        *string `pulumi:"delayReadSeconds"`
	// Name of user's department.
	Department string `pulumi:"department"`
	// Name of the user, suitable for display to end users.
	DisplayName string `pulumi:"displayName"`
	// Name of user's division.
	Division string `pulumi:"division"`
	// Primary email address of user.
	Email string `pulumi:"email"`
	// Organization or company assigned unique identifier for the user.
	EmployeeNumber string `pulumi:"employeeNumber"`
	// Given name of the user.
	FirstName string `pulumi:"firstName"`
	// Groups user belongs to.
	GroupMemberships []string `pulumi:"groupMemberships"`
	// Honorific prefix(es) of the user, or title in most Western languages.
	HonorificPrefix string `pulumi:"honorificPrefix"`
	// Honorific suffix(es) of the user.
	HonorificSuffix string `pulumi:"honorificSuffix"`
	// The provider-assigned unique ID for this managed resource.
	Id string `pulumi:"id"`
	// Family name of the user.
	LastName string `pulumi:"lastName"`
	// User's default location for purposes of localizing items such as currency, date time format, numerical representations, etc.
	Locale string `pulumi:"locale"`
	// Unique identifier for the user.
	Login string `pulumi:"login"`
	// Display name of the user's manager.
	Manager string `pulumi:"manager"`
	// `id` of a user's manager.
	ManagerId string `pulumi:"managerId"`
	// Middle name(s) of the user.
	MiddleName string `pulumi:"middleName"`
	// Mobile phone number of user.
	MobilePhone string `pulumi:"mobilePhone"`
	// Casual way to address the user in real life.
	NickName string `pulumi:"nickName"`
	// Name of user's organization.
	Organization string `pulumi:"organization"`
	// Mailing address component of user's address.
	PostalAddress string `pulumi:"postalAddress"`
	// User's preferred written or spoken languages.
	PreferredLanguage string `pulumi:"preferredLanguage"`
	// Primary phone number of user such as home number.
	PrimaryPhone string `pulumi:"primaryPhone"`
	// URL of user's online profile (e.g. a web page).
	ProfileUrl string `pulumi:"profileUrl"`
	// All roles assigned to user.
	Roles    []string        `pulumi:"roles"`
	Searches []GetUserSearch `pulumi:"searches"`
	// Secondary email address of user typically used for account recovery.
	SecondEmail string `pulumi:"secondEmail"`
	SkipGroups  *bool  `pulumi:"skipGroups"`
	SkipRoles   *bool  `pulumi:"skipRoles"`
	// State or region component of user's address (region).
	State string `pulumi:"state"`
	// Current status of user.
	Status string `pulumi:"status"`
	// Full street address component of user's address.
	StreetAddress string `pulumi:"streetAddress"`
	// User's time zone.
	Timezone string `pulumi:"timezone"`
	// User's title, such as "Vice President".
	Title  string  `pulumi:"title"`
	UserId *string `pulumi:"userId"`
	// Used to describe the organization to user relationship such as "Employee" or "Contractor".
	UserType string `pulumi:"userType"`
	// Zipcode or postal code component of user's address (postalCode)
	ZipCode string `pulumi:"zipCode"`
}

A collection of values returned by getUser.

func LookupUser 

func LookupUser(ctx *pulumi.Context, args *LookupUserArgs, opts ...pulumi.InvokeOption) (*LookupUserResult, error)

Use this data source to retrieve a users from Okta.

## Example Usage

```go package main

import ( 

"github.com/pulumi/pulumi-okta/sdk/v3/go/okta/user"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"

) 

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := user.LookupUser(ctx, &user.LookupUserArgs{
			Searches: []user.GetUserSearch{
				{
					Expression: pulumi.StringRef("profile.firstName eq \"John\""),
				},
			},
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

```

type LookupUserResultOutput added in v3.2.0 

type LookupUserResultOutput struct{ *pulumi.OutputState }

A collection of values returned by getUser.

func LookupUserOutput added in v3.2.0 

func LookupUserOutput(ctx *pulumi.Context, args LookupUserOutputArgs, opts ...pulumi.InvokeOption) LookupUserResultOutput

func (LookupUserResultOutput) AdminRoles added in v3.2.0 

func (o LookupUserResultOutput) AdminRoles() pulumi.StringArrayOutput

Administrator roles assigned to user.

func (LookupUserResultOutput) City added in v3.2.0 

func (o LookupUserResultOutput) City() pulumi.StringOutput

City or locality component of user's address.

func (LookupUserResultOutput) CompoundSearchOperator added in v3.9.0 

func (o LookupUserResultOutput) CompoundSearchOperator() pulumi.StringPtrOutput

func (LookupUserResultOutput) CostCenter added in v3.2.0 

func (o LookupUserResultOutput) CostCenter() pulumi.StringOutput

Name of a cost center assigned to user.

func (LookupUserResultOutput) CountryCode added in v3.2.0 

func (o LookupUserResultOutput) CountryCode() pulumi.StringOutput

Country name component of user's address.

func (LookupUserResultOutput) CustomProfileAttributes added in v3.2.0 

func (o LookupUserResultOutput) CustomProfileAttributes() pulumi.StringOutput

Raw JSON containing all custom profile attributes.

func (LookupUserResultOutput) DelayReadSeconds added in v3.14.0 

func (o LookupUserResultOutput) DelayReadSeconds() pulumi.StringPtrOutput

func (LookupUserResultOutput) Department added in v3.2.0 

func (o LookupUserResultOutput) Department() pulumi.StringOutput

Name of user's department.

func (LookupUserResultOutput) DisplayName added in v3.2.0 

func (o LookupUserResultOutput) DisplayName() pulumi.StringOutput

Name of the user, suitable for display to end users.

func (LookupUserResultOutput) Division added in v3.2.0 

func (o LookupUserResultOutput) Division() pulumi.StringOutput

Name of user's division.

func (LookupUserResultOutput) ElementType added in v3.2.0 

func (LookupUserResultOutput) ElementType() reflect.Type

func (LookupUserResultOutput) Email added in v3.2.0 

func (o LookupUserResultOutput) Email() pulumi.StringOutput

Primary email address of user.

func (LookupUserResultOutput) EmployeeNumber added in v3.2.0 

func (o LookupUserResultOutput) EmployeeNumber() pulumi.StringOutput

Organization or company assigned unique identifier for the user.

func (LookupUserResultOutput) FirstName added in v3.2.0 

func (o LookupUserResultOutput) FirstName() pulumi.StringOutput

Given name of the user.

func (LookupUserResultOutput) GroupMemberships added in v3.2.0 

func (o LookupUserResultOutput) GroupMemberships() pulumi.StringArrayOutput

Groups user belongs to.

func (LookupUserResultOutput) HonorificPrefix added in v3.2.0 

func (o LookupUserResultOutput) HonorificPrefix() pulumi.StringOutput

Honorific prefix(es) of the user, or title in most Western languages.

func (LookupUserResultOutput) HonorificSuffix added in v3.2.0 

func (o LookupUserResultOutput) HonorificSuffix() pulumi.StringOutput

Honorific suffix(es) of the user.

func (LookupUserResultOutput) Id added in v3.2.0 

func (o LookupUserResultOutput) Id() pulumi.StringOutput

The provider-assigned unique ID for this managed resource.

func (LookupUserResultOutput) LastName added in v3.2.0 

func (o LookupUserResultOutput) LastName() pulumi.StringOutput

Family name of the user.

func (LookupUserResultOutput) Locale added in v3.2.0 

func (o LookupUserResultOutput) Locale() pulumi.StringOutput

User's default location for purposes of localizing items such as currency, date time format, numerical representations, etc.

func (LookupUserResultOutput) Login added in v3.2.0 

func (o LookupUserResultOutput) Login() pulumi.StringOutput

Unique identifier for the user.

func (LookupUserResultOutput) Manager added in v3.2.0 

func (o LookupUserResultOutput) Manager() pulumi.StringOutput

Display name of the user's manager.

func (LookupUserResultOutput) ManagerId added in v3.2.0 

func (o LookupUserResultOutput) ManagerId() pulumi.StringOutput

`id` of a user's manager.

func (LookupUserResultOutput) MiddleName added in v3.2.0 

func (o LookupUserResultOutput) MiddleName() pulumi.StringOutput

Middle name(s) of the user.

func (LookupUserResultOutput) MobilePhone added in v3.2.0 

func (o LookupUserResultOutput) MobilePhone() pulumi.StringOutput

Mobile phone number of user.

func (LookupUserResultOutput) NickName added in v3.2.0 

func (o LookupUserResultOutput) NickName() pulumi.StringOutput

Casual way to address the user in real life.

func (LookupUserResultOutput) Organization added in v3.2.0 

func (o LookupUserResultOutput) Organization() pulumi.StringOutput

Name of user's organization.

func (LookupUserResultOutput) PostalAddress added in v3.2.0 

func (o LookupUserResultOutput) PostalAddress() pulumi.StringOutput

Mailing address component of user's address.

func (LookupUserResultOutput) PreferredLanguage added in v3.2.0 

func (o LookupUserResultOutput) PreferredLanguage() pulumi.StringOutput

User's preferred written or spoken languages.

func (LookupUserResultOutput) PrimaryPhone added in v3.2.0 

func (o LookupUserResultOutput) PrimaryPhone() pulumi.StringOutput

Primary phone number of user such as home number.

func (LookupUserResultOutput) ProfileUrl added in v3.2.0 

func (o LookupUserResultOutput) ProfileUrl() pulumi.StringOutput

URL of user's online profile (e.g. a web page).

func (LookupUserResultOutput) Roles added in v3.19.0 

func (o LookupUserResultOutput) Roles() pulumi.StringArrayOutput

All roles assigned to user.

func (LookupUserResultOutput) Searches added in v3.2.0 

func (o LookupUserResultOutput) Searches() GetUserSearchArrayOutput

func (LookupUserResultOutput) SecondEmail added in v3.2.0 

func (o LookupUserResultOutput) SecondEmail() pulumi.StringOutput

Secondary email address of user typically used for account recovery.

func (LookupUserResultOutput) SkipGroups added in v3.8.0 

func (o LookupUserResultOutput) SkipGroups() pulumi.BoolPtrOutput

func (LookupUserResultOutput) SkipRoles added in v3.8.0 

func (o LookupUserResultOutput) SkipRoles() pulumi.BoolPtrOutput

func (LookupUserResultOutput) State added in v3.2.0 

func (o LookupUserResultOutput) State() pulumi.StringOutput

State or region component of user's address (region).

func (LookupUserResultOutput) Status added in v3.2.0 

func (o LookupUserResultOutput) Status() pulumi.StringOutput

Current status of user.

func (LookupUserResultOutput) StreetAddress added in v3.2.0 

func (o LookupUserResultOutput) StreetAddress() pulumi.StringOutput

Full street address component of user's address.

func (LookupUserResultOutput) Timezone added in v3.2.0 

func (o LookupUserResultOutput) Timezone() pulumi.StringOutput

User's time zone.

func (LookupUserResultOutput) Title added in v3.2.0 

func (o LookupUserResultOutput) Title() pulumi.StringOutput

User's title, such as "Vice President".

func (LookupUserResultOutput) ToLookupUserResultOutput added in v3.2.0 

func (o LookupUserResultOutput) ToLookupUserResultOutput() LookupUserResultOutput

func (LookupUserResultOutput) ToLookupUserResultOutputWithContext added in v3.2.0 

func (o LookupUserResultOutput) ToLookupUserResultOutputWithContext(ctx context.Context) LookupUserResultOutput

func (LookupUserResultOutput) UserId added in v3.2.0 

func (o LookupUserResultOutput) UserId() pulumi.StringPtrOutput

func (LookupUserResultOutput) UserType added in v3.2.0 

func (o LookupUserResultOutput) UserType() pulumi.StringOutput

Used to describe the organization to user relationship such as "Employee" or "Contractor".

func (LookupUserResultOutput) ZipCode added in v3.2.0 

func (o LookupUserResultOutput) ZipCode() pulumi.StringOutput

Zipcode or postal code component of user's address (postalCode)

type LookupUserTypeArgs 

type LookupUserTypeArgs struct {
	// name of user type to retrieve.
	Name string `pulumi:"name"`
}

A collection of arguments for invoking getUserType.

type LookupUserTypeOutputArgs added in v3.2.0 

type LookupUserTypeOutputArgs struct {
	// name of user type to retrieve.
	Name pulumi.StringInput `pulumi:"name"`
}

A collection of arguments for invoking getUserType.

func (LookupUserTypeOutputArgs) ElementType added in v3.2.0 

func (LookupUserTypeOutputArgs) ElementType() reflect.Type

type LookupUserTypeResult 

type LookupUserTypeResult struct {
	// description of user type.
	Description string `pulumi:"description"`
	// display name of user type.
	DisplayName string `pulumi:"displayName"`
	// The provider-assigned unique ID for this managed resource.
	Id string `pulumi:"id"`
	// name of user type.
	Name string `pulumi:"name"`
}

A collection of values returned by getUserType.

func LookupUserType 

func LookupUserType(ctx *pulumi.Context, args *LookupUserTypeArgs, opts ...pulumi.InvokeOption) (*LookupUserTypeResult, error)

Use this data source to retrieve a user type from Okta.

## Example Usage

```go package main

import ( 

"github.com/pulumi/pulumi-okta/sdk/v3/go/okta/user"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"

) 

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := user.LookupUserType(ctx, &user.LookupUserTypeArgs{
			Name: "example",
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

```

type LookupUserTypeResultOutput added in v3.2.0 

type LookupUserTypeResultOutput struct{ *pulumi.OutputState }

A collection of values returned by getUserType.

func LookupUserTypeOutput added in v3.2.0 

func LookupUserTypeOutput(ctx *pulumi.Context, args LookupUserTypeOutputArgs, opts ...pulumi.InvokeOption) LookupUserTypeResultOutput

func (LookupUserTypeResultOutput) Description added in v3.2.0 

func (o LookupUserTypeResultOutput) Description() pulumi.StringOutput

description of user type.

func (LookupUserTypeResultOutput) DisplayName added in v3.2.0 

func (o LookupUserTypeResultOutput) DisplayName() pulumi.StringOutput

display name of user type.

func (LookupUserTypeResultOutput) ElementType added in v3.2.0 

func (LookupUserTypeResultOutput) ElementType() reflect.Type

func (LookupUserTypeResultOutput) Id added in v3.2.0 

func (o LookupUserTypeResultOutput) Id() pulumi.StringOutput

The provider-assigned unique ID for this managed resource.

func (LookupUserTypeResultOutput) Name added in v3.2.0 

func (o LookupUserTypeResultOutput) Name() pulumi.StringOutput

name of user type.

func (LookupUserTypeResultOutput) ToLookupUserTypeResultOutput added in v3.2.0 

func (o LookupUserTypeResultOutput) ToLookupUserTypeResultOutput() LookupUserTypeResultOutput

func (LookupUserTypeResultOutput) ToLookupUserTypeResultOutputWithContext added in v3.2.0 

func (o LookupUserTypeResultOutput) ToLookupUserTypeResultOutputWithContext(ctx context.Context) LookupUserTypeResultOutput

type Schema 

type Schema struct {
	pulumi.CustomResourceState

	// Array of values that an array property's items can be set to.
	ArrayEnums pulumi.StringArrayOutput `pulumi:"arrayEnums"`
	// Display name and value an enum array can be set to.
	ArrayOneOfs SchemaArrayOneOfArrayOutput `pulumi:"arrayOneOfs"`
	// The type of the array elements if `type` is set to `"array"`.
	ArrayType pulumi.StringPtrOutput `pulumi:"arrayType"`
	// The description of the user schema property.
	Description pulumi.StringPtrOutput `pulumi:"description"`
	// Array of values a primitive property can be set to. See `arrayEnum` for arrays.
	Enums pulumi.StringArrayOutput `pulumi:"enums"`
	// External name of the user schema property.
	ExternalName pulumi.StringPtrOutput `pulumi:"externalName"`
	// External name of the user schema property.
	ExternalNamespace pulumi.StringPtrOutput `pulumi:"externalNamespace"`
	// The property name.
	Index pulumi.StringOutput `pulumi:"index"`
	// Master priority for the user schema property. It can be set to `"PROFILE_MASTER"`, `"OVERRIDE"` or `"OKTA"`.
	Master pulumi.StringPtrOutput `pulumi:"master"`
	// Prioritized list of profile sources (required when `master` is `"OVERRIDE"`).
	MasterOverridePriorities SchemaMasterOverridePriorityArrayOutput `pulumi:"masterOverridePriorities"`
	// The maximum length of the user property value. Only applies to type `"string"`.
	MaxLength pulumi.IntPtrOutput `pulumi:"maxLength"`
	// The minimum length of the user property value. Only applies to type `"string"`.
	MinLength pulumi.IntPtrOutput `pulumi:"minLength"`
	// Array of maps containing a mapping for display name to enum value.
	OneOfs SchemaOneOfArrayOutput `pulumi:"oneOfs"`
	// The validation pattern to use for the subschema. Must be in form of '.+', or '[<pattern>]+' if present.'
	Pattern pulumi.StringPtrOutput `pulumi:"pattern"`
	// Access control permissions for the property. It can be set to `"READ_WRITE"`, `"READ_ONLY"`, `"HIDE"`.
	Permissions pulumi.StringPtrOutput `pulumi:"permissions"`
	// Whether the property is required for this application's users.
	Required pulumi.BoolPtrOutput `pulumi:"required"`
	// determines whether an app user attribute can be set at the Individual or Group Level.
	Scope pulumi.StringPtrOutput `pulumi:"scope"`
	// display name for the enum value.
	Title pulumi.StringOutput `pulumi:"title"`
	// Type of profile source.
	Type pulumi.StringOutput `pulumi:"type"`
	// Whether the property should be unique. It can be set to `"UNIQUE_VALIDATED"` or `"NOT_UNIQUE"`.
	Unique pulumi.StringPtrOutput `pulumi:"unique"`
	// User type ID
	UserType pulumi.StringPtrOutput `pulumi:"userType"`
}

## Example Usage

```go package main

import ( 

"github.com/pulumi/pulumi-okta/sdk/v3/go/okta/user"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"

) 

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := user.NewSchema(ctx, "example", &user.SchemaArgs{
			Description: pulumi.String("My custom property name"),
			Index:       pulumi.String("customPropertyName"),
			Master:      pulumi.String("OKTA"),
			Scope:       pulumi.String("SELF"),
			Title:       pulumi.String("customPropertyName"),
			Type:        pulumi.String("string"),
			UserType:    pulumi.Any(data.Okta_user_type.Example.Id),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

```

## Import

User schema property of default user type can be imported via the property index.

```sh 

$ pulumi import okta:user/schema:Schema example &#60;index&#62;

``` 

User schema property of custom user type can be imported via user type id and property index

```sh 

$ pulumi import okta:user/schema:Schema example &#60;user type id&#62;.&#60;index&#62;

```

func GetSchema 

func GetSchema(ctx *pulumi.Context,
	name string, id pulumi.IDInput, state *SchemaState, opts ...pulumi.ResourceOption) (*Schema, error)

GetSchema gets an existing Schema 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 NewSchema 

func NewSchema(ctx *pulumi.Context,
	name string, args *SchemaArgs, opts ...pulumi.ResourceOption) (*Schema, error)

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

func (*Schema) ElementType 

func (*Schema) ElementType() reflect.Type

func (*Schema) ToSchemaOutput 

func (i *Schema) ToSchemaOutput() SchemaOutput

func (*Schema) ToSchemaOutputWithContext 

func (i *Schema) ToSchemaOutputWithContext(ctx context.Context) SchemaOutput

type SchemaArgs 

type SchemaArgs struct {
	// Array of values that an array property's items can be set to.
	ArrayEnums pulumi.StringArrayInput
	// Display name and value an enum array can be set to.
	ArrayOneOfs SchemaArrayOneOfArrayInput
	// The type of the array elements if `type` is set to `"array"`.
	ArrayType pulumi.StringPtrInput
	// The description of the user schema property.
	Description pulumi.StringPtrInput
	// Array of values a primitive property can be set to. See `arrayEnum` for arrays.
	Enums pulumi.StringArrayInput
	// External name of the user schema property.
	ExternalName pulumi.StringPtrInput
	// External name of the user schema property.
	ExternalNamespace pulumi.StringPtrInput
	// The property name.
	Index pulumi.StringInput
	// Master priority for the user schema property. It can be set to `"PROFILE_MASTER"`, `"OVERRIDE"` or `"OKTA"`.
	Master pulumi.StringPtrInput
	// Prioritized list of profile sources (required when `master` is `"OVERRIDE"`).
	MasterOverridePriorities SchemaMasterOverridePriorityArrayInput
	// The maximum length of the user property value. Only applies to type `"string"`.
	MaxLength pulumi.IntPtrInput
	// The minimum length of the user property value. Only applies to type `"string"`.
	MinLength pulumi.IntPtrInput
	// Array of maps containing a mapping for display name to enum value.
	OneOfs SchemaOneOfArrayInput
	// The validation pattern to use for the subschema. Must be in form of '.+', or '[<pattern>]+' if present.'
	Pattern pulumi.StringPtrInput
	// Access control permissions for the property. It can be set to `"READ_WRITE"`, `"READ_ONLY"`, `"HIDE"`.
	Permissions pulumi.StringPtrInput
	// Whether the property is required for this application's users.
	Required pulumi.BoolPtrInput
	// determines whether an app user attribute can be set at the Individual or Group Level.
	Scope pulumi.StringPtrInput
	// display name for the enum value.
	Title pulumi.StringInput
	// Type of profile source.
	Type pulumi.StringInput
	// Whether the property should be unique. It can be set to `"UNIQUE_VALIDATED"` or `"NOT_UNIQUE"`.
	Unique pulumi.StringPtrInput
	// User type ID
	UserType pulumi.StringPtrInput
}

The set of arguments for constructing a Schema resource.

func (SchemaArgs) ElementType 

func (SchemaArgs) ElementType() reflect.Type

type SchemaArray 

type SchemaArray []SchemaInput

func (SchemaArray) ElementType 

func (SchemaArray) ElementType() reflect.Type

func (SchemaArray) ToSchemaArrayOutput 

func (i SchemaArray) ToSchemaArrayOutput() SchemaArrayOutput

func (SchemaArray) ToSchemaArrayOutputWithContext 

func (i SchemaArray) ToSchemaArrayOutputWithContext(ctx context.Context) SchemaArrayOutput

type SchemaArrayInput 

type SchemaArrayInput interface {
	pulumi.Input

	ToSchemaArrayOutput() SchemaArrayOutput
	ToSchemaArrayOutputWithContext(context.Context) SchemaArrayOutput
}

SchemaArrayInput is an input type that accepts SchemaArray and SchemaArrayOutput values. You can construct a concrete instance of `SchemaArrayInput` via: 

SchemaArray{ SchemaArgs{...} }

type SchemaArrayOneOf 

type SchemaArrayOneOf struct {
	// value mapping to member of `enum`.
	Const string `pulumi:"const"`
	// display name for the enum value.
	Title string `pulumi:"title"`
}

type SchemaArrayOneOfArgs 

type SchemaArrayOneOfArgs struct {
	// value mapping to member of `enum`.
	Const pulumi.StringInput `pulumi:"const"`
	// display name for the enum value.
	Title pulumi.StringInput `pulumi:"title"`
}

func (SchemaArrayOneOfArgs) ElementType 

func (SchemaArrayOneOfArgs) ElementType() reflect.Type

func (SchemaArrayOneOfArgs) ToSchemaArrayOneOfOutput 

func (i SchemaArrayOneOfArgs) ToSchemaArrayOneOfOutput() SchemaArrayOneOfOutput

func (SchemaArrayOneOfArgs) ToSchemaArrayOneOfOutputWithContext 

func (i SchemaArrayOneOfArgs) ToSchemaArrayOneOfOutputWithContext(ctx context.Context) SchemaArrayOneOfOutput

type SchemaArrayOneOfArray 

type SchemaArrayOneOfArray []SchemaArrayOneOfInput

func (SchemaArrayOneOfArray) ElementType 

func (SchemaArrayOneOfArray) ElementType() reflect.Type

func (SchemaArrayOneOfArray) ToSchemaArrayOneOfArrayOutput 

func (i SchemaArrayOneOfArray) ToSchemaArrayOneOfArrayOutput() SchemaArrayOneOfArrayOutput

func (SchemaArrayOneOfArray) ToSchemaArrayOneOfArrayOutputWithContext 

func (i SchemaArrayOneOfArray) ToSchemaArrayOneOfArrayOutputWithContext(ctx context.Context) SchemaArrayOneOfArrayOutput

type SchemaArrayOneOfArrayInput 

type SchemaArrayOneOfArrayInput interface {
	pulumi.Input

	ToSchemaArrayOneOfArrayOutput() SchemaArrayOneOfArrayOutput
	ToSchemaArrayOneOfArrayOutputWithContext(context.Context) SchemaArrayOneOfArrayOutput
}

SchemaArrayOneOfArrayInput is an input type that accepts SchemaArrayOneOfArray and SchemaArrayOneOfArrayOutput values. You can construct a concrete instance of `SchemaArrayOneOfArrayInput` via: 

SchemaArrayOneOfArray{ SchemaArrayOneOfArgs{...} }

type SchemaArrayOneOfArrayOutput 

type SchemaArrayOneOfArrayOutput struct{ *pulumi.OutputState }

func (SchemaArrayOneOfArrayOutput) ElementType 

func (SchemaArrayOneOfArrayOutput) ElementType() reflect.Type

func (SchemaArrayOneOfArrayOutput) Index 

func (o SchemaArrayOneOfArrayOutput) Index(i pulumi.IntInput) SchemaArrayOneOfOutput

func (SchemaArrayOneOfArrayOutput) ToSchemaArrayOneOfArrayOutput 

func (o SchemaArrayOneOfArrayOutput) ToSchemaArrayOneOfArrayOutput() SchemaArrayOneOfArrayOutput

func (SchemaArrayOneOfArrayOutput) ToSchemaArrayOneOfArrayOutputWithContext 

func (o SchemaArrayOneOfArrayOutput) ToSchemaArrayOneOfArrayOutputWithContext(ctx context.Context) SchemaArrayOneOfArrayOutput

type SchemaArrayOneOfInput 

type SchemaArrayOneOfInput interface {
	pulumi.Input

	ToSchemaArrayOneOfOutput() SchemaArrayOneOfOutput
	ToSchemaArrayOneOfOutputWithContext(context.Context) SchemaArrayOneOfOutput
}

SchemaArrayOneOfInput is an input type that accepts SchemaArrayOneOfArgs and SchemaArrayOneOfOutput values. You can construct a concrete instance of `SchemaArrayOneOfInput` via: 

SchemaArrayOneOfArgs{...}

type SchemaArrayOneOfOutput 

type SchemaArrayOneOfOutput struct{ *pulumi.OutputState }

func (SchemaArrayOneOfOutput) Const 

func (o SchemaArrayOneOfOutput) Const() pulumi.StringOutput

value mapping to member of `enum`.

func (SchemaArrayOneOfOutput) ElementType 

func (SchemaArrayOneOfOutput) ElementType() reflect.Type

func (SchemaArrayOneOfOutput) Title 

func (o SchemaArrayOneOfOutput) Title() pulumi.StringOutput

display name for the enum value.

func (SchemaArrayOneOfOutput) ToSchemaArrayOneOfOutput 

func (o SchemaArrayOneOfOutput) ToSchemaArrayOneOfOutput() SchemaArrayOneOfOutput

func (SchemaArrayOneOfOutput) ToSchemaArrayOneOfOutputWithContext 

func (o SchemaArrayOneOfOutput) ToSchemaArrayOneOfOutputWithContext(ctx context.Context) SchemaArrayOneOfOutput

type SchemaArrayOutput 

type SchemaArrayOutput struct{ *pulumi.OutputState }

func (SchemaArrayOutput) ElementType 

func (SchemaArrayOutput) ElementType() reflect.Type

func (SchemaArrayOutput) Index 

func (o SchemaArrayOutput) Index(i pulumi.IntInput) SchemaOutput

func (SchemaArrayOutput) ToSchemaArrayOutput 

func (o SchemaArrayOutput) ToSchemaArrayOutput() SchemaArrayOutput

func (SchemaArrayOutput) ToSchemaArrayOutputWithContext 

func (o SchemaArrayOutput) ToSchemaArrayOutputWithContext(ctx context.Context) SchemaArrayOutput

type SchemaInput 

type SchemaInput interface {
	pulumi.Input

	ToSchemaOutput() SchemaOutput
	ToSchemaOutputWithContext(ctx context.Context) SchemaOutput
}

type SchemaMap 

type SchemaMap map[string]SchemaInput

func (SchemaMap) ElementType 

func (SchemaMap) ElementType() reflect.Type

func (SchemaMap) ToSchemaMapOutput 

func (i SchemaMap) ToSchemaMapOutput() SchemaMapOutput

func (SchemaMap) ToSchemaMapOutputWithContext 

func (i SchemaMap) ToSchemaMapOutputWithContext(ctx context.Context) SchemaMapOutput

type SchemaMapInput 

type SchemaMapInput interface {
	pulumi.Input

	ToSchemaMapOutput() SchemaMapOutput
	ToSchemaMapOutputWithContext(context.Context) SchemaMapOutput
}

SchemaMapInput is an input type that accepts SchemaMap and SchemaMapOutput values. You can construct a concrete instance of `SchemaMapInput` via: 

SchemaMap{ "key": SchemaArgs{...} }

type SchemaMapOutput 

type SchemaMapOutput struct{ *pulumi.OutputState }

func (SchemaMapOutput) ElementType 

func (SchemaMapOutput) ElementType() reflect.Type

func (SchemaMapOutput) MapIndex 

func (o SchemaMapOutput) MapIndex(k pulumi.StringInput) SchemaOutput

func (SchemaMapOutput) ToSchemaMapOutput 

func (o SchemaMapOutput) ToSchemaMapOutput() SchemaMapOutput

func (SchemaMapOutput) ToSchemaMapOutputWithContext 

func (o SchemaMapOutput) ToSchemaMapOutputWithContext(ctx context.Context) SchemaMapOutput

type SchemaMasterOverridePriority 

type SchemaMasterOverridePriority struct {
	// Type of profile source.
	Type *string `pulumi:"type"`
	// ID of profile source.
	Value string `pulumi:"value"`
}

type SchemaMasterOverridePriorityArgs 

type SchemaMasterOverridePriorityArgs struct {
	// Type of profile source.
	Type pulumi.StringPtrInput `pulumi:"type"`
	// ID of profile source.
	Value pulumi.StringInput `pulumi:"value"`
}

func (SchemaMasterOverridePriorityArgs) ElementType 

func (SchemaMasterOverridePriorityArgs) ElementType() reflect.Type

func (SchemaMasterOverridePriorityArgs) ToSchemaMasterOverridePriorityOutput 

func (i SchemaMasterOverridePriorityArgs) ToSchemaMasterOverridePriorityOutput() SchemaMasterOverridePriorityOutput

func (SchemaMasterOverridePriorityArgs) ToSchemaMasterOverridePriorityOutputWithContext 

func (i SchemaMasterOverridePriorityArgs) ToSchemaMasterOverridePriorityOutputWithContext(ctx context.Context) SchemaMasterOverridePriorityOutput

type SchemaMasterOverridePriorityArray 

type SchemaMasterOverridePriorityArray []SchemaMasterOverridePriorityInput

func (SchemaMasterOverridePriorityArray) ElementType 

func (SchemaMasterOverridePriorityArray) ElementType() reflect.Type

func (SchemaMasterOverridePriorityArray) ToSchemaMasterOverridePriorityArrayOutput 

func (i SchemaMasterOverridePriorityArray) ToSchemaMasterOverridePriorityArrayOutput() SchemaMasterOverridePriorityArrayOutput

func (SchemaMasterOverridePriorityArray) ToSchemaMasterOverridePriorityArrayOutputWithContext 

func (i SchemaMasterOverridePriorityArray) ToSchemaMasterOverridePriorityArrayOutputWithContext(ctx context.Context) SchemaMasterOverridePriorityArrayOutput

type SchemaMasterOverridePriorityArrayInput 

type SchemaMasterOverridePriorityArrayInput interface {
	pulumi.Input

	ToSchemaMasterOverridePriorityArrayOutput() SchemaMasterOverridePriorityArrayOutput
	ToSchemaMasterOverridePriorityArrayOutputWithContext(context.Context) SchemaMasterOverridePriorityArrayOutput
}

SchemaMasterOverridePriorityArrayInput is an input type that accepts SchemaMasterOverridePriorityArray and SchemaMasterOverridePriorityArrayOutput values. You can construct a concrete instance of `SchemaMasterOverridePriorityArrayInput` via: 

SchemaMasterOverridePriorityArray{ SchemaMasterOverridePriorityArgs{...} }

type SchemaMasterOverridePriorityArrayOutput 

type SchemaMasterOverridePriorityArrayOutput struct{ *pulumi.OutputState }

func (SchemaMasterOverridePriorityArrayOutput) ElementType 

func (SchemaMasterOverridePriorityArrayOutput) ElementType() reflect.Type

func (SchemaMasterOverridePriorityArrayOutput) Index 

func (o SchemaMasterOverridePriorityArrayOutput) Index(i pulumi.IntInput) SchemaMasterOverridePriorityOutput

func (SchemaMasterOverridePriorityArrayOutput) ToSchemaMasterOverridePriorityArrayOutput 

func (o SchemaMasterOverridePriorityArrayOutput) ToSchemaMasterOverridePriorityArrayOutput() SchemaMasterOverridePriorityArrayOutput

func (SchemaMasterOverridePriorityArrayOutput) ToSchemaMasterOverridePriorityArrayOutputWithContext 

func (o SchemaMasterOverridePriorityArrayOutput) ToSchemaMasterOverridePriorityArrayOutputWithContext(ctx context.Context) SchemaMasterOverridePriorityArrayOutput

type SchemaMasterOverridePriorityInput 

type SchemaMasterOverridePriorityInput interface {
	pulumi.Input

	ToSchemaMasterOverridePriorityOutput() SchemaMasterOverridePriorityOutput
	ToSchemaMasterOverridePriorityOutputWithContext(context.Context) SchemaMasterOverridePriorityOutput
}

SchemaMasterOverridePriorityInput is an input type that accepts SchemaMasterOverridePriorityArgs and SchemaMasterOverridePriorityOutput values. You can construct a concrete instance of `SchemaMasterOverridePriorityInput` via: 

SchemaMasterOverridePriorityArgs{...}

type SchemaMasterOverridePriorityOutput 

type SchemaMasterOverridePriorityOutput struct{ *pulumi.OutputState }

func (SchemaMasterOverridePriorityOutput) ElementType 

func (SchemaMasterOverridePriorityOutput) ElementType() reflect.Type

func (SchemaMasterOverridePriorityOutput) ToSchemaMasterOverridePriorityOutput 

func (o SchemaMasterOverridePriorityOutput) ToSchemaMasterOverridePriorityOutput() SchemaMasterOverridePriorityOutput

func (SchemaMasterOverridePriorityOutput) ToSchemaMasterOverridePriorityOutputWithContext 

func (o SchemaMasterOverridePriorityOutput) ToSchemaMasterOverridePriorityOutputWithContext(ctx context.Context) SchemaMasterOverridePriorityOutput

func (SchemaMasterOverridePriorityOutput) Type 

func (o SchemaMasterOverridePriorityOutput) Type() pulumi.StringPtrOutput

Type of profile source.

func (SchemaMasterOverridePriorityOutput) Value 

func (o SchemaMasterOverridePriorityOutput) Value() pulumi.StringOutput

ID of profile source.

type SchemaOneOf 

type SchemaOneOf struct {
	// value mapping to member of `enum`.
	Const string `pulumi:"const"`
	// display name for the enum value.
	Title string `pulumi:"title"`
}

type SchemaOneOfArgs 

type SchemaOneOfArgs struct {
	// value mapping to member of `enum`.
	Const pulumi.StringInput `pulumi:"const"`
	// display name for the enum value.
	Title pulumi.StringInput `pulumi:"title"`
}

func (SchemaOneOfArgs) ElementType 

func (SchemaOneOfArgs) ElementType() reflect.Type

func (SchemaOneOfArgs) ToSchemaOneOfOutput 

func (i SchemaOneOfArgs) ToSchemaOneOfOutput() SchemaOneOfOutput

func (SchemaOneOfArgs) ToSchemaOneOfOutputWithContext 

func (i SchemaOneOfArgs) ToSchemaOneOfOutputWithContext(ctx context.Context) SchemaOneOfOutput

type SchemaOneOfArray 

type SchemaOneOfArray []SchemaOneOfInput

func (SchemaOneOfArray) ElementType 

func (SchemaOneOfArray) ElementType() reflect.Type

func (SchemaOneOfArray) ToSchemaOneOfArrayOutput 

func (i SchemaOneOfArray) ToSchemaOneOfArrayOutput() SchemaOneOfArrayOutput

func (SchemaOneOfArray) ToSchemaOneOfArrayOutputWithContext 

func (i SchemaOneOfArray) ToSchemaOneOfArrayOutputWithContext(ctx context.Context) SchemaOneOfArrayOutput

type SchemaOneOfArrayInput 

type SchemaOneOfArrayInput interface {
	pulumi.Input

	ToSchemaOneOfArrayOutput() SchemaOneOfArrayOutput
	ToSchemaOneOfArrayOutputWithContext(context.Context) SchemaOneOfArrayOutput
}

SchemaOneOfArrayInput is an input type that accepts SchemaOneOfArray and SchemaOneOfArrayOutput values. You can construct a concrete instance of `SchemaOneOfArrayInput` via: 

SchemaOneOfArray{ SchemaOneOfArgs{...} }

type SchemaOneOfArrayOutput 

type SchemaOneOfArrayOutput struct{ *pulumi.OutputState }

func (SchemaOneOfArrayOutput) ElementType 

func (SchemaOneOfArrayOutput) ElementType() reflect.Type

func (SchemaOneOfArrayOutput) Index 

func (o SchemaOneOfArrayOutput) Index(i pulumi.IntInput) SchemaOneOfOutput

func (SchemaOneOfArrayOutput) ToSchemaOneOfArrayOutput 

func (o SchemaOneOfArrayOutput) ToSchemaOneOfArrayOutput() SchemaOneOfArrayOutput

func (SchemaOneOfArrayOutput) ToSchemaOneOfArrayOutputWithContext 

func (o SchemaOneOfArrayOutput) ToSchemaOneOfArrayOutputWithContext(ctx context.Context) SchemaOneOfArrayOutput

type SchemaOneOfInput 

type SchemaOneOfInput interface {
	pulumi.Input

	ToSchemaOneOfOutput() SchemaOneOfOutput
	ToSchemaOneOfOutputWithContext(context.Context) SchemaOneOfOutput
}

SchemaOneOfInput is an input type that accepts SchemaOneOfArgs and SchemaOneOfOutput values. You can construct a concrete instance of `SchemaOneOfInput` via: 

SchemaOneOfArgs{...}

type SchemaOneOfOutput 

type SchemaOneOfOutput struct{ *pulumi.OutputState }

func (SchemaOneOfOutput) Const 

func (o SchemaOneOfOutput) Const() pulumi.StringOutput

value mapping to member of `enum`.

func (SchemaOneOfOutput) ElementType 

func (SchemaOneOfOutput) ElementType() reflect.Type

func (SchemaOneOfOutput) Title 

func (o SchemaOneOfOutput) Title() pulumi.StringOutput

display name for the enum value.

func (SchemaOneOfOutput) ToSchemaOneOfOutput 

func (o SchemaOneOfOutput) ToSchemaOneOfOutput() SchemaOneOfOutput

func (SchemaOneOfOutput) ToSchemaOneOfOutputWithContext 

func (o SchemaOneOfOutput) ToSchemaOneOfOutputWithContext(ctx context.Context) SchemaOneOfOutput

type SchemaOutput 

type SchemaOutput struct{ *pulumi.OutputState }

func (SchemaOutput) ArrayEnums added in v3.9.0 

func (o SchemaOutput) ArrayEnums() pulumi.StringArrayOutput

Array of values that an array property's items can be set to.

func (SchemaOutput) ArrayOneOfs added in v3.9.0 

func (o SchemaOutput) ArrayOneOfs() SchemaArrayOneOfArrayOutput

Display name and value an enum array can be set to.

func (SchemaOutput) ArrayType added in v3.9.0 

func (o SchemaOutput) ArrayType() pulumi.StringPtrOutput

The type of the array elements if `type` is set to `"array"`.

func (SchemaOutput) Description added in v3.9.0 

func (o SchemaOutput) Description() pulumi.StringPtrOutput

The description of the user schema property.

func (SchemaOutput) ElementType 

func (SchemaOutput) ElementType() reflect.Type

func (SchemaOutput) Enums added in v3.9.0 

func (o SchemaOutput) Enums() pulumi.StringArrayOutput

Array of values a primitive property can be set to. See `arrayEnum` for arrays.

func (SchemaOutput) ExternalName added in v3.9.0 

func (o SchemaOutput) ExternalName() pulumi.StringPtrOutput

External name of the user schema property.

func (SchemaOutput) ExternalNamespace added in v3.9.0 

func (o SchemaOutput) ExternalNamespace() pulumi.StringPtrOutput

External name of the user schema property.

func (SchemaOutput) Index added in v3.9.0 

func (o SchemaOutput) Index() pulumi.StringOutput

The property name.

func (SchemaOutput) Master added in v3.9.0 

func (o SchemaOutput) Master() pulumi.StringPtrOutput

Master priority for the user schema property. It can be set to `"PROFILE_MASTER"`, `"OVERRIDE"` or `"OKTA"`.

func (SchemaOutput) MasterOverridePriorities added in v3.9.0 

func (o SchemaOutput) MasterOverridePriorities() SchemaMasterOverridePriorityArrayOutput

Prioritized list of profile sources (required when `master` is `"OVERRIDE"`).

func (SchemaOutput) MaxLength added in v3.9.0 

func (o SchemaOutput) MaxLength() pulumi.IntPtrOutput

The maximum length of the user property value. Only applies to type `"string"`.

func (SchemaOutput) MinLength added in v3.9.0 

func (o SchemaOutput) MinLength() pulumi.IntPtrOutput

The minimum length of the user property value. Only applies to type `"string"`.

func (SchemaOutput) OneOfs added in v3.9.0 

func (o SchemaOutput) OneOfs() SchemaOneOfArrayOutput

Array of maps containing a mapping for display name to enum value.

func (SchemaOutput) Pattern added in v3.9.0 

func (o SchemaOutput) Pattern() pulumi.StringPtrOutput

The validation pattern to use for the subschema. Must be in form of '.+', or '[<pattern>]+' if present.'

func (SchemaOutput) Permissions added in v3.9.0 

func (o SchemaOutput) Permissions() pulumi.StringPtrOutput

Access control permissions for the property. It can be set to `"READ_WRITE"`, `"READ_ONLY"`, `"HIDE"`.

func (SchemaOutput) Required added in v3.9.0 

func (o SchemaOutput) Required() pulumi.BoolPtrOutput

Whether the property is required for this application's users.

func (SchemaOutput) Scope added in v3.9.0 

func (o SchemaOutput) Scope() pulumi.StringPtrOutput

determines whether an app user attribute can be set at the Individual or Group Level.

func (SchemaOutput) Title added in v3.9.0 

func (o SchemaOutput) Title() pulumi.StringOutput

display name for the enum value.

func (SchemaOutput) ToSchemaOutput 

func (o SchemaOutput) ToSchemaOutput() SchemaOutput

func (SchemaOutput) ToSchemaOutputWithContext 

func (o SchemaOutput) ToSchemaOutputWithContext(ctx context.Context) SchemaOutput

func (SchemaOutput) Type added in v3.9.0 

func (o SchemaOutput) Type() pulumi.StringOutput

Type of profile source.

func (SchemaOutput) Unique added in v3.9.0 

func (o SchemaOutput) Unique() pulumi.StringPtrOutput

Whether the property should be unique. It can be set to `"UNIQUE_VALIDATED"` or `"NOT_UNIQUE"`.

func (SchemaOutput) UserType added in v3.9.0 

func (o SchemaOutput) UserType() pulumi.StringPtrOutput

User type ID

type SchemaState 

type SchemaState struct {
	// Array of values that an array property's items can be set to.
	ArrayEnums pulumi.StringArrayInput
	// Display name and value an enum array can be set to.
	ArrayOneOfs SchemaArrayOneOfArrayInput
	// The type of the array elements if `type` is set to `"array"`.
	ArrayType pulumi.StringPtrInput
	// The description of the user schema property.
	Description pulumi.StringPtrInput
	// Array of values a primitive property can be set to. See `arrayEnum` for arrays.
	Enums pulumi.StringArrayInput
	// External name of the user schema property.
	ExternalName pulumi.StringPtrInput
	// External name of the user schema property.
	ExternalNamespace pulumi.StringPtrInput
	// The property name.
	Index pulumi.StringPtrInput
	// Master priority for the user schema property. It can be set to `"PROFILE_MASTER"`, `"OVERRIDE"` or `"OKTA"`.
	Master pulumi.StringPtrInput
	// Prioritized list of profile sources (required when `master` is `"OVERRIDE"`).
	MasterOverridePriorities SchemaMasterOverridePriorityArrayInput
	// The maximum length of the user property value. Only applies to type `"string"`.
	MaxLength pulumi.IntPtrInput
	// The minimum length of the user property value. Only applies to type `"string"`.
	MinLength pulumi.IntPtrInput
	// Array of maps containing a mapping for display name to enum value.
	OneOfs SchemaOneOfArrayInput
	// The validation pattern to use for the subschema. Must be in form of '.+', or '[<pattern>]+' if present.'
	Pattern pulumi.StringPtrInput
	// Access control permissions for the property. It can be set to `"READ_WRITE"`, `"READ_ONLY"`, `"HIDE"`.
	Permissions pulumi.StringPtrInput
	// Whether the property is required for this application's users.
	Required pulumi.BoolPtrInput
	// determines whether an app user attribute can be set at the Individual or Group Level.
	Scope pulumi.StringPtrInput
	// display name for the enum value.
	Title pulumi.StringPtrInput
	// Type of profile source.
	Type pulumi.StringPtrInput
	// Whether the property should be unique. It can be set to `"UNIQUE_VALIDATED"` or `"NOT_UNIQUE"`.
	Unique pulumi.StringPtrInput
	// User type ID
	UserType pulumi.StringPtrInput
}

func (SchemaState) ElementType 

func (SchemaState) ElementType() reflect.Type

type User 

type User struct {
	pulumi.CustomResourceState

	// Administrator roles assigned to User.
	//
	// Deprecated: The `admin_roles` field is now deprecated for the resource `okta_user`, please replace all uses of this with: `okta_user_admin_roles`
	AdminRoles pulumi.StringArrayOutput `pulumi:"adminRoles"`
	// User profile property.
	City pulumi.StringPtrOutput `pulumi:"city"`
	// User profile property.
	CostCenter pulumi.StringPtrOutput `pulumi:"costCenter"`
	// User profile property.
	CountryCode pulumi.StringPtrOutput `pulumi:"countryCode"`
	// raw JSON containing all custom profile attributes.
	CustomProfileAttributes pulumi.StringOutput `pulumi:"customProfileAttributes"`
	// List of custom_profile_attribute keys that should be excluded from being managed by Terraform.
	CustomProfileAttributesToIgnores pulumi.StringArrayOutput `pulumi:"customProfileAttributesToIgnores"`
	// User profile property.
	Department pulumi.StringPtrOutput `pulumi:"department"`
	// User profile property.
	DisplayName pulumi.StringPtrOutput `pulumi:"displayName"`
	// User profile property.
	Division pulumi.StringPtrOutput `pulumi:"division"`
	// User profile property.
	Email pulumi.StringOutput `pulumi:"email"`
	// User profile property.
	EmployeeNumber pulumi.StringPtrOutput `pulumi:"employeeNumber"`
	// If set to `true`, the user will have to change the password at the next login. This property will be used
	// when user is being created and works only when `password` field is set. Default is `false`.
	ExpirePasswordOnCreate pulumi.BoolPtrOutput `pulumi:"expirePasswordOnCreate"`
	// User's First Name, required by default.
	FirstName pulumi.StringOutput `pulumi:"firstName"`
	// User profile property.
	//
	// Deprecated: The `group_memberships` field is now deprecated for the resource `okta_user`, please replace all uses of this with: `okta_user_group_memberships`
	GroupMemberships pulumi.StringArrayOutput `pulumi:"groupMemberships"`
	// User profile property.
	HonorificPrefix pulumi.StringPtrOutput `pulumi:"honorificPrefix"`
	// User profile property.
	HonorificSuffix pulumi.StringPtrOutput `pulumi:"honorificSuffix"`
	// User's Last Name, required by default.
	LastName pulumi.StringOutput `pulumi:"lastName"`
	// User profile property.
	Locale pulumi.StringPtrOutput `pulumi:"locale"`
	// User profile property.
	Login pulumi.StringOutput `pulumi:"login"`
	// User profile property.
	Manager pulumi.StringPtrOutput `pulumi:"manager"`
	// User profile property.
	ManagerId pulumi.StringPtrOutput `pulumi:"managerId"`
	// User profile property.
	MiddleName pulumi.StringPtrOutput `pulumi:"middleName"`
	// User profile property.
	MobilePhone pulumi.StringPtrOutput `pulumi:"mobilePhone"`
	// User profile property.
	NickName pulumi.StringPtrOutput `pulumi:"nickName"`
	// Old user password. **IMPORTANT**: Should be ONLY set in case the password was changed
	// outside the provider. After successful password change this field should be removed and `password` field should be used
	// for further changes.
	OldPassword pulumi.StringPtrOutput `pulumi:"oldPassword"`
	// User profile property.
	Organization pulumi.StringPtrOutput `pulumi:"organization"`
	// User password.
	Password pulumi.StringPtrOutput `pulumi:"password"`
	// Specifies a hashed password to import into Okta.
	PasswordHash UserPasswordHashPtrOutput `pulumi:"passwordHash"`
	// Specifies that a Password Import Inline Hook should be triggered to handle verification
	// of the user's password the first time the user logs in. This allows an existing password to be imported into Okta directly
	// from some other store. When updating a user with a password hook the user must be in the `STAGED` status. The `password`
	// field should not be specified when using Password Import Inline Hook.
	PasswordInlineHook pulumi.StringPtrOutput `pulumi:"passwordInlineHook"`
	// User profile property.
	PostalAddress pulumi.StringPtrOutput `pulumi:"postalAddress"`
	// User profile property.
	PreferredLanguage pulumi.StringPtrOutput `pulumi:"preferredLanguage"`
	// User profile property.
	PrimaryPhone pulumi.StringPtrOutput `pulumi:"primaryPhone"`
	// User profile property.
	ProfileUrl pulumi.StringPtrOutput `pulumi:"profileUrl"`
	// The raw status of the User in Okta - (status is mapped)
	RawStatus pulumi.StringOutput `pulumi:"rawStatus"`
	// User password recovery answer.
	RecoveryAnswer pulumi.StringPtrOutput `pulumi:"recoveryAnswer"`
	// User password recovery question.
	RecoveryQuestion pulumi.StringPtrOutput `pulumi:"recoveryQuestion"`
	// User profile property.
	SecondEmail pulumi.StringPtrOutput `pulumi:"secondEmail"`
	// Additional API call to collect user's roles will not be made. `adminRoles` will not be written to state if skipping roles.
	SkipRoles pulumi.BoolPtrOutput `pulumi:"skipRoles"`
	// User profile property.
	State pulumi.StringPtrOutput `pulumi:"state"`
	// User profile property. Valid values are "ACTIVE", "DEPROVISIONED", "STAGED", "SUSPENDED"
	Status pulumi.StringPtrOutput `pulumi:"status"`
	// User profile property.
	StreetAddress pulumi.StringPtrOutput `pulumi:"streetAddress"`
	// User profile property.
	Timezone pulumi.StringPtrOutput `pulumi:"timezone"`
	// User profile property.
	Title pulumi.StringPtrOutput `pulumi:"title"`
	// User profile property.
	UserType pulumi.StringPtrOutput `pulumi:"userType"`
	// User profile property.
	ZipCode pulumi.StringPtrOutput `pulumi:"zipCode"`
}

Creates an Okta User.

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

> **IMPORTANT** If the provider is executed with a non-super user API token a 403 occurs when the provider attempts to inspect the user's admin roles. This 403 is swallowed and a warning is logged allowing the resource to continue without this error hindering it. An empty `adminRoles` array will be present in the resource state.

> **IMPORTANT** Use `skip_roles=true` to avoid `adminRoles` being present in resource state. This also prevents the underlying API call for those values to be made.

## Example Usage

Full profile:

```go package main

import ( 

"github.com/pulumi/pulumi-okta/sdk/v3/go/okta/user"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"

) 

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := user.NewUser(ctx, "example", &user.UserArgs{
			City:              pulumi.String("New York"),
			CostCenter:        pulumi.String("10"),
			CountryCode:       pulumi.String("US"),
			Department:        pulumi.String("IT"),
			DisplayName:       pulumi.String("Dr. John Smith"),
			Division:          pulumi.String("Acquisitions"),
			Email:             pulumi.String("john.smith@example.com"),
			EmployeeNumber:    pulumi.String("111111"),
			FirstName:         pulumi.String("John"),
			HonorificPrefix:   pulumi.String("Dr."),
			HonorificSuffix:   pulumi.String("Jr."),
			LastName:          pulumi.String("Smith"),
			Locale:            pulumi.String("en_US"),
			Login:             pulumi.String("john.smith@example.com"),
			Manager:           pulumi.String("Jimbo"),
			ManagerId:         pulumi.String("222222"),
			MiddleName:        pulumi.String("John"),
			MobilePhone:       pulumi.String("1112223333"),
			NickName:          pulumi.String("Johnny"),
			Organization:      pulumi.String("Testing Inc."),
			PostalAddress:     pulumi.String("1234 Testing St."),
			PreferredLanguage: pulumi.String("en-us"),
			PrimaryPhone:      pulumi.String("4445556666"),
			ProfileUrl:        pulumi.String("https://www.example.com/profile"),
			SecondEmail:       pulumi.String("john.smith.fun@example.com"),
			State:             pulumi.String("NY"),
			StreetAddress:     pulumi.String("5678 Testing Ave."),
			Timezone:          pulumi.String("America/New_York"),
			Title:             pulumi.String("Director"),
			UserType:          pulumi.String("Employee"),
			ZipCode:           pulumi.String("11111"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

```

With Password Inline Hook:

```go package main

import ( 

"github.com/pulumi/pulumi-okta/sdk/v3/go/okta/user"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"

) 

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := user.NewUser(ctx, "test2", &user.UserArgs{
			Email:              pulumi.String("example@example.com"),
			FirstName:          pulumi.String("John"),
			LastName:           pulumi.String("Smith"),
			Login:              pulumi.String("example@example.com"),
			PasswordInlineHook: pulumi.String("default"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

```

## Import

An Okta User can be imported via the ID.

```sh 

$ pulumi import okta:user/user:User example &#60;user id&#62;

```

func GetUser 

func GetUser(ctx *pulumi.Context,
	name string, id pulumi.IDInput, state *UserState, opts ...pulumi.ResourceOption) (*User, error)

GetUser gets an existing User 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 NewUser 

func NewUser(ctx *pulumi.Context,
	name string, args *UserArgs, opts ...pulumi.ResourceOption) (*User, error)

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

func (*User) ElementType 

func (*User) ElementType() reflect.Type

func (*User) ToUserOutput 

func (i *User) ToUserOutput() UserOutput

func (*User) ToUserOutputWithContext 

func (i *User) ToUserOutputWithContext(ctx context.Context) UserOutput

type UserArgs 

type UserArgs struct {
	// Administrator roles assigned to User.
	//
	// Deprecated: The `admin_roles` field is now deprecated for the resource `okta_user`, please replace all uses of this with: `okta_user_admin_roles`
	AdminRoles pulumi.StringArrayInput
	// User profile property.
	City pulumi.StringPtrInput
	// User profile property.
	CostCenter pulumi.StringPtrInput
	// User profile property.
	CountryCode pulumi.StringPtrInput
	// raw JSON containing all custom profile attributes.
	CustomProfileAttributes pulumi.StringPtrInput
	// List of custom_profile_attribute keys that should be excluded from being managed by Terraform.
	CustomProfileAttributesToIgnores pulumi.StringArrayInput
	// User profile property.
	Department pulumi.StringPtrInput
	// User profile property.
	DisplayName pulumi.StringPtrInput
	// User profile property.
	Division pulumi.StringPtrInput
	// User profile property.
	Email pulumi.StringInput
	// User profile property.
	EmployeeNumber pulumi.StringPtrInput
	// If set to `true`, the user will have to change the password at the next login. This property will be used
	// when user is being created and works only when `password` field is set. Default is `false`.
	ExpirePasswordOnCreate pulumi.BoolPtrInput
	// User's First Name, required by default.
	FirstName pulumi.StringInput
	// User profile property.
	//
	// Deprecated: The `group_memberships` field is now deprecated for the resource `okta_user`, please replace all uses of this with: `okta_user_group_memberships`
	GroupMemberships pulumi.StringArrayInput
	// User profile property.
	HonorificPrefix pulumi.StringPtrInput
	// User profile property.
	HonorificSuffix pulumi.StringPtrInput
	// User's Last Name, required by default.
	LastName pulumi.StringInput
	// User profile property.
	Locale pulumi.StringPtrInput
	// User profile property.
	Login pulumi.StringInput
	// User profile property.
	Manager pulumi.StringPtrInput
	// User profile property.
	ManagerId pulumi.StringPtrInput
	// User profile property.
	MiddleName pulumi.StringPtrInput
	// User profile property.
	MobilePhone pulumi.StringPtrInput
	// User profile property.
	NickName pulumi.StringPtrInput
	// Old user password. **IMPORTANT**: Should be ONLY set in case the password was changed
	// outside the provider. After successful password change this field should be removed and `password` field should be used
	// for further changes.
	OldPassword pulumi.StringPtrInput
	// User profile property.
	Organization pulumi.StringPtrInput
	// User password.
	Password pulumi.StringPtrInput
	// Specifies a hashed password to import into Okta.
	PasswordHash UserPasswordHashPtrInput
	// Specifies that a Password Import Inline Hook should be triggered to handle verification
	// of the user's password the first time the user logs in. This allows an existing password to be imported into Okta directly
	// from some other store. When updating a user with a password hook the user must be in the `STAGED` status. The `password`
	// field should not be specified when using Password Import Inline Hook.
	PasswordInlineHook pulumi.StringPtrInput
	// User profile property.
	PostalAddress pulumi.StringPtrInput
	// User profile property.
	PreferredLanguage pulumi.StringPtrInput
	// User profile property.
	PrimaryPhone pulumi.StringPtrInput
	// User profile property.
	ProfileUrl pulumi.StringPtrInput
	// User password recovery answer.
	RecoveryAnswer pulumi.StringPtrInput
	// User password recovery question.
	RecoveryQuestion pulumi.StringPtrInput
	// User profile property.
	SecondEmail pulumi.StringPtrInput
	// Additional API call to collect user's roles will not be made. `adminRoles` will not be written to state if skipping roles.
	SkipRoles pulumi.BoolPtrInput
	// User profile property.
	State pulumi.StringPtrInput
	// User profile property. Valid values are "ACTIVE", "DEPROVISIONED", "STAGED", "SUSPENDED"
	Status pulumi.StringPtrInput
	// User profile property.
	StreetAddress pulumi.StringPtrInput
	// User profile property.
	Timezone pulumi.StringPtrInput
	// User profile property.
	Title pulumi.StringPtrInput
	// User profile property.
	UserType pulumi.StringPtrInput
	// User profile property.
	ZipCode pulumi.StringPtrInput
}

The set of arguments for constructing a User resource.

func (UserArgs) ElementType 

func (UserArgs) ElementType() reflect.Type

type UserArray 

type UserArray []UserInput

func (UserArray) ElementType 

func (UserArray) ElementType() reflect.Type

func (UserArray) ToUserArrayOutput 

func (i UserArray) ToUserArrayOutput() UserArrayOutput

func (UserArray) ToUserArrayOutputWithContext 

func (i UserArray) ToUserArrayOutputWithContext(ctx context.Context) UserArrayOutput

type UserArrayInput 

type UserArrayInput interface {
	pulumi.Input

	ToUserArrayOutput() UserArrayOutput
	ToUserArrayOutputWithContext(context.Context) UserArrayOutput
}

UserArrayInput is an input type that accepts UserArray and UserArrayOutput values. You can construct a concrete instance of `UserArrayInput` via: 

UserArray{ UserArgs{...} }

type UserArrayOutput 

type UserArrayOutput struct{ *pulumi.OutputState }

func (UserArrayOutput) ElementType 

func (UserArrayOutput) ElementType() reflect.Type

func (UserArrayOutput) Index 

func (o UserArrayOutput) Index(i pulumi.IntInput) UserOutput

func (UserArrayOutput) ToUserArrayOutput 

func (o UserArrayOutput) ToUserArrayOutput() UserArrayOutput

func (UserArrayOutput) ToUserArrayOutputWithContext 

func (o UserArrayOutput) ToUserArrayOutputWithContext(ctx context.Context) UserArrayOutput

type UserInput 

type UserInput interface {
	pulumi.Input

	ToUserOutput() UserOutput
	ToUserOutputWithContext(ctx context.Context) UserOutput
}

type UserMap 

type UserMap map[string]UserInput

func (UserMap) ElementType 

func (UserMap) ElementType() reflect.Type

func (UserMap) ToUserMapOutput 

func (i UserMap) ToUserMapOutput() UserMapOutput

func (UserMap) ToUserMapOutputWithContext 

func (i UserMap) ToUserMapOutputWithContext(ctx context.Context) UserMapOutput

type UserMapInput 

type UserMapInput interface {
	pulumi.Input

	ToUserMapOutput() UserMapOutput
	ToUserMapOutputWithContext(context.Context) UserMapOutput
}

UserMapInput is an input type that accepts UserMap and UserMapOutput values. You can construct a concrete instance of `UserMapInput` via: 

UserMap{ "key": UserArgs{...} }

type UserMapOutput 

type UserMapOutput struct{ *pulumi.OutputState }

func (UserMapOutput) ElementType 

func (UserMapOutput) ElementType() reflect.Type

func (UserMapOutput) MapIndex 

func (o UserMapOutput) MapIndex(k pulumi.StringInput) UserOutput

func (UserMapOutput) ToUserMapOutput 

func (o UserMapOutput) ToUserMapOutput() UserMapOutput

func (UserMapOutput) ToUserMapOutputWithContext 

func (o UserMapOutput) ToUserMapOutputWithContext(ctx context.Context) UserMapOutput

type UserOutput 

type UserOutput struct{ *pulumi.OutputState }

func (UserOutput) AdminRoles deprecated added in v3.9.0 

func (o UserOutput) AdminRoles() pulumi.StringArrayOutput

Administrator roles assigned to User.

Deprecated: The `admin_roles` field is now deprecated for the resource `okta_user`, please replace all uses of this with: `okta_user_admin_roles`

func (UserOutput) City added in v3.9.0 

func (o UserOutput) City() pulumi.StringPtrOutput

User profile property.

func (UserOutput) CostCenter added in v3.9.0 

func (o UserOutput) CostCenter() pulumi.StringPtrOutput

User profile property.

func (UserOutput) CountryCode added in v3.9.0 

func (o UserOutput) CountryCode() pulumi.StringPtrOutput

User profile property.

func (UserOutput) CustomProfileAttributes added in v3.9.0 

func (o UserOutput) CustomProfileAttributes() pulumi.StringOutput

raw JSON containing all custom profile attributes.

func (UserOutput) CustomProfileAttributesToIgnores added in v3.20.0 

func (o UserOutput) CustomProfileAttributesToIgnores() pulumi.StringArrayOutput

List of custom_profile_attribute keys that should be excluded from being managed by Terraform.

func (UserOutput) Department added in v3.9.0 

func (o UserOutput) Department() pulumi.StringPtrOutput

User profile property.

func (UserOutput) DisplayName added in v3.9.0 

func (o UserOutput) DisplayName() pulumi.StringPtrOutput

User profile property.

func (UserOutput) Division added in v3.9.0 

func (o UserOutput) Division() pulumi.StringPtrOutput

User profile property.

func (UserOutput) ElementType 

func (UserOutput) ElementType() reflect.Type

func (UserOutput) Email added in v3.9.0 

func (o UserOutput) Email() pulumi.StringOutput

User profile property.

func (UserOutput) EmployeeNumber added in v3.9.0 

func (o UserOutput) EmployeeNumber() pulumi.StringPtrOutput

User profile property.

func (UserOutput) ExpirePasswordOnCreate added in v3.9.0 

func (o UserOutput) ExpirePasswordOnCreate() pulumi.BoolPtrOutput

If set to `true`, the user will have to change the password at the next login. This property will be used when user is being created and works only when `password` field is set. Default is `false`.

func (UserOutput) FirstName added in v3.9.0 

func (o UserOutput) FirstName() pulumi.StringOutput

User's First Name, required by default.

func (UserOutput) GroupMemberships deprecated added in v3.9.0 

func (o UserOutput) GroupMemberships() pulumi.StringArrayOutput

User profile property.

Deprecated: The `group_memberships` field is now deprecated for the resource `okta_user`, please replace all uses of this with: `okta_user_group_memberships`

func (UserOutput) HonorificPrefix added in v3.9.0 

func (o UserOutput) HonorificPrefix() pulumi.StringPtrOutput

User profile property.

func (UserOutput) HonorificSuffix added in v3.9.0 

func (o UserOutput) HonorificSuffix() pulumi.StringPtrOutput

User profile property.

func (UserOutput) LastName added in v3.9.0 

func (o UserOutput) LastName() pulumi.StringOutput

User's Last Name, required by default.

func (UserOutput) Locale added in v3.9.0 

func (o UserOutput) Locale() pulumi.StringPtrOutput

User profile property.

func (UserOutput) Login added in v3.9.0 

func (o UserOutput) Login() pulumi.StringOutput

User profile property.

func (UserOutput) Manager added in v3.9.0 

func (o UserOutput) Manager() pulumi.StringPtrOutput

User profile property.

func (UserOutput) ManagerId added in v3.9.0 

func (o UserOutput) ManagerId() pulumi.StringPtrOutput

User profile property.

func (UserOutput) MiddleName added in v3.9.0 

func (o UserOutput) MiddleName() pulumi.StringPtrOutput

User profile property.

func (UserOutput) MobilePhone added in v3.9.0 

func (o UserOutput) MobilePhone() pulumi.StringPtrOutput

User profile property.

func (UserOutput) NickName added in v3.9.0 

func (o UserOutput) NickName() pulumi.StringPtrOutput

User profile property.

func (UserOutput) OldPassword added in v3.9.0 

func (o UserOutput) OldPassword() pulumi.StringPtrOutput

Old user password. **IMPORTANT**: Should be ONLY set in case the password was changed outside the provider. After successful password change this field should be removed and `password` field should be used for further changes.

func (UserOutput) Organization added in v3.9.0 

func (o UserOutput) Organization() pulumi.StringPtrOutput

User profile property.

func (UserOutput) Password added in v3.9.0 

func (o UserOutput) Password() pulumi.StringPtrOutput

User password.

func (UserOutput) PasswordHash added in v3.9.0 

func (o UserOutput) PasswordHash() UserPasswordHashPtrOutput

Specifies a hashed password to import into Okta.

func (UserOutput) PasswordInlineHook added in v3.9.0 

func (o UserOutput) PasswordInlineHook() pulumi.StringPtrOutput

Specifies that a Password Import Inline Hook should be triggered to handle verification of the user's password the first time the user logs in. This allows an existing password to be imported into Okta directly from some other store. When updating a user with a password hook the user must be in the `STAGED` status. The `password` field should not be specified when using Password Import Inline Hook.

func (UserOutput) PostalAddress added in v3.9.0 

func (o UserOutput) PostalAddress() pulumi.StringPtrOutput

User profile property.

func (UserOutput) PreferredLanguage added in v3.9.0 

func (o UserOutput) PreferredLanguage() pulumi.StringPtrOutput

User profile property.

func (UserOutput) PrimaryPhone added in v3.9.0 

func (o UserOutput) PrimaryPhone() pulumi.StringPtrOutput

User profile property.

func (UserOutput) ProfileUrl added in v3.9.0 

func (o UserOutput) ProfileUrl() pulumi.StringPtrOutput

User profile property.

func (UserOutput) RawStatus added in v3.9.0 

func (o UserOutput) RawStatus() pulumi.StringOutput

The raw status of the User in Okta - (status is mapped)

func (UserOutput) RecoveryAnswer added in v3.9.0 

func (o UserOutput) RecoveryAnswer() pulumi.StringPtrOutput

User password recovery answer.

func (UserOutput) RecoveryQuestion added in v3.9.0 

func (o UserOutput) RecoveryQuestion() pulumi.StringPtrOutput

User password recovery question.

func (UserOutput) SecondEmail added in v3.9.0 

func (o UserOutput) SecondEmail() pulumi.StringPtrOutput

User profile property.

func (UserOutput) SkipRoles added in v3.18.0 

func (o UserOutput) SkipRoles() pulumi.BoolPtrOutput

Additional API call to collect user's roles will not be made. `adminRoles` will not be written to state if skipping roles.

func (UserOutput) State added in v3.9.0 

func (o UserOutput) State() pulumi.StringPtrOutput

User profile property.

func (UserOutput) Status added in v3.9.0 

func (o UserOutput) Status() pulumi.StringPtrOutput

User profile property. Valid values are "ACTIVE", "DEPROVISIONED", "STAGED", "SUSPENDED"

func (UserOutput) StreetAddress added in v3.9.0 

func (o UserOutput) StreetAddress() pulumi.StringPtrOutput

User profile property.

func (UserOutput) Timezone added in v3.9.0 

func (o UserOutput) Timezone() pulumi.StringPtrOutput

User profile property.

func (UserOutput) Title added in v3.9.0 

func (o UserOutput) Title() pulumi.StringPtrOutput

User profile property.

func (UserOutput) ToUserOutput 

func (o UserOutput) ToUserOutput() UserOutput

func (UserOutput) ToUserOutputWithContext 

func (o UserOutput) ToUserOutputWithContext(ctx context.Context) UserOutput

func (UserOutput) UserType added in v3.9.0 

func (o UserOutput) UserType() pulumi.StringPtrOutput

User profile property.

func (UserOutput) ZipCode added in v3.9.0 

func (o UserOutput) ZipCode() pulumi.StringPtrOutput

User profile property.

type UserPasswordHash added in v3.2.0 

type UserPasswordHash struct {
	Algorithm string `pulumi:"algorithm"`
	// Only required for salted hashes. For BCRYPT, this specifies the radix64-encoded salt used to generate
	// the hash, which must be 22 characters long. For other salted hashes, this specifies the base64-encoded salt used to generate the hash.
	Salt *string `pulumi:"salt"`
	// Specifies whether salt was pre- or postfixed to the password before hashing. Only required for salted algorithms.
	SaltOrder *string `pulumi:"saltOrder"`
	// For SHA-512, SHA-256, SHA-1, MD5, this is the actual base64-encoded hash of the password (and salt, if used).
	// This is the Base64 encoded value of the SHA-512/SHA-256/SHA-1/MD5 digest that was computed by either pre-fixing or post-fixing
	// the salt to the password, depending on the saltOrder. If a salt was not used in the source system, then this should just be
	// the Base64 encoded value of the password's SHA-512/SHA-256/SHA-1/MD5 digest. For BCRYPT, This is the actual radix64-encoded hashed password.
	Value string `pulumi:"value"`
	// Governs the strength of the hash and the time required to compute it. Only required for BCRYPT algorithm. Minimum value is 1, and maximum is 20.
	WorkFactor *int `pulumi:"workFactor"`
}

type UserPasswordHashArgs added in v3.2.0 

type UserPasswordHashArgs struct {
	Algorithm pulumi.StringInput `pulumi:"algorithm"`
	// Only required for salted hashes. For BCRYPT, this specifies the radix64-encoded salt used to generate
	// the hash, which must be 22 characters long. For other salted hashes, this specifies the base64-encoded salt used to generate the hash.
	Salt pulumi.StringPtrInput `pulumi:"salt"`
	// Specifies whether salt was pre- or postfixed to the password before hashing. Only required for salted algorithms.
	SaltOrder pulumi.StringPtrInput `pulumi:"saltOrder"`
	// For SHA-512, SHA-256, SHA-1, MD5, this is the actual base64-encoded hash of the password (and salt, if used).
	// This is the Base64 encoded value of the SHA-512/SHA-256/SHA-1/MD5 digest that was computed by either pre-fixing or post-fixing
	// the salt to the password, depending on the saltOrder. If a salt was not used in the source system, then this should just be
	// the Base64 encoded value of the password's SHA-512/SHA-256/SHA-1/MD5 digest. For BCRYPT, This is the actual radix64-encoded hashed password.
	Value pulumi.StringInput `pulumi:"value"`
	// Governs the strength of the hash and the time required to compute it. Only required for BCRYPT algorithm. Minimum value is 1, and maximum is 20.
	WorkFactor pulumi.IntPtrInput `pulumi:"workFactor"`
}

func (UserPasswordHashArgs) ElementType added in v3.2.0 

func (UserPasswordHashArgs) ElementType() reflect.Type

func (UserPasswordHashArgs) ToUserPasswordHashOutput added in v3.2.0 

func (i UserPasswordHashArgs) ToUserPasswordHashOutput() UserPasswordHashOutput

func (UserPasswordHashArgs) ToUserPasswordHashOutputWithContext added in v3.2.0 

func (i UserPasswordHashArgs) ToUserPasswordHashOutputWithContext(ctx context.Context) UserPasswordHashOutput

func (UserPasswordHashArgs) ToUserPasswordHashPtrOutput added in v3.2.0 

func (i UserPasswordHashArgs) ToUserPasswordHashPtrOutput() UserPasswordHashPtrOutput

func (UserPasswordHashArgs) ToUserPasswordHashPtrOutputWithContext added in v3.2.0 

func (i UserPasswordHashArgs) ToUserPasswordHashPtrOutputWithContext(ctx context.Context) UserPasswordHashPtrOutput

type UserPasswordHashInput added in v3.2.0 

type UserPasswordHashInput interface {
	pulumi.Input

	ToUserPasswordHashOutput() UserPasswordHashOutput
	ToUserPasswordHashOutputWithContext(context.Context) UserPasswordHashOutput
}

UserPasswordHashInput is an input type that accepts UserPasswordHashArgs and UserPasswordHashOutput values. You can construct a concrete instance of `UserPasswordHashInput` via: 

UserPasswordHashArgs{...}

type UserPasswordHashOutput added in v3.2.0 

type UserPasswordHashOutput struct{ *pulumi.OutputState }

func (UserPasswordHashOutput) Algorithm added in v3.2.0 

func (o UserPasswordHashOutput) Algorithm() pulumi.StringOutput

func (UserPasswordHashOutput) ElementType added in v3.2.0 

func (UserPasswordHashOutput) ElementType() reflect.Type

func (UserPasswordHashOutput) Salt added in v3.2.0 

func (o UserPasswordHashOutput) Salt() pulumi.StringPtrOutput

Only required for salted hashes. For BCRYPT, this specifies the radix64-encoded salt used to generate the hash, which must be 22 characters long. For other salted hashes, this specifies the base64-encoded salt used to generate the hash.

func (UserPasswordHashOutput) SaltOrder added in v3.2.0 

func (o UserPasswordHashOutput) SaltOrder() pulumi.StringPtrOutput

Specifies whether salt was pre- or postfixed to the password before hashing. Only required for salted algorithms.

func (UserPasswordHashOutput) ToUserPasswordHashOutput added in v3.2.0 

func (o UserPasswordHashOutput) ToUserPasswordHashOutput() UserPasswordHashOutput

func (UserPasswordHashOutput) ToUserPasswordHashOutputWithContext added in v3.2.0 

func (o UserPasswordHashOutput) ToUserPasswordHashOutputWithContext(ctx context.Context) UserPasswordHashOutput

func (UserPasswordHashOutput) ToUserPasswordHashPtrOutput added in v3.2.0 

func (o UserPasswordHashOutput) ToUserPasswordHashPtrOutput() UserPasswordHashPtrOutput

func (UserPasswordHashOutput) ToUserPasswordHashPtrOutputWithContext added in v3.2.0 

func (o UserPasswordHashOutput) ToUserPasswordHashPtrOutputWithContext(ctx context.Context) UserPasswordHashPtrOutput

func (UserPasswordHashOutput) Value added in v3.2.0 

func (o UserPasswordHashOutput) Value() pulumi.StringOutput

For SHA-512, SHA-256, SHA-1, MD5, this is the actual base64-encoded hash of the password (and salt, if used). This is the Base64 encoded value of the SHA-512/SHA-256/SHA-1/MD5 digest that was computed by either pre-fixing or post-fixing the salt to the password, depending on the saltOrder. If a salt was not used in the source system, then this should just be the Base64 encoded value of the password's SHA-512/SHA-256/SHA-1/MD5 digest. For BCRYPT, This is the actual radix64-encoded hashed password.

func (UserPasswordHashOutput) WorkFactor added in v3.2.0 

func (o UserPasswordHashOutput) WorkFactor() pulumi.IntPtrOutput

Governs the strength of the hash and the time required to compute it. Only required for BCRYPT algorithm. Minimum value is 1, and maximum is 20.

type UserPasswordHashPtrInput added in v3.2.0 

type UserPasswordHashPtrInput interface {
	pulumi.Input

	ToUserPasswordHashPtrOutput() UserPasswordHashPtrOutput
	ToUserPasswordHashPtrOutputWithContext(context.Context) UserPasswordHashPtrOutput
}

UserPasswordHashPtrInput is an input type that accepts UserPasswordHashArgs, UserPasswordHashPtr and UserPasswordHashPtrOutput values. You can construct a concrete instance of `UserPasswordHashPtrInput` via: 

        UserPasswordHashArgs{...}

or:

        nil

func UserPasswordHashPtr added in v3.2.0 

func UserPasswordHashPtr(v *UserPasswordHashArgs) UserPasswordHashPtrInput

type UserPasswordHashPtrOutput added in v3.2.0 

type UserPasswordHashPtrOutput struct{ *pulumi.OutputState }

func (UserPasswordHashPtrOutput) Algorithm added in v3.2.0 

func (o UserPasswordHashPtrOutput) Algorithm() pulumi.StringPtrOutput

func (UserPasswordHashPtrOutput) Elem added in v3.2.0 

func (o UserPasswordHashPtrOutput) Elem() UserPasswordHashOutput

func (UserPasswordHashPtrOutput) ElementType added in v3.2.0 

func (UserPasswordHashPtrOutput) ElementType() reflect.Type

func (UserPasswordHashPtrOutput) Salt added in v3.2.0 

func (o UserPasswordHashPtrOutput) Salt() pulumi.StringPtrOutput

Only required for salted hashes. For BCRYPT, this specifies the radix64-encoded salt used to generate the hash, which must be 22 characters long. For other salted hashes, this specifies the base64-encoded salt used to generate the hash.

func (UserPasswordHashPtrOutput) SaltOrder added in v3.2.0 

func (o UserPasswordHashPtrOutput) SaltOrder() pulumi.StringPtrOutput

Specifies whether salt was pre- or postfixed to the password before hashing. Only required for salted algorithms.

func (UserPasswordHashPtrOutput) ToUserPasswordHashPtrOutput added in v3.2.0 

func (o UserPasswordHashPtrOutput) ToUserPasswordHashPtrOutput() UserPasswordHashPtrOutput

func (UserPasswordHashPtrOutput) ToUserPasswordHashPtrOutputWithContext added in v3.2.0 

func (o UserPasswordHashPtrOutput) ToUserPasswordHashPtrOutputWithContext(ctx context.Context) UserPasswordHashPtrOutput

func (UserPasswordHashPtrOutput) Value added in v3.2.0 

func (o UserPasswordHashPtrOutput) Value() pulumi.StringPtrOutput

For SHA-512, SHA-256, SHA-1, MD5, this is the actual base64-encoded hash of the password (and salt, if used). This is the Base64 encoded value of the SHA-512/SHA-256/SHA-1/MD5 digest that was computed by either pre-fixing or post-fixing the salt to the password, depending on the saltOrder. If a salt was not used in the source system, then this should just be the Base64 encoded value of the password's SHA-512/SHA-256/SHA-1/MD5 digest. For BCRYPT, This is the actual radix64-encoded hashed password.

func (UserPasswordHashPtrOutput) WorkFactor added in v3.2.0 

func (o UserPasswordHashPtrOutput) WorkFactor() pulumi.IntPtrOutput

Governs the strength of the hash and the time required to compute it. Only required for BCRYPT algorithm. Minimum value is 1, and maximum is 20.

type UserState 

type UserState struct {
	// Administrator roles assigned to User.
	//
	// Deprecated: The `admin_roles` field is now deprecated for the resource `okta_user`, please replace all uses of this with: `okta_user_admin_roles`
	AdminRoles pulumi.StringArrayInput
	// User profile property.
	City pulumi.StringPtrInput
	// User profile property.
	CostCenter pulumi.StringPtrInput
	// User profile property.
	CountryCode pulumi.StringPtrInput
	// raw JSON containing all custom profile attributes.
	CustomProfileAttributes pulumi.StringPtrInput
	// List of custom_profile_attribute keys that should be excluded from being managed by Terraform.
	CustomProfileAttributesToIgnores pulumi.StringArrayInput
	// User profile property.
	Department pulumi.StringPtrInput
	// User profile property.
	DisplayName pulumi.StringPtrInput
	// User profile property.
	Division pulumi.StringPtrInput
	// User profile property.
	Email pulumi.StringPtrInput
	// User profile property.
	EmployeeNumber pulumi.StringPtrInput
	// If set to `true`, the user will have to change the password at the next login. This property will be used
	// when user is being created and works only when `password` field is set. Default is `false`.
	ExpirePasswordOnCreate pulumi.BoolPtrInput
	// User's First Name, required by default.
	FirstName pulumi.StringPtrInput
	// User profile property.
	//
	// Deprecated: The `group_memberships` field is now deprecated for the resource `okta_user`, please replace all uses of this with: `okta_user_group_memberships`
	GroupMemberships pulumi.StringArrayInput
	// User profile property.
	HonorificPrefix pulumi.StringPtrInput
	// User profile property.
	HonorificSuffix pulumi.StringPtrInput
	// User's Last Name, required by default.
	LastName pulumi.StringPtrInput
	// User profile property.
	Locale pulumi.StringPtrInput
	// User profile property.
	Login pulumi.StringPtrInput
	// User profile property.
	Manager pulumi.StringPtrInput
	// User profile property.
	ManagerId pulumi.StringPtrInput
	// User profile property.
	MiddleName pulumi.StringPtrInput
	// User profile property.
	MobilePhone pulumi.StringPtrInput
	// User profile property.
	NickName pulumi.StringPtrInput
	// Old user password. **IMPORTANT**: Should be ONLY set in case the password was changed
	// outside the provider. After successful password change this field should be removed and `password` field should be used
	// for further changes.
	OldPassword pulumi.StringPtrInput
	// User profile property.
	Organization pulumi.StringPtrInput
	// User password.
	Password pulumi.StringPtrInput
	// Specifies a hashed password to import into Okta.
	PasswordHash UserPasswordHashPtrInput
	// Specifies that a Password Import Inline Hook should be triggered to handle verification
	// of the user's password the first time the user logs in. This allows an existing password to be imported into Okta directly
	// from some other store. When updating a user with a password hook the user must be in the `STAGED` status. The `password`
	// field should not be specified when using Password Import Inline Hook.
	PasswordInlineHook pulumi.StringPtrInput
	// User profile property.
	PostalAddress pulumi.StringPtrInput
	// User profile property.
	PreferredLanguage pulumi.StringPtrInput
	// User profile property.
	PrimaryPhone pulumi.StringPtrInput
	// User profile property.
	ProfileUrl pulumi.StringPtrInput
	// The raw status of the User in Okta - (status is mapped)
	RawStatus pulumi.StringPtrInput
	// User password recovery answer.
	RecoveryAnswer pulumi.StringPtrInput
	// User password recovery question.
	RecoveryQuestion pulumi.StringPtrInput
	// User profile property.
	SecondEmail pulumi.StringPtrInput
	// Additional API call to collect user's roles will not be made. `adminRoles` will not be written to state if skipping roles.
	SkipRoles pulumi.BoolPtrInput
	// User profile property.
	State pulumi.StringPtrInput
	// User profile property. Valid values are "ACTIVE", "DEPROVISIONED", "STAGED", "SUSPENDED"
	Status pulumi.StringPtrInput
	// User profile property.
	StreetAddress pulumi.StringPtrInput
	// User profile property.
	Timezone pulumi.StringPtrInput
	// User profile property.
	Title pulumi.StringPtrInput
	// User profile property.
	UserType pulumi.StringPtrInput
	// User profile property.
	ZipCode pulumi.StringPtrInput
}

func (UserState) ElementType 

func (UserState) ElementType() reflect.Type

type UserType 

type UserType struct {
	pulumi.CustomResourceState

	// Description of the User Type.
	Description pulumi.StringOutput `pulumi:"description"`
	// Display Name of the User Type.
	DisplayName pulumi.StringOutput `pulumi:"displayName"`
	// Name of the User Type.
	Name pulumi.StringOutput `pulumi:"name"`
}

Creates a User type.

This resource allows you to create and configure a User Type.

## Example Usage

```go package main

import ( 

"github.com/pulumi/pulumi-okta/sdk/v3/go/okta/user"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"

) 

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := user.NewUserType(ctx, "example", &user.UserTypeArgs{
			Description: pulumi.String("example"),
			DisplayName: pulumi.String("example"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

```

## Import

A User Type can be imported via the Okta ID.

```sh 

$ pulumi import okta:user/userType:UserType example &#60;user type id&#62;

```

func GetUserType 

func GetUserType(ctx *pulumi.Context,
	name string, id pulumi.IDInput, state *UserTypeState, opts ...pulumi.ResourceOption) (*UserType, error)

GetUserType gets an existing UserType 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 NewUserType 

func NewUserType(ctx *pulumi.Context,
	name string, args *UserTypeArgs, opts ...pulumi.ResourceOption) (*UserType, error)

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

func (*UserType) ElementType 

func (*UserType) ElementType() reflect.Type

func (*UserType) ToUserTypeOutput 

func (i *UserType) ToUserTypeOutput() UserTypeOutput

func (*UserType) ToUserTypeOutputWithContext 

func (i *UserType) ToUserTypeOutputWithContext(ctx context.Context) UserTypeOutput

type UserTypeArgs 

type UserTypeArgs struct {
	// Description of the User Type.
	Description pulumi.StringInput
	// Display Name of the User Type.
	DisplayName pulumi.StringInput
	// Name of the User Type.
	Name pulumi.StringPtrInput
}

The set of arguments for constructing a UserType resource.

func (UserTypeArgs) ElementType 

func (UserTypeArgs) ElementType() reflect.Type

type UserTypeArray 

type UserTypeArray []UserTypeInput

func (UserTypeArray) ElementType 

func (UserTypeArray) ElementType() reflect.Type

func (UserTypeArray) ToUserTypeArrayOutput 

func (i UserTypeArray) ToUserTypeArrayOutput() UserTypeArrayOutput

func (UserTypeArray) ToUserTypeArrayOutputWithContext 

func (i UserTypeArray) ToUserTypeArrayOutputWithContext(ctx context.Context) UserTypeArrayOutput

type UserTypeArrayInput 

type UserTypeArrayInput interface {
	pulumi.Input

	ToUserTypeArrayOutput() UserTypeArrayOutput
	ToUserTypeArrayOutputWithContext(context.Context) UserTypeArrayOutput
}

UserTypeArrayInput is an input type that accepts UserTypeArray and UserTypeArrayOutput values. You can construct a concrete instance of `UserTypeArrayInput` via: 

UserTypeArray{ UserTypeArgs{...} }

type UserTypeArrayOutput 

type UserTypeArrayOutput struct{ *pulumi.OutputState }

func (UserTypeArrayOutput) ElementType 

func (UserTypeArrayOutput) ElementType() reflect.Type

func (UserTypeArrayOutput) Index 

func (o UserTypeArrayOutput) Index(i pulumi.IntInput) UserTypeOutput

func (UserTypeArrayOutput) ToUserTypeArrayOutput 

func (o UserTypeArrayOutput) ToUserTypeArrayOutput() UserTypeArrayOutput

func (UserTypeArrayOutput) ToUserTypeArrayOutputWithContext 

func (o UserTypeArrayOutput) ToUserTypeArrayOutputWithContext(ctx context.Context) UserTypeArrayOutput

type UserTypeInput 

type UserTypeInput interface {
	pulumi.Input

	ToUserTypeOutput() UserTypeOutput
	ToUserTypeOutputWithContext(ctx context.Context) UserTypeOutput
}

type UserTypeMap 

type UserTypeMap map[string]UserTypeInput

func (UserTypeMap) ElementType 

func (UserTypeMap) ElementType() reflect.Type

func (UserTypeMap) ToUserTypeMapOutput 

func (i UserTypeMap) ToUserTypeMapOutput() UserTypeMapOutput

func (UserTypeMap) ToUserTypeMapOutputWithContext 

func (i UserTypeMap) ToUserTypeMapOutputWithContext(ctx context.Context) UserTypeMapOutput

type UserTypeMapInput 

type UserTypeMapInput interface {
	pulumi.Input

	ToUserTypeMapOutput() UserTypeMapOutput
	ToUserTypeMapOutputWithContext(context.Context) UserTypeMapOutput
}

UserTypeMapInput is an input type that accepts UserTypeMap and UserTypeMapOutput values. You can construct a concrete instance of `UserTypeMapInput` via: 

UserTypeMap{ "key": UserTypeArgs{...} }

type UserTypeMapOutput 

type UserTypeMapOutput struct{ *pulumi.OutputState }

func (UserTypeMapOutput) ElementType 

func (UserTypeMapOutput) ElementType() reflect.Type

func (UserTypeMapOutput) MapIndex 

func (o UserTypeMapOutput) MapIndex(k pulumi.StringInput) UserTypeOutput

func (UserTypeMapOutput) ToUserTypeMapOutput 

func (o UserTypeMapOutput) ToUserTypeMapOutput() UserTypeMapOutput

func (UserTypeMapOutput) ToUserTypeMapOutputWithContext 

func (o UserTypeMapOutput) ToUserTypeMapOutputWithContext(ctx context.Context) UserTypeMapOutput

type UserTypeOutput 

type UserTypeOutput struct{ *pulumi.OutputState }

func (UserTypeOutput) Description added in v3.9.0 

func (o UserTypeOutput) Description() pulumi.StringOutput

Description of the User Type.

func (UserTypeOutput) DisplayName added in v3.9.0 

func (o UserTypeOutput) DisplayName() pulumi.StringOutput

Display Name of the User Type.

func (UserTypeOutput) ElementType 

func (UserTypeOutput) ElementType() reflect.Type

func (UserTypeOutput) Name added in v3.9.0 

func (o UserTypeOutput) Name() pulumi.StringOutput

Name of the User Type.

func (UserTypeOutput) ToUserTypeOutput 

func (o UserTypeOutput) ToUserTypeOutput() UserTypeOutput

func (UserTypeOutput) ToUserTypeOutputWithContext 

func (o UserTypeOutput) ToUserTypeOutputWithContext(ctx context.Context) UserTypeOutput

type UserTypeState 

type UserTypeState struct {
	// Description of the User Type.
	Description pulumi.StringPtrInput
	// Display Name of the User Type.
	DisplayName pulumi.StringPtrInput
	// Name of the User Type.
	Name pulumi.StringPtrInput
}

func (UserTypeState) ElementType 

func (UserTypeState) 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.