user

package
v2.14.0 Latest Latest
Warning

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

Go to latest
Published: Apr 12, 2021 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"`
}

Manages a User Base Schema property.

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

## Example Usage

```go package main

import (

"github.com/pulumi/pulumi-okta/sdk/v2/go/okta/user"
"github.com/pulumi/pulumi/sdk/v2/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 <property name>

```

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 <user type id>.<property name>

```

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 added in v2.6.2

func (*BaseSchema) ElementType() reflect.Type

func (*BaseSchema) ToBaseSchemaOutput added in v2.6.2

func (i *BaseSchema) ToBaseSchemaOutput() BaseSchemaOutput

func (*BaseSchema) ToBaseSchemaOutputWithContext added in v2.6.2

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

func (*BaseSchema) ToBaseSchemaPtrOutput added in v2.10.1

func (i *BaseSchema) ToBaseSchemaPtrOutput() BaseSchemaPtrOutput

func (*BaseSchema) ToBaseSchemaPtrOutputWithContext added in v2.10.1

func (i *BaseSchema) ToBaseSchemaPtrOutputWithContext(ctx context.Context) BaseSchemaPtrOutput

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 added in v2.10.1

type BaseSchemaArray []BaseSchemaInput

func (BaseSchemaArray) ElementType added in v2.10.1

func (BaseSchemaArray) ElementType() reflect.Type

func (BaseSchemaArray) ToBaseSchemaArrayOutput added in v2.10.1

func (i BaseSchemaArray) ToBaseSchemaArrayOutput() BaseSchemaArrayOutput

func (BaseSchemaArray) ToBaseSchemaArrayOutputWithContext added in v2.10.1

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

type BaseSchemaArrayInput added in v2.10.1

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 added in v2.10.1

type BaseSchemaArrayOutput struct{ *pulumi.OutputState }

func (BaseSchemaArrayOutput) ElementType added in v2.10.1

func (BaseSchemaArrayOutput) ElementType() reflect.Type

func (BaseSchemaArrayOutput) Index added in v2.10.1

func (BaseSchemaArrayOutput) ToBaseSchemaArrayOutput added in v2.10.1

func (o BaseSchemaArrayOutput) ToBaseSchemaArrayOutput() BaseSchemaArrayOutput

func (BaseSchemaArrayOutput) ToBaseSchemaArrayOutputWithContext added in v2.10.1

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

type BaseSchemaInput added in v2.6.2

type BaseSchemaInput interface {
	pulumi.Input

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

type BaseSchemaMap added in v2.10.1

type BaseSchemaMap map[string]BaseSchemaInput

func (BaseSchemaMap) ElementType added in v2.10.1

func (BaseSchemaMap) ElementType() reflect.Type

func (BaseSchemaMap) ToBaseSchemaMapOutput added in v2.10.1

func (i BaseSchemaMap) ToBaseSchemaMapOutput() BaseSchemaMapOutput

func (BaseSchemaMap) ToBaseSchemaMapOutputWithContext added in v2.10.1

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

type BaseSchemaMapInput added in v2.10.1

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 added in v2.10.1

type BaseSchemaMapOutput struct{ *pulumi.OutputState }

func (BaseSchemaMapOutput) ElementType added in v2.10.1

func (BaseSchemaMapOutput) ElementType() reflect.Type

func (BaseSchemaMapOutput) MapIndex added in v2.10.1

func (BaseSchemaMapOutput) ToBaseSchemaMapOutput added in v2.10.1

func (o BaseSchemaMapOutput) ToBaseSchemaMapOutput() BaseSchemaMapOutput

func (BaseSchemaMapOutput) ToBaseSchemaMapOutputWithContext added in v2.10.1

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

type BaseSchemaOutput added in v2.6.2

type BaseSchemaOutput struct {
	*pulumi.OutputState
}

func (BaseSchemaOutput) ElementType added in v2.6.2

func (BaseSchemaOutput) ElementType() reflect.Type

func (BaseSchemaOutput) ToBaseSchemaOutput added in v2.6.2

func (o BaseSchemaOutput) ToBaseSchemaOutput() BaseSchemaOutput

func (BaseSchemaOutput) ToBaseSchemaOutputWithContext added in v2.6.2

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

func (BaseSchemaOutput) ToBaseSchemaPtrOutput added in v2.10.1

func (o BaseSchemaOutput) ToBaseSchemaPtrOutput() BaseSchemaPtrOutput

func (BaseSchemaOutput) ToBaseSchemaPtrOutputWithContext added in v2.10.1

func (o BaseSchemaOutput) ToBaseSchemaPtrOutputWithContext(ctx context.Context) BaseSchemaPtrOutput

type BaseSchemaPtrInput added in v2.10.1

type BaseSchemaPtrInput interface {
	pulumi.Input

	ToBaseSchemaPtrOutput() BaseSchemaPtrOutput
	ToBaseSchemaPtrOutputWithContext(ctx context.Context) BaseSchemaPtrOutput
}

type BaseSchemaPtrOutput added in v2.10.1

type BaseSchemaPtrOutput struct {
	*pulumi.OutputState
}

func (BaseSchemaPtrOutput) ElementType added in v2.10.1

func (BaseSchemaPtrOutput) ElementType() reflect.Type

func (BaseSchemaPtrOutput) ToBaseSchemaPtrOutput added in v2.10.1

func (o BaseSchemaPtrOutput) ToBaseSchemaPtrOutput() BaseSchemaPtrOutput

func (BaseSchemaPtrOutput) ToBaseSchemaPtrOutputWithContext added in v2.10.1

func (o BaseSchemaPtrOutput) ToBaseSchemaPtrOutputWithContext(ctx context.Context) BaseSchemaPtrOutput

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.

## Example Usage

```go package main

import (

"github.com/pulumi/pulumi-okta/sdk/v2/go/okta/user"
"github.com/pulumi/pulumi/sdk/v2/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.
	Comparison *string `pulumi:"comparison"`
	// 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.
	Comparison pulumi.StringPtrInput `pulumi:"comparison"`
	// Name of property to search against.
	Name pulumi.StringInput `pulumi:"name"`
	// Value to compare with.
	Value pulumi.StringInput `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 (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

Comparison to use.

func (GetUserSearchOutput) ElementType

func (GetUserSearchOutput) ElementType() reflect.Type

func (GetUserSearchOutput) Name

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

Value to compare with.

type GetUsersArgs

type GetUsersArgs struct {
	// Map of search criteria to find users. It supports the following properties.
	Searches []GetUsersSearch `pulumi:"searches"`
	// collection of users retrieved from Okta with the following properties.
	Users []GetUsersUser `pulumi:"users"`
}

A collection of arguments for invoking getUsers.

type GetUsersResult

type GetUsersResult struct {
	// The provider-assigned unique ID for this managed resource.
	Id       string           `pulumi:"id"`
	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

```go package main

import (

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

)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := user.GetUsers(ctx, &user.GetUsersArgs{
			Searches: []user.GetUsersSearch{
				user.GetUsersSearch{
					Comparison: "sw",
					Name:       "profile.company",
					Value:      "Articulate",
				},
			},
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

```

type GetUsersSearch

type GetUsersSearch struct {
	// Comparison to use.
	Comparison *string `pulumi:"comparison"`
	// 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.
	Comparison pulumi.StringPtrInput `pulumi:"comparison"`
	// Name of property to search against.
	Name pulumi.StringInput `pulumi:"name"`
	// Value to compare with.
	Value pulumi.StringInput `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 (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

Comparison to use.

func (GetUsersSearchOutput) ElementType

func (GetUsersSearchOutput) ElementType() reflect.Type

func (GetUsersSearchOutput) Name

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

Value to compare with.

type GetUsersUser

type GetUsersUser struct {
	// Administrator roles assigned to user.
	AdminRoles []string `pulumi:"adminRoles"`
	// user profile property.
	City string `pulumi:"city"`
	// user profile property.
	CostCenter string `pulumi:"costCenter"`
	// user profile property.
	CountryCode string `pulumi:"countryCode"`
	// raw JSON containing all custom profile attributes.
	CustomProfileAttributes string `pulumi:"customProfileAttributes"`
	// user profile property.
	Department string `pulumi:"department"`
	// user profile property.
	DisplayName string `pulumi:"displayName"`
	// user profile property.
	Division string `pulumi:"division"`
	// user profile property.
	Email string `pulumi:"email"`
	// user profile property.
	EmployeeNumber string `pulumi:"employeeNumber"`
	// user profile property.
	FirstName string `pulumi:"firstName"`
	// user profile property.
	GroupMemberships []string `pulumi:"groupMemberships"`
	// user profile property.
	HonorificPrefix string `pulumi:"honorificPrefix"`
	// user profile property.
	HonorificSuffix string `pulumi:"honorificSuffix"`
	Id              string `pulumi:"id"`
	// user profile property.
	LastName string `pulumi:"lastName"`
	// user profile property.
	Locale string `pulumi:"locale"`
	// user profile property.
	Login string `pulumi:"login"`
	// user profile property.
	Manager string `pulumi:"manager"`
	// user profile property.
	ManagerId string `pulumi:"managerId"`
	// user profile property.
	MiddleName string `pulumi:"middleName"`
	// user profile property.
	MobilePhone string `pulumi:"mobilePhone"`
	// user profile property.
	NickName string `pulumi:"nickName"`
	// user profile property.
	Organization string `pulumi:"organization"`
	// user profile property.
	PostalAddress string `pulumi:"postalAddress"`
	// user profile property.
	PreferredLanguage string `pulumi:"preferredLanguage"`
	// user profile property.
	PrimaryPhone string `pulumi:"primaryPhone"`
	// user profile property.
	ProfileUrl string `pulumi:"profileUrl"`
	// user profile property.
	SecondEmail string `pulumi:"secondEmail"`
	// user profile property.
	State string `pulumi:"state"`
	// user profile property.
	Status string `pulumi:"status"`
	// user profile property.
	StreetAddress string `pulumi:"streetAddress"`
	// user profile property.
	Timezone string `pulumi:"timezone"`
	// user profile property.
	Title string `pulumi:"title"`
	// user profile property.
	UserType string `pulumi:"userType"`
	// user profile property.
	ZipCode string `pulumi:"zipCode"`
}

type GetUsersUserArgs

type GetUsersUserArgs struct {
	// Administrator roles assigned to user.
	AdminRoles pulumi.StringArrayInput `pulumi:"adminRoles"`
	// user profile property.
	City pulumi.StringInput `pulumi:"city"`
	// user profile property.
	CostCenter pulumi.StringInput `pulumi:"costCenter"`
	// user profile property.
	CountryCode pulumi.StringInput `pulumi:"countryCode"`
	// raw JSON containing all custom profile attributes.
	CustomProfileAttributes pulumi.StringInput `pulumi:"customProfileAttributes"`
	// user profile property.
	Department pulumi.StringInput `pulumi:"department"`
	// user profile property.
	DisplayName pulumi.StringInput `pulumi:"displayName"`
	// user profile property.
	Division pulumi.StringInput `pulumi:"division"`
	// user profile property.
	Email pulumi.StringInput `pulumi:"email"`
	// user profile property.
	EmployeeNumber pulumi.StringInput `pulumi:"employeeNumber"`
	// user profile property.
	FirstName pulumi.StringInput `pulumi:"firstName"`
	// user profile property.
	GroupMemberships pulumi.StringArrayInput `pulumi:"groupMemberships"`
	// user profile property.
	HonorificPrefix pulumi.StringInput `pulumi:"honorificPrefix"`
	// user profile property.
	HonorificSuffix pulumi.StringInput `pulumi:"honorificSuffix"`
	Id              pulumi.StringInput `pulumi:"id"`
	// user profile property.
	LastName pulumi.StringInput `pulumi:"lastName"`
	// user profile property.
	Locale pulumi.StringInput `pulumi:"locale"`
	// user profile property.
	Login pulumi.StringInput `pulumi:"login"`
	// user profile property.
	Manager pulumi.StringInput `pulumi:"manager"`
	// user profile property.
	ManagerId pulumi.StringInput `pulumi:"managerId"`
	// user profile property.
	MiddleName pulumi.StringInput `pulumi:"middleName"`
	// user profile property.
	MobilePhone pulumi.StringInput `pulumi:"mobilePhone"`
	// user profile property.
	NickName pulumi.StringInput `pulumi:"nickName"`
	// user profile property.
	Organization pulumi.StringInput `pulumi:"organization"`
	// user profile property.
	PostalAddress pulumi.StringInput `pulumi:"postalAddress"`
	// user profile property.
	PreferredLanguage pulumi.StringInput `pulumi:"preferredLanguage"`
	// user profile property.
	PrimaryPhone pulumi.StringInput `pulumi:"primaryPhone"`
	// user profile property.
	ProfileUrl pulumi.StringInput `pulumi:"profileUrl"`
	// user profile property.
	SecondEmail pulumi.StringInput `pulumi:"secondEmail"`
	// user profile property.
	State pulumi.StringInput `pulumi:"state"`
	// user profile property.
	Status pulumi.StringInput `pulumi:"status"`
	// user profile property.
	StreetAddress pulumi.StringInput `pulumi:"streetAddress"`
	// user profile property.
	Timezone pulumi.StringInput `pulumi:"timezone"`
	// user profile property.
	Title pulumi.StringInput `pulumi:"title"`
	// user profile property.
	UserType pulumi.StringInput `pulumi:"userType"`
	// user profile property.
	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 (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

Administrator roles assigned to user.

func (GetUsersUserOutput) City

user profile property.

func (GetUsersUserOutput) CostCenter

func (o GetUsersUserOutput) CostCenter() pulumi.StringOutput

user profile property.

func (GetUsersUserOutput) CountryCode

func (o GetUsersUserOutput) CountryCode() pulumi.StringOutput

user profile property.

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

user profile property.

func (GetUsersUserOutput) DisplayName

func (o GetUsersUserOutput) DisplayName() pulumi.StringOutput

user profile property.

func (GetUsersUserOutput) Division

func (o GetUsersUserOutput) Division() pulumi.StringOutput

user profile property.

func (GetUsersUserOutput) ElementType

func (GetUsersUserOutput) ElementType() reflect.Type

func (GetUsersUserOutput) Email

user profile property.

func (GetUsersUserOutput) EmployeeNumber

func (o GetUsersUserOutput) EmployeeNumber() pulumi.StringOutput

user profile property.

func (GetUsersUserOutput) FirstName

func (o GetUsersUserOutput) FirstName() pulumi.StringOutput

user profile property.

func (GetUsersUserOutput) GroupMemberships

func (o GetUsersUserOutput) GroupMemberships() pulumi.StringArrayOutput

user profile property.

func (GetUsersUserOutput) HonorificPrefix

func (o GetUsersUserOutput) HonorificPrefix() pulumi.StringOutput

user profile property.

func (GetUsersUserOutput) HonorificSuffix

func (o GetUsersUserOutput) HonorificSuffix() pulumi.StringOutput

user profile property.

func (GetUsersUserOutput) Id added in v2.9.0

func (GetUsersUserOutput) LastName

func (o GetUsersUserOutput) LastName() pulumi.StringOutput

user profile property.

func (GetUsersUserOutput) Locale

user profile property.

func (GetUsersUserOutput) Login

user profile property.

func (GetUsersUserOutput) Manager

user profile property.

func (GetUsersUserOutput) ManagerId

func (o GetUsersUserOutput) ManagerId() pulumi.StringOutput

user profile property.

func (GetUsersUserOutput) MiddleName

func (o GetUsersUserOutput) MiddleName() pulumi.StringOutput

user profile property.

func (GetUsersUserOutput) MobilePhone

func (o GetUsersUserOutput) MobilePhone() pulumi.StringOutput

user profile property.

func (GetUsersUserOutput) NickName

func (o GetUsersUserOutput) NickName() pulumi.StringOutput

user profile property.

func (GetUsersUserOutput) Organization

func (o GetUsersUserOutput) Organization() pulumi.StringOutput

user profile property.

func (GetUsersUserOutput) PostalAddress

func (o GetUsersUserOutput) PostalAddress() pulumi.StringOutput

user profile property.

func (GetUsersUserOutput) PreferredLanguage

func (o GetUsersUserOutput) PreferredLanguage() pulumi.StringOutput

user profile property.

func (GetUsersUserOutput) PrimaryPhone

func (o GetUsersUserOutput) PrimaryPhone() pulumi.StringOutput

user profile property.

func (GetUsersUserOutput) ProfileUrl

func (o GetUsersUserOutput) ProfileUrl() pulumi.StringOutput

user profile property.

func (GetUsersUserOutput) SecondEmail

func (o GetUsersUserOutput) SecondEmail() pulumi.StringOutput

user profile property.

func (GetUsersUserOutput) State

user profile property.

func (GetUsersUserOutput) Status

user profile property.

func (GetUsersUserOutput) StreetAddress

func (o GetUsersUserOutput) StreetAddress() pulumi.StringOutput

user profile property.

func (GetUsersUserOutput) Timezone

func (o GetUsersUserOutput) Timezone() pulumi.StringOutput

user profile property.

func (GetUsersUserOutput) Title

user profile property.

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

user profile property.

func (GetUsersUserOutput) ZipCode

user profile property.

type LookupUserArgs

type LookupUserArgs struct {
	// Map of search criteria. It supports the following properties.
	Searches []GetUserSearch `pulumi:"searches"`
	// String representing a specific user's id value
	UserId *string `pulumi:"userId"`
}

A collection of arguments for invoking getUser.

type LookupUserResult

type LookupUserResult struct {
	// Administrator roles assigned to user.
	AdminRoles []string `pulumi:"adminRoles"`
	// user profile property.
	City string `pulumi:"city"`
	// user profile property.
	CostCenter string `pulumi:"costCenter"`
	// user profile property.
	CountryCode string `pulumi:"countryCode"`
	// raw JSON containing all custom profile attributes.
	CustomProfileAttributes string `pulumi:"customProfileAttributes"`
	// user profile property.
	Department string `pulumi:"department"`
	// user profile property.
	DisplayName string `pulumi:"displayName"`
	// user profile property.
	Division string `pulumi:"division"`
	// user profile property.
	Email string `pulumi:"email"`
	// user profile property.
	EmployeeNumber string `pulumi:"employeeNumber"`
	// user profile property.
	FirstName string `pulumi:"firstName"`
	// user profile property.
	GroupMemberships []string `pulumi:"groupMemberships"`
	// user profile property.
	HonorificPrefix string `pulumi:"honorificPrefix"`
	// user profile property.
	HonorificSuffix string `pulumi:"honorificSuffix"`
	// The provider-assigned unique ID for this managed resource.
	Id string `pulumi:"id"`
	// user profile property.
	LastName string `pulumi:"lastName"`
	// user profile property.
	Locale string `pulumi:"locale"`
	// user profile property.
	Login string `pulumi:"login"`
	// user profile property.
	Manager string `pulumi:"manager"`
	// user profile property.
	ManagerId string `pulumi:"managerId"`
	// user profile property.
	MiddleName string `pulumi:"middleName"`
	// user profile property.
	MobilePhone string `pulumi:"mobilePhone"`
	// user profile property.
	NickName string `pulumi:"nickName"`
	// user profile property.
	Organization string `pulumi:"organization"`
	// user profile property.
	PostalAddress string `pulumi:"postalAddress"`
	// user profile property.
	PreferredLanguage string `pulumi:"preferredLanguage"`
	// user profile property.
	PrimaryPhone string `pulumi:"primaryPhone"`
	// user profile property.
	ProfileUrl string          `pulumi:"profileUrl"`
	Searches   []GetUserSearch `pulumi:"searches"`
	// user profile property.
	SecondEmail string `pulumi:"secondEmail"`
	// user profile property.
	State string `pulumi:"state"`
	// user profile property.
	Status string `pulumi:"status"`
	// user profile property.
	StreetAddress string `pulumi:"streetAddress"`
	// user profile property.
	Timezone string `pulumi:"timezone"`
	// user profile property.
	Title  string  `pulumi:"title"`
	UserId *string `pulumi:"userId"`
	// user profile property.
	UserType string `pulumi:"userType"`
	// user profile property.
	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.

type LookupUserTypeArgs added in v2.7.0

type LookupUserTypeArgs struct {
	// description of user type.
	Description *string `pulumi:"description"`
	// display name of user type.
	DisplayName *string `pulumi:"displayName"`
	// name of user type to retrieve.
	Name string `pulumi:"name"`
}

A collection of arguments for invoking getUserType.

type LookupUserTypeResult added in v2.7.0

type LookupUserTypeResult struct {
	// description of user type.
	Description *string `pulumi:"description"`
	// display name of user type.
	DisplayName *string `pulumi:"displayName"`
	// id of user type.
	Id string `pulumi:"id"`
	// name of user type.
	Name string `pulumi:"name"`
}

A collection of values returned by getUserType.

func LookupUserType added in v2.7.0

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/v2/go/okta/user"
"github.com/pulumi/pulumi/sdk/v2/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 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"`
}

Creates a User Schema property.

This resource allows you to create and configure a custom user schema property.

## Example Usage

```go package main

import (

"github.com/pulumi/pulumi-okta/sdk/v2/go/okta/user"
"github.com/pulumi/pulumi/sdk/v2/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 <index>

```

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 <user type id>.<index>

```

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 added in v2.6.2

func (*Schema) ElementType() reflect.Type

func (*Schema) ToSchemaOutput added in v2.6.2

func (i *Schema) ToSchemaOutput() SchemaOutput

func (*Schema) ToSchemaOutputWithContext added in v2.6.2

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

func (*Schema) ToSchemaPtrOutput added in v2.10.1

func (i *Schema) ToSchemaPtrOutput() SchemaPtrOutput

func (*Schema) ToSchemaPtrOutputWithContext added in v2.10.1

func (i *Schema) ToSchemaPtrOutputWithContext(ctx context.Context) SchemaPtrOutput

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 added in v2.10.1

type SchemaArray []SchemaInput

func (SchemaArray) ElementType added in v2.10.1

func (SchemaArray) ElementType() reflect.Type

func (SchemaArray) ToSchemaArrayOutput added in v2.10.1

func (i SchemaArray) ToSchemaArrayOutput() SchemaArrayOutput

func (SchemaArray) ToSchemaArrayOutputWithContext added in v2.10.1

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

type SchemaArrayInput added in v2.10.1

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) Index

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

value mapping to member of `enum`.

func (SchemaArrayOneOfOutput) ElementType

func (SchemaArrayOneOfOutput) ElementType() reflect.Type

func (SchemaArrayOneOfOutput) Title

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 added in v2.10.1

type SchemaArrayOutput struct{ *pulumi.OutputState }

func (SchemaArrayOutput) ElementType added in v2.10.1

func (SchemaArrayOutput) ElementType() reflect.Type

func (SchemaArrayOutput) Index added in v2.10.1

func (SchemaArrayOutput) ToSchemaArrayOutput added in v2.10.1

func (o SchemaArrayOutput) ToSchemaArrayOutput() SchemaArrayOutput

func (SchemaArrayOutput) ToSchemaArrayOutputWithContext added in v2.10.1

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

type SchemaInput added in v2.6.2

type SchemaInput interface {
	pulumi.Input

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

type SchemaMap added in v2.10.1

type SchemaMap map[string]SchemaInput

func (SchemaMap) ElementType added in v2.10.1

func (SchemaMap) ElementType() reflect.Type

func (SchemaMap) ToSchemaMapOutput added in v2.10.1

func (i SchemaMap) ToSchemaMapOutput() SchemaMapOutput

func (SchemaMap) ToSchemaMapOutputWithContext added in v2.10.1

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

type SchemaMapInput added in v2.10.1

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 added in v2.10.1

type SchemaMapOutput struct{ *pulumi.OutputState }

func (SchemaMapOutput) ElementType added in v2.10.1

func (SchemaMapOutput) ElementType() reflect.Type

func (SchemaMapOutput) MapIndex added in v2.10.1

func (SchemaMapOutput) ToSchemaMapOutput added in v2.10.1

func (o SchemaMapOutput) ToSchemaMapOutput() SchemaMapOutput

func (SchemaMapOutput) ToSchemaMapOutputWithContext added in v2.10.1

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

type SchemaMasterOverridePriority added in v2.11.1

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

type SchemaMasterOverridePriorityArgs added in v2.11.1

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

func (SchemaMasterOverridePriorityArgs) ElementType added in v2.11.1

func (SchemaMasterOverridePriorityArgs) ToSchemaMasterOverridePriorityOutput added in v2.11.1

func (i SchemaMasterOverridePriorityArgs) ToSchemaMasterOverridePriorityOutput() SchemaMasterOverridePriorityOutput

func (SchemaMasterOverridePriorityArgs) ToSchemaMasterOverridePriorityOutputWithContext added in v2.11.1

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

type SchemaMasterOverridePriorityArray added in v2.11.1

type SchemaMasterOverridePriorityArray []SchemaMasterOverridePriorityInput

func (SchemaMasterOverridePriorityArray) ElementType added in v2.11.1

func (SchemaMasterOverridePriorityArray) ToSchemaMasterOverridePriorityArrayOutput added in v2.11.1

func (i SchemaMasterOverridePriorityArray) ToSchemaMasterOverridePriorityArrayOutput() SchemaMasterOverridePriorityArrayOutput

func (SchemaMasterOverridePriorityArray) ToSchemaMasterOverridePriorityArrayOutputWithContext added in v2.11.1

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

type SchemaMasterOverridePriorityArrayInput added in v2.11.1

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 added in v2.11.1

type SchemaMasterOverridePriorityArrayOutput struct{ *pulumi.OutputState }

func (SchemaMasterOverridePriorityArrayOutput) ElementType added in v2.11.1

func (SchemaMasterOverridePriorityArrayOutput) Index added in v2.11.1

func (SchemaMasterOverridePriorityArrayOutput) ToSchemaMasterOverridePriorityArrayOutput added in v2.11.1

func (o SchemaMasterOverridePriorityArrayOutput) ToSchemaMasterOverridePriorityArrayOutput() SchemaMasterOverridePriorityArrayOutput

func (SchemaMasterOverridePriorityArrayOutput) ToSchemaMasterOverridePriorityArrayOutputWithContext added in v2.11.1

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

type SchemaMasterOverridePriorityInput added in v2.11.1

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 added in v2.11.1

type SchemaMasterOverridePriorityOutput struct{ *pulumi.OutputState }

func (SchemaMasterOverridePriorityOutput) ElementType added in v2.11.1

func (SchemaMasterOverridePriorityOutput) ToSchemaMasterOverridePriorityOutput added in v2.11.1

func (o SchemaMasterOverridePriorityOutput) ToSchemaMasterOverridePriorityOutput() SchemaMasterOverridePriorityOutput

func (SchemaMasterOverridePriorityOutput) ToSchemaMasterOverridePriorityOutputWithContext added in v2.11.1

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

func (SchemaMasterOverridePriorityOutput) Type added in v2.11.1

- Type of profile source.

func (SchemaMasterOverridePriorityOutput) Value added in v2.11.1

- 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 (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

value mapping to member of `enum`.

func (SchemaOneOfOutput) ElementType

func (SchemaOneOfOutput) ElementType() reflect.Type

func (SchemaOneOfOutput) Title

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 added in v2.6.2

type SchemaOutput struct {
	*pulumi.OutputState
}

func (SchemaOutput) ElementType added in v2.6.2

func (SchemaOutput) ElementType() reflect.Type

func (SchemaOutput) ToSchemaOutput added in v2.6.2

func (o SchemaOutput) ToSchemaOutput() SchemaOutput

func (SchemaOutput) ToSchemaOutputWithContext added in v2.6.2

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

func (SchemaOutput) ToSchemaPtrOutput added in v2.10.1

func (o SchemaOutput) ToSchemaPtrOutput() SchemaPtrOutput

func (SchemaOutput) ToSchemaPtrOutputWithContext added in v2.10.1

func (o SchemaOutput) ToSchemaPtrOutputWithContext(ctx context.Context) SchemaPtrOutput

type SchemaPtrInput added in v2.10.1

type SchemaPtrInput interface {
	pulumi.Input

	ToSchemaPtrOutput() SchemaPtrOutput
	ToSchemaPtrOutputWithContext(ctx context.Context) SchemaPtrOutput
}

type SchemaPtrOutput added in v2.10.1

type SchemaPtrOutput struct {
	*pulumi.OutputState
}

func (SchemaPtrOutput) ElementType added in v2.10.1

func (SchemaPtrOutput) ElementType() reflect.Type

func (SchemaPtrOutput) ToSchemaPtrOutput added in v2.10.1

func (o SchemaPtrOutput) ToSchemaPtrOutput() SchemaPtrOutput

func (SchemaPtrOutput) ToSchemaPtrOutputWithContext added in v2.10.1

func (o SchemaPtrOutput) ToSchemaPtrOutputWithContext(ctx context.Context) SchemaPtrOutput

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.
	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.StringPtrOutput `pulumi:"customProfileAttributes"`
	// 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"`
	// User's First Name, required by default.
	FirstName pulumi.StringOutput `pulumi:"firstName"`
	// User profile property.
	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"`
	// User profile property.
	Organization pulumi.StringPtrOutput `pulumi:"organization"`
	// User password.
	Password pulumi.StringPtrOutput `pulumi:"password"`
	// 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"`
	// User profile property.
	State pulumi.StringPtrOutput `pulumi:"state"`
	// User profile property.
	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.

## Example Usage

```go package main

import (

"github.com/pulumi/pulumi-okta/sdk/v2/go/okta/user"
"github.com/pulumi/pulumi/sdk/v2/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("http://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
	})
}

```

## Import

An Okta User can be imported via the ID.

```sh

$ pulumi import okta:user/user:User example <user id>

```

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 added in v2.6.2

func (*User) ElementType() reflect.Type

func (*User) ToUserOutput added in v2.6.2

func (i *User) ToUserOutput() UserOutput

func (*User) ToUserOutputWithContext added in v2.6.2

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

func (*User) ToUserPtrOutput added in v2.10.1

func (i *User) ToUserPtrOutput() UserPtrOutput

func (*User) ToUserPtrOutputWithContext added in v2.10.1

func (i *User) ToUserPtrOutputWithContext(ctx context.Context) UserPtrOutput

type UserArgs

type UserArgs struct {
	// Administrator roles assigned to User.
	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
	// 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
	// User's First Name, required by default.
	FirstName pulumi.StringInput
	// User profile property.
	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
	// User profile property.
	Organization pulumi.StringPtrInput
	// User password.
	Password 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
	// User profile property.
	State pulumi.StringPtrInput
	// User profile property.
	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 added in v2.10.1

type UserArray []UserInput

func (UserArray) ElementType added in v2.10.1

func (UserArray) ElementType() reflect.Type

func (UserArray) ToUserArrayOutput added in v2.10.1

func (i UserArray) ToUserArrayOutput() UserArrayOutput

func (UserArray) ToUserArrayOutputWithContext added in v2.10.1

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

type UserArrayInput added in v2.10.1

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 added in v2.10.1

type UserArrayOutput struct{ *pulumi.OutputState }

func (UserArrayOutput) ElementType added in v2.10.1

func (UserArrayOutput) ElementType() reflect.Type

func (UserArrayOutput) Index added in v2.10.1

func (UserArrayOutput) ToUserArrayOutput added in v2.10.1

func (o UserArrayOutput) ToUserArrayOutput() UserArrayOutput

func (UserArrayOutput) ToUserArrayOutputWithContext added in v2.10.1

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

type UserInput added in v2.6.2

type UserInput interface {
	pulumi.Input

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

type UserMap added in v2.10.1

type UserMap map[string]UserInput

func (UserMap) ElementType added in v2.10.1

func (UserMap) ElementType() reflect.Type

func (UserMap) ToUserMapOutput added in v2.10.1

func (i UserMap) ToUserMapOutput() UserMapOutput

func (UserMap) ToUserMapOutputWithContext added in v2.10.1

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

type UserMapInput added in v2.10.1

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 added in v2.10.1

type UserMapOutput struct{ *pulumi.OutputState }

func (UserMapOutput) ElementType added in v2.10.1

func (UserMapOutput) ElementType() reflect.Type

func (UserMapOutput) MapIndex added in v2.10.1

func (UserMapOutput) ToUserMapOutput added in v2.10.1

func (o UserMapOutput) ToUserMapOutput() UserMapOutput

func (UserMapOutput) ToUserMapOutputWithContext added in v2.10.1

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

type UserOutput added in v2.6.2

type UserOutput struct {
	*pulumi.OutputState
}

func (UserOutput) ElementType added in v2.6.2

func (UserOutput) ElementType() reflect.Type

func (UserOutput) ToUserOutput added in v2.6.2

func (o UserOutput) ToUserOutput() UserOutput

func (UserOutput) ToUserOutputWithContext added in v2.6.2

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

func (UserOutput) ToUserPtrOutput added in v2.10.1

func (o UserOutput) ToUserPtrOutput() UserPtrOutput

func (UserOutput) ToUserPtrOutputWithContext added in v2.10.1

func (o UserOutput) ToUserPtrOutputWithContext(ctx context.Context) UserPtrOutput

type UserPtrInput added in v2.10.1

type UserPtrInput interface {
	pulumi.Input

	ToUserPtrOutput() UserPtrOutput
	ToUserPtrOutputWithContext(ctx context.Context) UserPtrOutput
}

type UserPtrOutput added in v2.10.1

type UserPtrOutput struct {
	*pulumi.OutputState
}

func (UserPtrOutput) ElementType added in v2.10.1

func (UserPtrOutput) ElementType() reflect.Type

func (UserPtrOutput) ToUserPtrOutput added in v2.10.1

func (o UserPtrOutput) ToUserPtrOutput() UserPtrOutput

func (UserPtrOutput) ToUserPtrOutputWithContext added in v2.10.1

func (o UserPtrOutput) ToUserPtrOutputWithContext(ctx context.Context) UserPtrOutput

type UserState

type UserState struct {
	// Administrator roles assigned to User.
	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
	// 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
	// User's First Name, required by default.
	FirstName pulumi.StringPtrInput
	// User profile property.
	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
	// User profile property.
	Organization pulumi.StringPtrInput
	// User password.
	Password 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
	// User profile property.
	State pulumi.StringPtrInput
	// User profile property.
	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 added in v2.7.0

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/v2/go/okta/user"
"github.com/pulumi/pulumi/sdk/v2/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 <user type id>

```

func GetUserType added in v2.7.0

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 added in v2.7.0

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 added in v2.7.0

func (*UserType) ElementType() reflect.Type

func (*UserType) ToUserTypeOutput added in v2.7.0

func (i *UserType) ToUserTypeOutput() UserTypeOutput

func (*UserType) ToUserTypeOutputWithContext added in v2.7.0

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

func (*UserType) ToUserTypePtrOutput added in v2.10.1

func (i *UserType) ToUserTypePtrOutput() UserTypePtrOutput

func (*UserType) ToUserTypePtrOutputWithContext added in v2.10.1

func (i *UserType) ToUserTypePtrOutputWithContext(ctx context.Context) UserTypePtrOutput

type UserTypeArgs added in v2.7.0

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 added in v2.7.0

func (UserTypeArgs) ElementType() reflect.Type

type UserTypeArray added in v2.10.1

type UserTypeArray []UserTypeInput

func (UserTypeArray) ElementType added in v2.10.1

func (UserTypeArray) ElementType() reflect.Type

func (UserTypeArray) ToUserTypeArrayOutput added in v2.10.1

func (i UserTypeArray) ToUserTypeArrayOutput() UserTypeArrayOutput

func (UserTypeArray) ToUserTypeArrayOutputWithContext added in v2.10.1

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

type UserTypeArrayInput added in v2.10.1

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 added in v2.10.1

type UserTypeArrayOutput struct{ *pulumi.OutputState }

func (UserTypeArrayOutput) ElementType added in v2.10.1

func (UserTypeArrayOutput) ElementType() reflect.Type

func (UserTypeArrayOutput) Index added in v2.10.1

func (UserTypeArrayOutput) ToUserTypeArrayOutput added in v2.10.1

func (o UserTypeArrayOutput) ToUserTypeArrayOutput() UserTypeArrayOutput

func (UserTypeArrayOutput) ToUserTypeArrayOutputWithContext added in v2.10.1

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

type UserTypeInput added in v2.7.0

type UserTypeInput interface {
	pulumi.Input

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

type UserTypeMap added in v2.10.1

type UserTypeMap map[string]UserTypeInput

func (UserTypeMap) ElementType added in v2.10.1

func (UserTypeMap) ElementType() reflect.Type

func (UserTypeMap) ToUserTypeMapOutput added in v2.10.1

func (i UserTypeMap) ToUserTypeMapOutput() UserTypeMapOutput

func (UserTypeMap) ToUserTypeMapOutputWithContext added in v2.10.1

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

type UserTypeMapInput added in v2.10.1

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 added in v2.10.1

type UserTypeMapOutput struct{ *pulumi.OutputState }

func (UserTypeMapOutput) ElementType added in v2.10.1

func (UserTypeMapOutput) ElementType() reflect.Type

func (UserTypeMapOutput) MapIndex added in v2.10.1

func (UserTypeMapOutput) ToUserTypeMapOutput added in v2.10.1

func (o UserTypeMapOutput) ToUserTypeMapOutput() UserTypeMapOutput

func (UserTypeMapOutput) ToUserTypeMapOutputWithContext added in v2.10.1

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

type UserTypeOutput added in v2.7.0

type UserTypeOutput struct {
	*pulumi.OutputState
}

func (UserTypeOutput) ElementType added in v2.7.0

func (UserTypeOutput) ElementType() reflect.Type

func (UserTypeOutput) ToUserTypeOutput added in v2.7.0

func (o UserTypeOutput) ToUserTypeOutput() UserTypeOutput

func (UserTypeOutput) ToUserTypeOutputWithContext added in v2.7.0

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

func (UserTypeOutput) ToUserTypePtrOutput added in v2.10.1

func (o UserTypeOutput) ToUserTypePtrOutput() UserTypePtrOutput

func (UserTypeOutput) ToUserTypePtrOutputWithContext added in v2.10.1

func (o UserTypeOutput) ToUserTypePtrOutputWithContext(ctx context.Context) UserTypePtrOutput

type UserTypePtrInput added in v2.10.1

type UserTypePtrInput interface {
	pulumi.Input

	ToUserTypePtrOutput() UserTypePtrOutput
	ToUserTypePtrOutputWithContext(ctx context.Context) UserTypePtrOutput
}

type UserTypePtrOutput added in v2.10.1

type UserTypePtrOutput struct {
	*pulumi.OutputState
}

func (UserTypePtrOutput) ElementType added in v2.10.1

func (UserTypePtrOutput) ElementType() reflect.Type

func (UserTypePtrOutput) ToUserTypePtrOutput added in v2.10.1

func (o UserTypePtrOutput) ToUserTypePtrOutput() UserTypePtrOutput

func (UserTypePtrOutput) ToUserTypePtrOutputWithContext added in v2.10.1

func (o UserTypePtrOutput) ToUserTypePtrOutputWithContext(ctx context.Context) UserTypePtrOutput

type UserTypeState added in v2.7.0

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 added in v2.7.0

func (UserTypeState) ElementType() reflect.Type

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL