Documentation
¶
Index ¶
- type GetUserProfileMappingSourceResult
- type GetUserSearch
- type GetUserSearchArgs
- func (GetUserSearchArgs) ElementType() reflect.Type
- func (i GetUserSearchArgs) ToGetUserSearchOutput() GetUserSearchOutput
- func (i GetUserSearchArgs) ToGetUserSearchOutputWithContext(ctx context.Context) GetUserSearchOutput
- func (i GetUserSearchArgs) ToOutput(ctx context.Context) pulumix.Output[GetUserSearch]
- type GetUserSearchArray
- func (GetUserSearchArray) ElementType() reflect.Type
- func (i GetUserSearchArray) ToGetUserSearchArrayOutput() GetUserSearchArrayOutput
- func (i GetUserSearchArray) ToGetUserSearchArrayOutputWithContext(ctx context.Context) GetUserSearchArrayOutput
- func (i GetUserSearchArray) ToOutput(ctx context.Context) pulumix.Output[[]GetUserSearch]
- type GetUserSearchArrayInput
- type GetUserSearchArrayOutput
- func (GetUserSearchArrayOutput) ElementType() reflect.Type
- func (o GetUserSearchArrayOutput) Index(i pulumi.IntInput) GetUserSearchOutput
- func (o GetUserSearchArrayOutput) ToGetUserSearchArrayOutput() GetUserSearchArrayOutput
- func (o GetUserSearchArrayOutput) ToGetUserSearchArrayOutputWithContext(ctx context.Context) GetUserSearchArrayOutput
- func (o GetUserSearchArrayOutput) ToOutput(ctx context.Context) pulumix.Output[[]GetUserSearch]
- type GetUserSearchInput
- type GetUserSearchOutput
- func (o GetUserSearchOutput) Comparison() pulumi.StringPtrOutput
- func (GetUserSearchOutput) ElementType() reflect.Type
- func (o GetUserSearchOutput) Expression() pulumi.StringPtrOutput
- func (o GetUserSearchOutput) Name() pulumi.StringPtrOutput
- func (o GetUserSearchOutput) ToGetUserSearchOutput() GetUserSearchOutput
- func (o GetUserSearchOutput) ToGetUserSearchOutputWithContext(ctx context.Context) GetUserSearchOutput
- func (o GetUserSearchOutput) ToOutput(ctx context.Context) pulumix.Output[GetUserSearch]
- func (o GetUserSearchOutput) Value() pulumi.StringPtrOutput
- type GetUsersArgs
- type GetUsersOutputArgs
- type GetUsersResult
- type GetUsersResultOutput
- func (o GetUsersResultOutput) CompoundSearchOperator() pulumi.StringPtrOutput
- func (o GetUsersResultOutput) DelayReadSeconds() pulumi.StringPtrOutput
- func (GetUsersResultOutput) ElementType() reflect.Type
- func (o GetUsersResultOutput) GroupId() pulumi.StringPtrOutput
- func (o GetUsersResultOutput) Id() pulumi.StringOutput
- func (o GetUsersResultOutput) IncludeGroups() pulumi.BoolPtrOutput
- func (o GetUsersResultOutput) IncludeRoles() pulumi.BoolPtrOutput
- func (o GetUsersResultOutput) Searches() GetUsersSearchArrayOutput
- func (o GetUsersResultOutput) ToGetUsersResultOutput() GetUsersResultOutput
- func (o GetUsersResultOutput) ToGetUsersResultOutputWithContext(ctx context.Context) GetUsersResultOutput
- func (o GetUsersResultOutput) ToOutput(ctx context.Context) pulumix.Output[GetUsersResult]
- func (o GetUsersResultOutput) Users() GetUsersUserArrayOutput
- type GetUsersSearch
- type GetUsersSearchArgs
- func (GetUsersSearchArgs) ElementType() reflect.Type
- func (i GetUsersSearchArgs) ToGetUsersSearchOutput() GetUsersSearchOutput
- func (i GetUsersSearchArgs) ToGetUsersSearchOutputWithContext(ctx context.Context) GetUsersSearchOutput
- func (i GetUsersSearchArgs) ToOutput(ctx context.Context) pulumix.Output[GetUsersSearch]
- type GetUsersSearchArray
- func (GetUsersSearchArray) ElementType() reflect.Type
- func (i GetUsersSearchArray) ToGetUsersSearchArrayOutput() GetUsersSearchArrayOutput
- func (i GetUsersSearchArray) ToGetUsersSearchArrayOutputWithContext(ctx context.Context) GetUsersSearchArrayOutput
- func (i GetUsersSearchArray) ToOutput(ctx context.Context) pulumix.Output[[]GetUsersSearch]
- type GetUsersSearchArrayInput
- type GetUsersSearchArrayOutput
- func (GetUsersSearchArrayOutput) ElementType() reflect.Type
- func (o GetUsersSearchArrayOutput) Index(i pulumi.IntInput) GetUsersSearchOutput
- func (o GetUsersSearchArrayOutput) ToGetUsersSearchArrayOutput() GetUsersSearchArrayOutput
- func (o GetUsersSearchArrayOutput) ToGetUsersSearchArrayOutputWithContext(ctx context.Context) GetUsersSearchArrayOutput
- func (o GetUsersSearchArrayOutput) ToOutput(ctx context.Context) pulumix.Output[[]GetUsersSearch]
- type GetUsersSearchInput
- type GetUsersSearchOutput
- func (o GetUsersSearchOutput) Comparison() pulumi.StringPtrOutput
- func (GetUsersSearchOutput) ElementType() reflect.Type
- func (o GetUsersSearchOutput) Expression() pulumi.StringPtrOutput
- func (o GetUsersSearchOutput) Name() pulumi.StringPtrOutput
- func (o GetUsersSearchOutput) ToGetUsersSearchOutput() GetUsersSearchOutput
- func (o GetUsersSearchOutput) ToGetUsersSearchOutputWithContext(ctx context.Context) GetUsersSearchOutput
- func (o GetUsersSearchOutput) ToOutput(ctx context.Context) pulumix.Output[GetUsersSearch]
- func (o GetUsersSearchOutput) Value() pulumi.StringPtrOutput
- type GetUsersUser
- type GetUsersUserArgs
- func (GetUsersUserArgs) ElementType() reflect.Type
- func (i GetUsersUserArgs) ToGetUsersUserOutput() GetUsersUserOutput
- func (i GetUsersUserArgs) ToGetUsersUserOutputWithContext(ctx context.Context) GetUsersUserOutput
- func (i GetUsersUserArgs) ToOutput(ctx context.Context) pulumix.Output[GetUsersUser]
- type GetUsersUserArray
- func (GetUsersUserArray) ElementType() reflect.Type
- func (i GetUsersUserArray) ToGetUsersUserArrayOutput() GetUsersUserArrayOutput
- func (i GetUsersUserArray) ToGetUsersUserArrayOutputWithContext(ctx context.Context) GetUsersUserArrayOutput
- func (i GetUsersUserArray) ToOutput(ctx context.Context) pulumix.Output[[]GetUsersUser]
- type GetUsersUserArrayInput
- type GetUsersUserArrayOutput
- func (GetUsersUserArrayOutput) ElementType() reflect.Type
- func (o GetUsersUserArrayOutput) Index(i pulumi.IntInput) GetUsersUserOutput
- func (o GetUsersUserArrayOutput) ToGetUsersUserArrayOutput() GetUsersUserArrayOutput
- func (o GetUsersUserArrayOutput) ToGetUsersUserArrayOutputWithContext(ctx context.Context) GetUsersUserArrayOutput
- func (o GetUsersUserArrayOutput) ToOutput(ctx context.Context) pulumix.Output[[]GetUsersUser]
- type GetUsersUserInput
- type GetUsersUserOutput
- func (o GetUsersUserOutput) AdminRoles() pulumi.StringArrayOutput
- func (o GetUsersUserOutput) City() pulumi.StringOutput
- func (o GetUsersUserOutput) CostCenter() pulumi.StringOutput
- func (o GetUsersUserOutput) CountryCode() pulumi.StringOutput
- func (o GetUsersUserOutput) CustomProfileAttributes() pulumi.StringOutput
- func (o GetUsersUserOutput) Department() pulumi.StringOutput
- func (o GetUsersUserOutput) DisplayName() pulumi.StringOutput
- func (o GetUsersUserOutput) Division() pulumi.StringOutput
- func (GetUsersUserOutput) ElementType() reflect.Type
- func (o GetUsersUserOutput) Email() pulumi.StringOutput
- func (o GetUsersUserOutput) EmployeeNumber() pulumi.StringOutput
- func (o GetUsersUserOutput) FirstName() pulumi.StringOutput
- func (o GetUsersUserOutput) GroupMemberships() pulumi.StringArrayOutput
- func (o GetUsersUserOutput) HonorificPrefix() pulumi.StringOutput
- func (o GetUsersUserOutput) HonorificSuffix() pulumi.StringOutput
- func (o GetUsersUserOutput) Id() pulumi.StringOutput
- func (o GetUsersUserOutput) LastName() pulumi.StringOutput
- func (o GetUsersUserOutput) Locale() pulumi.StringOutput
- func (o GetUsersUserOutput) Login() pulumi.StringOutput
- func (o GetUsersUserOutput) Manager() pulumi.StringOutput
- func (o GetUsersUserOutput) ManagerId() pulumi.StringOutput
- func (o GetUsersUserOutput) MiddleName() pulumi.StringOutput
- func (o GetUsersUserOutput) MobilePhone() pulumi.StringOutput
- func (o GetUsersUserOutput) NickName() pulumi.StringOutput
- func (o GetUsersUserOutput) Organization() pulumi.StringOutput
- func (o GetUsersUserOutput) PostalAddress() pulumi.StringOutput
- func (o GetUsersUserOutput) PreferredLanguage() pulumi.StringOutput
- func (o GetUsersUserOutput) PrimaryPhone() pulumi.StringOutput
- func (o GetUsersUserOutput) ProfileUrl() pulumi.StringOutput
- func (o GetUsersUserOutput) Roles() pulumi.StringArrayOutput
- func (o GetUsersUserOutput) SecondEmail() pulumi.StringOutput
- func (o GetUsersUserOutput) State() pulumi.StringOutput
- func (o GetUsersUserOutput) Status() pulumi.StringOutput
- func (o GetUsersUserOutput) StreetAddress() pulumi.StringOutput
- func (o GetUsersUserOutput) Timezone() pulumi.StringOutput
- func (o GetUsersUserOutput) Title() pulumi.StringOutput
- func (o GetUsersUserOutput) ToGetUsersUserOutput() GetUsersUserOutput
- func (o GetUsersUserOutput) ToGetUsersUserOutputWithContext(ctx context.Context) GetUsersUserOutput
- func (o GetUsersUserOutput) ToOutput(ctx context.Context) pulumix.Output[GetUsersUser]
- func (o GetUsersUserOutput) UserType() pulumi.StringOutput
- func (o GetUsersUserOutput) ZipCode() pulumi.StringOutput
- type LookupUserArgs
- type LookupUserOutputArgs
- type LookupUserResult
- type LookupUserResultOutput
- func (o LookupUserResultOutput) AdminRoles() pulumi.StringArrayOutput
- func (o LookupUserResultOutput) City() pulumi.StringOutput
- func (o LookupUserResultOutput) CompoundSearchOperator() pulumi.StringPtrOutput
- func (o LookupUserResultOutput) CostCenter() pulumi.StringOutput
- func (o LookupUserResultOutput) CountryCode() pulumi.StringOutput
- func (o LookupUserResultOutput) CustomProfileAttributes() pulumi.StringOutput
- func (o LookupUserResultOutput) DelayReadSeconds() pulumi.StringPtrOutput
- func (o LookupUserResultOutput) Department() pulumi.StringOutput
- func (o LookupUserResultOutput) DisplayName() pulumi.StringOutput
- func (o LookupUserResultOutput) Division() pulumi.StringOutput
- func (LookupUserResultOutput) ElementType() reflect.Type
- func (o LookupUserResultOutput) Email() pulumi.StringOutput
- func (o LookupUserResultOutput) EmployeeNumber() pulumi.StringOutput
- func (o LookupUserResultOutput) FirstName() pulumi.StringOutput
- func (o LookupUserResultOutput) GroupMemberships() pulumi.StringArrayOutput
- func (o LookupUserResultOutput) HonorificPrefix() pulumi.StringOutput
- func (o LookupUserResultOutput) HonorificSuffix() pulumi.StringOutput
- func (o LookupUserResultOutput) Id() pulumi.StringOutput
- func (o LookupUserResultOutput) LastName() pulumi.StringOutput
- func (o LookupUserResultOutput) Locale() pulumi.StringOutput
- func (o LookupUserResultOutput) Login() pulumi.StringOutput
- func (o LookupUserResultOutput) Manager() pulumi.StringOutput
- func (o LookupUserResultOutput) ManagerId() pulumi.StringOutput
- func (o LookupUserResultOutput) MiddleName() pulumi.StringOutput
- func (o LookupUserResultOutput) MobilePhone() pulumi.StringOutput
- func (o LookupUserResultOutput) NickName() pulumi.StringOutput
- func (o LookupUserResultOutput) Organization() pulumi.StringOutput
- func (o LookupUserResultOutput) PostalAddress() pulumi.StringOutput
- func (o LookupUserResultOutput) PreferredLanguage() pulumi.StringOutput
- func (o LookupUserResultOutput) PrimaryPhone() pulumi.StringOutput
- func (o LookupUserResultOutput) ProfileUrl() pulumi.StringOutput
- func (o LookupUserResultOutput) Roles() pulumi.StringArrayOutput
- func (o LookupUserResultOutput) Searches() GetUserSearchArrayOutput
- func (o LookupUserResultOutput) SecondEmail() pulumi.StringOutput
- func (o LookupUserResultOutput) SkipGroups() pulumi.BoolPtrOutput
- func (o LookupUserResultOutput) SkipRoles() pulumi.BoolPtrOutput
- func (o LookupUserResultOutput) State() pulumi.StringOutput
- func (o LookupUserResultOutput) Status() pulumi.StringOutput
- func (o LookupUserResultOutput) StreetAddress() pulumi.StringOutput
- func (o LookupUserResultOutput) Timezone() pulumi.StringOutput
- func (o LookupUserResultOutput) Title() pulumi.StringOutput
- func (o LookupUserResultOutput) ToLookupUserResultOutput() LookupUserResultOutput
- func (o LookupUserResultOutput) ToLookupUserResultOutputWithContext(ctx context.Context) LookupUserResultOutput
- func (o LookupUserResultOutput) ToOutput(ctx context.Context) pulumix.Output[LookupUserResult]
- func (o LookupUserResultOutput) UserId() pulumi.StringPtrOutput
- func (o LookupUserResultOutput) UserType() pulumi.StringOutput
- func (o LookupUserResultOutput) ZipCode() pulumi.StringOutput
- type LookupUserTypeArgs
- type LookupUserTypeOutputArgs
- type LookupUserTypeResult
- type LookupUserTypeResultOutput
- func (o LookupUserTypeResultOutput) Description() pulumi.StringOutput
- func (o LookupUserTypeResultOutput) DisplayName() pulumi.StringOutput
- func (LookupUserTypeResultOutput) ElementType() reflect.Type
- func (o LookupUserTypeResultOutput) Id() pulumi.StringOutput
- func (o LookupUserTypeResultOutput) Name() pulumi.StringOutput
- func (o LookupUserTypeResultOutput) ToLookupUserTypeResultOutput() LookupUserTypeResultOutput
- func (o LookupUserTypeResultOutput) ToLookupUserTypeResultOutputWithContext(ctx context.Context) LookupUserTypeResultOutput
- func (o LookupUserTypeResultOutput) ToOutput(ctx context.Context) pulumix.Output[LookupUserTypeResult]
- type User
- type UserArgs
- type UserArray
- type UserArrayInput
- type UserArrayOutput
- func (UserArrayOutput) ElementType() reflect.Type
- func (o UserArrayOutput) Index(i pulumi.IntInput) UserOutput
- func (o UserArrayOutput) ToOutput(ctx context.Context) pulumix.Output[[]*User]
- func (o UserArrayOutput) ToUserArrayOutput() UserArrayOutput
- func (o UserArrayOutput) ToUserArrayOutputWithContext(ctx context.Context) UserArrayOutput
- type UserInput
- type UserMap
- type UserMapInput
- type UserMapOutput
- func (UserMapOutput) ElementType() reflect.Type
- func (o UserMapOutput) MapIndex(k pulumi.StringInput) UserOutput
- func (o UserMapOutput) ToOutput(ctx context.Context) pulumix.Output[map[string]*User]
- func (o UserMapOutput) ToUserMapOutput() UserMapOutput
- func (o UserMapOutput) ToUserMapOutputWithContext(ctx context.Context) UserMapOutput
- type UserOutput
- func (o UserOutput) City() pulumi.StringPtrOutput
- func (o UserOutput) CostCenter() pulumi.StringPtrOutput
- func (o UserOutput) CountryCode() pulumi.StringPtrOutput
- func (o UserOutput) CustomProfileAttributes() pulumi.StringOutput
- func (o UserOutput) CustomProfileAttributesToIgnores() pulumi.StringArrayOutput
- func (o UserOutput) Department() pulumi.StringPtrOutput
- func (o UserOutput) DisplayName() pulumi.StringPtrOutput
- func (o UserOutput) Division() pulumi.StringPtrOutput
- func (UserOutput) ElementType() reflect.Type
- func (o UserOutput) Email() pulumi.StringOutput
- func (o UserOutput) EmployeeNumber() pulumi.StringPtrOutput
- func (o UserOutput) ExpirePasswordOnCreate() pulumi.BoolPtrOutput
- func (o UserOutput) FirstName() pulumi.StringOutput
- func (o UserOutput) HonorificPrefix() pulumi.StringPtrOutput
- func (o UserOutput) HonorificSuffix() pulumi.StringPtrOutput
- func (o UserOutput) LastName() pulumi.StringOutput
- func (o UserOutput) Locale() pulumi.StringPtrOutput
- func (o UserOutput) Login() pulumi.StringOutput
- func (o UserOutput) Manager() pulumi.StringPtrOutput
- func (o UserOutput) ManagerId() pulumi.StringPtrOutput
- func (o UserOutput) MiddleName() pulumi.StringPtrOutput
- func (o UserOutput) MobilePhone() pulumi.StringPtrOutput
- func (o UserOutput) NickName() pulumi.StringPtrOutput
- func (o UserOutput) OldPassword() pulumi.StringPtrOutput
- func (o UserOutput) Organization() pulumi.StringPtrOutput
- func (o UserOutput) Password() pulumi.StringPtrOutput
- func (o UserOutput) PasswordHash() UserPasswordHashPtrOutput
- func (o UserOutput) PasswordInlineHook() pulumi.StringPtrOutput
- func (o UserOutput) PostalAddress() pulumi.StringPtrOutput
- func (o UserOutput) PreferredLanguage() pulumi.StringPtrOutput
- func (o UserOutput) PrimaryPhone() pulumi.StringPtrOutput
- func (o UserOutput) ProfileUrl() pulumi.StringPtrOutput
- func (o UserOutput) RawStatus() pulumi.StringOutput
- func (o UserOutput) RecoveryAnswer() pulumi.StringPtrOutput
- func (o UserOutput) RecoveryQuestion() pulumi.StringPtrOutput
- func (o UserOutput) SecondEmail() pulumi.StringPtrOutput
- func (o UserOutput) SkipRoles() pulumi.BoolPtrOutputdeprecated
- func (o UserOutput) State() pulumi.StringPtrOutput
- func (o UserOutput) Status() pulumi.StringPtrOutput
- func (o UserOutput) StreetAddress() pulumi.StringPtrOutput
- func (o UserOutput) Timezone() pulumi.StringPtrOutput
- func (o UserOutput) Title() pulumi.StringPtrOutput
- func (o UserOutput) ToOutput(ctx context.Context) pulumix.Output[*User]
- func (o UserOutput) ToUserOutput() UserOutput
- func (o UserOutput) ToUserOutputWithContext(ctx context.Context) UserOutput
- func (o UserOutput) UserType() pulumi.StringPtrOutput
- func (o UserOutput) ZipCode() pulumi.StringPtrOutput
- type UserPasswordHash
- type UserPasswordHashArgs
- func (UserPasswordHashArgs) ElementType() reflect.Type
- func (i UserPasswordHashArgs) ToOutput(ctx context.Context) pulumix.Output[UserPasswordHash]
- func (i UserPasswordHashArgs) ToUserPasswordHashOutput() UserPasswordHashOutput
- func (i UserPasswordHashArgs) ToUserPasswordHashOutputWithContext(ctx context.Context) UserPasswordHashOutput
- func (i UserPasswordHashArgs) ToUserPasswordHashPtrOutput() UserPasswordHashPtrOutput
- func (i UserPasswordHashArgs) ToUserPasswordHashPtrOutputWithContext(ctx context.Context) UserPasswordHashPtrOutput
- type UserPasswordHashInput
- type UserPasswordHashOutput
- func (o UserPasswordHashOutput) Algorithm() pulumi.StringOutput
- func (UserPasswordHashOutput) ElementType() reflect.Type
- func (o UserPasswordHashOutput) Salt() pulumi.StringPtrOutput
- func (o UserPasswordHashOutput) SaltOrder() pulumi.StringPtrOutput
- func (o UserPasswordHashOutput) ToOutput(ctx context.Context) pulumix.Output[UserPasswordHash]
- func (o UserPasswordHashOutput) ToUserPasswordHashOutput() UserPasswordHashOutput
- func (o UserPasswordHashOutput) ToUserPasswordHashOutputWithContext(ctx context.Context) UserPasswordHashOutput
- func (o UserPasswordHashOutput) ToUserPasswordHashPtrOutput() UserPasswordHashPtrOutput
- func (o UserPasswordHashOutput) ToUserPasswordHashPtrOutputWithContext(ctx context.Context) UserPasswordHashPtrOutput
- func (o UserPasswordHashOutput) Value() pulumi.StringOutput
- func (o UserPasswordHashOutput) WorkFactor() pulumi.IntPtrOutput
- type UserPasswordHashPtrInput
- type UserPasswordHashPtrOutput
- func (o UserPasswordHashPtrOutput) Algorithm() pulumi.StringPtrOutput
- func (o UserPasswordHashPtrOutput) Elem() UserPasswordHashOutput
- func (UserPasswordHashPtrOutput) ElementType() reflect.Type
- func (o UserPasswordHashPtrOutput) Salt() pulumi.StringPtrOutput
- func (o UserPasswordHashPtrOutput) SaltOrder() pulumi.StringPtrOutput
- func (o UserPasswordHashPtrOutput) ToOutput(ctx context.Context) pulumix.Output[*UserPasswordHash]
- func (o UserPasswordHashPtrOutput) ToUserPasswordHashPtrOutput() UserPasswordHashPtrOutput
- func (o UserPasswordHashPtrOutput) ToUserPasswordHashPtrOutputWithContext(ctx context.Context) UserPasswordHashPtrOutput
- func (o UserPasswordHashPtrOutput) Value() pulumi.StringPtrOutput
- func (o UserPasswordHashPtrOutput) WorkFactor() pulumi.IntPtrOutput
- type UserState
- type UserType
- type UserTypeArgs
- type UserTypeArray
- type UserTypeArrayInput
- type UserTypeArrayOutput
- func (UserTypeArrayOutput) ElementType() reflect.Type
- func (o UserTypeArrayOutput) Index(i pulumi.IntInput) UserTypeOutput
- func (o UserTypeArrayOutput) ToOutput(ctx context.Context) pulumix.Output[[]*UserType]
- func (o UserTypeArrayOutput) ToUserTypeArrayOutput() UserTypeArrayOutput
- func (o UserTypeArrayOutput) ToUserTypeArrayOutputWithContext(ctx context.Context) UserTypeArrayOutput
- type UserTypeInput
- type UserTypeMap
- type UserTypeMapInput
- type UserTypeMapOutput
- func (UserTypeMapOutput) ElementType() reflect.Type
- func (o UserTypeMapOutput) MapIndex(k pulumi.StringInput) UserTypeOutput
- func (o UserTypeMapOutput) ToOutput(ctx context.Context) pulumix.Output[map[string]*UserType]
- func (o UserTypeMapOutput) ToUserTypeMapOutput() UserTypeMapOutput
- func (o UserTypeMapOutput) ToUserTypeMapOutputWithContext(ctx context.Context) UserTypeMapOutput
- type UserTypeOutput
- func (o UserTypeOutput) Description() pulumi.StringOutput
- func (o UserTypeOutput) DisplayName() pulumi.StringOutput
- func (UserTypeOutput) ElementType() reflect.Type
- func (o UserTypeOutput) Name() pulumi.StringOutput
- func (o UserTypeOutput) ToOutput(ctx context.Context) pulumix.Output[*UserType]
- func (o UserTypeOutput) ToUserTypeOutput() UserTypeOutput
- func (o UserTypeOutput) ToUserTypeOutputWithContext(ctx context.Context) UserTypeOutput
- type UserTypeState
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
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/v4/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
func (GetUserSearchArgs) ToOutput ¶ added in v4.4.0
func (i GetUserSearchArgs) ToOutput(ctx context.Context) pulumix.Output[GetUserSearch]
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
func (GetUserSearchArray) ToOutput ¶ added in v4.4.0
func (i GetUserSearchArray) ToOutput(ctx context.Context) pulumix.Output[[]GetUserSearch]
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
func (GetUserSearchArrayOutput) ToOutput ¶ added in v4.4.0
func (o GetUserSearchArrayOutput) ToOutput(ctx context.Context) pulumix.Output[[]GetUserSearch]
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 ¶
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) ToOutput ¶ added in v4.4.0
func (o GetUserSearchOutput) ToOutput(ctx context.Context) pulumix.Output[GetUserSearch]
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 ¶
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 ¶
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/v4/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/v4/go/okta/group" "github.com/pulumi/pulumi-okta/sdk/v4/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 ¶
type GetUsersResultOutput struct{ *pulumi.OutputState }
A collection of values returned by getUsers.
func GetUsersOutput ¶
func GetUsersOutput(ctx *pulumi.Context, args GetUsersOutputArgs, opts ...pulumi.InvokeOption) GetUsersResultOutput
func (GetUsersResultOutput) CompoundSearchOperator ¶
func (o GetUsersResultOutput) CompoundSearchOperator() pulumi.StringPtrOutput
func (GetUsersResultOutput) DelayReadSeconds ¶
func (o GetUsersResultOutput) DelayReadSeconds() pulumi.StringPtrOutput
func (GetUsersResultOutput) ElementType ¶
func (GetUsersResultOutput) ElementType() reflect.Type
func (GetUsersResultOutput) GroupId ¶
func (o GetUsersResultOutput) GroupId() pulumi.StringPtrOutput
func (GetUsersResultOutput) Id ¶
func (o GetUsersResultOutput) Id() pulumi.StringOutput
The provider-assigned unique ID for this managed resource.
func (GetUsersResultOutput) IncludeGroups ¶
func (o GetUsersResultOutput) IncludeGroups() pulumi.BoolPtrOutput
func (GetUsersResultOutput) IncludeRoles ¶
func (o GetUsersResultOutput) IncludeRoles() pulumi.BoolPtrOutput
func (GetUsersResultOutput) Searches ¶
func (o GetUsersResultOutput) Searches() GetUsersSearchArrayOutput
func (GetUsersResultOutput) ToGetUsersResultOutput ¶
func (o GetUsersResultOutput) ToGetUsersResultOutput() GetUsersResultOutput
func (GetUsersResultOutput) ToGetUsersResultOutputWithContext ¶
func (o GetUsersResultOutput) ToGetUsersResultOutputWithContext(ctx context.Context) GetUsersResultOutput
func (GetUsersResultOutput) ToOutput ¶ added in v4.4.0
func (o GetUsersResultOutput) ToOutput(ctx context.Context) pulumix.Output[GetUsersResult]
func (GetUsersResultOutput) Users ¶
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
func (GetUsersSearchArgs) ToOutput ¶ added in v4.4.0
func (i GetUsersSearchArgs) ToOutput(ctx context.Context) pulumix.Output[GetUsersSearch]
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
func (GetUsersSearchArray) ToOutput ¶ added in v4.4.0
func (i GetUsersSearchArray) ToOutput(ctx context.Context) pulumix.Output[[]GetUsersSearch]
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
func (GetUsersSearchArrayOutput) ToOutput ¶ added in v4.4.0
func (o GetUsersSearchArrayOutput) ToOutput(ctx context.Context) pulumix.Output[[]GetUsersSearch]
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 ¶
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) ToOutput ¶ added in v4.4.0
func (o GetUsersSearchOutput) ToOutput(ctx context.Context) pulumix.Output[GetUsersSearch]
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
func (GetUsersUserArgs) ToOutput ¶ added in v4.4.0
func (i GetUsersUserArgs) ToOutput(ctx context.Context) pulumix.Output[GetUsersUser]
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
func (GetUsersUserArray) ToOutput ¶ added in v4.4.0
func (i GetUsersUserArray) ToOutput(ctx context.Context) pulumix.Output[[]GetUsersUser]
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
func (GetUsersUserArrayOutput) ToOutput ¶ added in v4.4.0
func (o GetUsersUserArrayOutput) ToOutput(ctx context.Context) pulumix.Output[[]GetUsersUser]
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 ¶
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) ToOutput ¶ added in v4.4.0
func (o GetUsersUserOutput) ToOutput(ctx context.Context) pulumix.Output[GetUsersUser]
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"` SkipGroups *bool `pulumi:"skipGroups"` 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 ¶
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"` SkipGroups pulumi.BoolPtrInput `pulumi:"skipGroups"` 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 ¶
func (LookupUserOutputArgs) ElementType() reflect.Type
type LookupUserResult ¶
type LookupUserResult struct { 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"` 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/v4/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 ¶
type LookupUserResultOutput struct{ *pulumi.OutputState }
A collection of values returned by getUser.
func LookupUserOutput ¶
func LookupUserOutput(ctx *pulumi.Context, args LookupUserOutputArgs, opts ...pulumi.InvokeOption) LookupUserResultOutput
func (LookupUserResultOutput) AdminRoles ¶
func (o LookupUserResultOutput) AdminRoles() pulumi.StringArrayOutput
func (LookupUserResultOutput) City ¶
func (o LookupUserResultOutput) City() pulumi.StringOutput
City or locality component of user's address.
func (LookupUserResultOutput) CompoundSearchOperator ¶
func (o LookupUserResultOutput) CompoundSearchOperator() pulumi.StringPtrOutput
func (LookupUserResultOutput) CostCenter ¶
func (o LookupUserResultOutput) CostCenter() pulumi.StringOutput
Name of a cost center assigned to user.
func (LookupUserResultOutput) CountryCode ¶
func (o LookupUserResultOutput) CountryCode() pulumi.StringOutput
Country name component of user's address.
func (LookupUserResultOutput) CustomProfileAttributes ¶
func (o LookupUserResultOutput) CustomProfileAttributes() pulumi.StringOutput
Raw JSON containing all custom profile attributes.
func (LookupUserResultOutput) DelayReadSeconds ¶
func (o LookupUserResultOutput) DelayReadSeconds() pulumi.StringPtrOutput
func (LookupUserResultOutput) Department ¶
func (o LookupUserResultOutput) Department() pulumi.StringOutput
Name of user's department.
func (LookupUserResultOutput) DisplayName ¶
func (o LookupUserResultOutput) DisplayName() pulumi.StringOutput
Name of the user, suitable for display to end users.
func (LookupUserResultOutput) Division ¶
func (o LookupUserResultOutput) Division() pulumi.StringOutput
Name of user's division.
func (LookupUserResultOutput) ElementType ¶
func (LookupUserResultOutput) ElementType() reflect.Type
func (LookupUserResultOutput) Email ¶
func (o LookupUserResultOutput) Email() pulumi.StringOutput
Primary email address of user.
func (LookupUserResultOutput) EmployeeNumber ¶
func (o LookupUserResultOutput) EmployeeNumber() pulumi.StringOutput
Organization or company assigned unique identifier for the user.
func (LookupUserResultOutput) FirstName ¶
func (o LookupUserResultOutput) FirstName() pulumi.StringOutput
Given name of the user.
func (LookupUserResultOutput) GroupMemberships ¶
func (o LookupUserResultOutput) GroupMemberships() pulumi.StringArrayOutput
func (LookupUserResultOutput) HonorificPrefix ¶
func (o LookupUserResultOutput) HonorificPrefix() pulumi.StringOutput
Honorific prefix(es) of the user, or title in most Western languages.
func (LookupUserResultOutput) HonorificSuffix ¶
func (o LookupUserResultOutput) HonorificSuffix() pulumi.StringOutput
Honorific suffix(es) of the user.
func (LookupUserResultOutput) Id ¶
func (o LookupUserResultOutput) Id() pulumi.StringOutput
The provider-assigned unique ID for this managed resource.
func (LookupUserResultOutput) LastName ¶
func (o LookupUserResultOutput) LastName() pulumi.StringOutput
Family name of the user.
func (LookupUserResultOutput) Locale ¶
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 ¶
func (o LookupUserResultOutput) Login() pulumi.StringOutput
Unique identifier for the user.
func (LookupUserResultOutput) Manager ¶
func (o LookupUserResultOutput) Manager() pulumi.StringOutput
Display name of the user's manager.
func (LookupUserResultOutput) ManagerId ¶
func (o LookupUserResultOutput) ManagerId() pulumi.StringOutput
`id` of a user's manager.
func (LookupUserResultOutput) MiddleName ¶
func (o LookupUserResultOutput) MiddleName() pulumi.StringOutput
Middle name(s) of the user.
func (LookupUserResultOutput) MobilePhone ¶
func (o LookupUserResultOutput) MobilePhone() pulumi.StringOutput
Mobile phone number of user.
func (LookupUserResultOutput) NickName ¶
func (o LookupUserResultOutput) NickName() pulumi.StringOutput
Casual way to address the user in real life.
func (LookupUserResultOutput) Organization ¶
func (o LookupUserResultOutput) Organization() pulumi.StringOutput
Name of user's organization.
func (LookupUserResultOutput) PostalAddress ¶
func (o LookupUserResultOutput) PostalAddress() pulumi.StringOutput
Mailing address component of user's address.
func (LookupUserResultOutput) PreferredLanguage ¶
func (o LookupUserResultOutput) PreferredLanguage() pulumi.StringOutput
User's preferred written or spoken languages.
func (LookupUserResultOutput) PrimaryPhone ¶
func (o LookupUserResultOutput) PrimaryPhone() pulumi.StringOutput
Primary phone number of user such as home number.
func (LookupUserResultOutput) ProfileUrl ¶
func (o LookupUserResultOutput) ProfileUrl() pulumi.StringOutput
URL of user's online profile (e.g. a web page).
func (LookupUserResultOutput) Roles ¶
func (o LookupUserResultOutput) Roles() pulumi.StringArrayOutput
All roles assigned to user.
func (LookupUserResultOutput) Searches ¶
func (o LookupUserResultOutput) Searches() GetUserSearchArrayOutput
func (LookupUserResultOutput) SecondEmail ¶
func (o LookupUserResultOutput) SecondEmail() pulumi.StringOutput
Secondary email address of user typically used for account recovery.
func (LookupUserResultOutput) SkipGroups ¶
func (o LookupUserResultOutput) SkipGroups() pulumi.BoolPtrOutput
func (LookupUserResultOutput) SkipRoles ¶
func (o LookupUserResultOutput) SkipRoles() pulumi.BoolPtrOutput
func (LookupUserResultOutput) State ¶
func (o LookupUserResultOutput) State() pulumi.StringOutput
State or region component of user's address (region).
func (LookupUserResultOutput) Status ¶
func (o LookupUserResultOutput) Status() pulumi.StringOutput
Current status of user.
func (LookupUserResultOutput) StreetAddress ¶
func (o LookupUserResultOutput) StreetAddress() pulumi.StringOutput
Full street address component of user's address.
func (LookupUserResultOutput) Timezone ¶
func (o LookupUserResultOutput) Timezone() pulumi.StringOutput
User's time zone.
func (LookupUserResultOutput) Title ¶
func (o LookupUserResultOutput) Title() pulumi.StringOutput
User's title, such as "Vice President".
func (LookupUserResultOutput) ToLookupUserResultOutput ¶
func (o LookupUserResultOutput) ToLookupUserResultOutput() LookupUserResultOutput
func (LookupUserResultOutput) ToLookupUserResultOutputWithContext ¶
func (o LookupUserResultOutput) ToLookupUserResultOutputWithContext(ctx context.Context) LookupUserResultOutput
func (LookupUserResultOutput) ToOutput ¶ added in v4.4.0
func (o LookupUserResultOutput) ToOutput(ctx context.Context) pulumix.Output[LookupUserResult]
func (LookupUserResultOutput) UserId ¶
func (o LookupUserResultOutput) UserId() pulumi.StringPtrOutput
func (LookupUserResultOutput) UserType ¶
func (o LookupUserResultOutput) UserType() pulumi.StringOutput
Used to describe the organization to user relationship such as "Employee" or "Contractor".
func (LookupUserResultOutput) ZipCode ¶
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 ¶
type LookupUserTypeOutputArgs struct { // name of user type to retrieve. Name pulumi.StringInput `pulumi:"name"` }
A collection of arguments for invoking getUserType.
func (LookupUserTypeOutputArgs) ElementType ¶
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/v4/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 ¶
type LookupUserTypeResultOutput struct{ *pulumi.OutputState }
A collection of values returned by getUserType.
func LookupUserTypeOutput ¶
func LookupUserTypeOutput(ctx *pulumi.Context, args LookupUserTypeOutputArgs, opts ...pulumi.InvokeOption) LookupUserTypeResultOutput
func (LookupUserTypeResultOutput) Description ¶
func (o LookupUserTypeResultOutput) Description() pulumi.StringOutput
description of user type.
func (LookupUserTypeResultOutput) DisplayName ¶
func (o LookupUserTypeResultOutput) DisplayName() pulumi.StringOutput
display name of user type.
func (LookupUserTypeResultOutput) ElementType ¶
func (LookupUserTypeResultOutput) ElementType() reflect.Type
func (LookupUserTypeResultOutput) Id ¶
func (o LookupUserTypeResultOutput) Id() pulumi.StringOutput
The provider-assigned unique ID for this managed resource.
func (LookupUserTypeResultOutput) Name ¶
func (o LookupUserTypeResultOutput) Name() pulumi.StringOutput
name of user type.
func (LookupUserTypeResultOutput) ToLookupUserTypeResultOutput ¶
func (o LookupUserTypeResultOutput) ToLookupUserTypeResultOutput() LookupUserTypeResultOutput
func (LookupUserTypeResultOutput) ToLookupUserTypeResultOutputWithContext ¶
func (o LookupUserTypeResultOutput) ToLookupUserTypeResultOutputWithContext(ctx context.Context) LookupUserTypeResultOutput
func (LookupUserTypeResultOutput) ToOutput ¶ added in v4.4.0
func (o LookupUserTypeResultOutput) ToOutput(ctx context.Context) pulumix.Output[LookupUserTypeResult]
type User ¶
type User struct { pulumi.CustomResourceState // 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. 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. // // - `password hash` - (Optional) Specifies a hashed password to import into Okta. When updating a user with a hashed password the user must be in the `STAGED` status. // - `algorithm"` - (Required) The algorithm used to generate the hash using the password (and salt, when applicable). Must be set to BCRYPT, SHA-512, SHA-256, SHA-1 or MD5. RecoveryAnswer pulumi.StringPtrOutput `pulumi:"recoveryAnswer"` // User password recovery question. RecoveryQuestion pulumi.StringPtrOutput `pulumi:"recoveryQuestion"` // User profile property. SecondEmail pulumi.StringPtrOutput `pulumi:"secondEmail"` // Do not populate user roles information (prevents additional API call) // // Deprecated: Because admin_roles has been removed, this attribute is a no op and will be removed 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.
## Example Usage
Full profile:
```go package main
import (
"github.com/pulumi/pulumi-okta/sdk/v4/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/v4/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 <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 ¶
func (*User) ToUserOutput ¶
func (i *User) ToUserOutput() UserOutput
func (*User) ToUserOutputWithContext ¶
func (i *User) ToUserOutputWithContext(ctx context.Context) UserOutput
type UserArgs ¶
type UserArgs struct { // 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. 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. // // - `password hash` - (Optional) Specifies a hashed password to import into Okta. When updating a user with a hashed password the user must be in the `STAGED` status. // - `algorithm"` - (Required) The algorithm used to generate the hash using the password (and salt, when applicable). Must be set to BCRYPT, SHA-512, SHA-256, SHA-1 or MD5. RecoveryAnswer pulumi.StringPtrInput // User password recovery question. RecoveryQuestion pulumi.StringPtrInput // User profile property. SecondEmail pulumi.StringPtrInput // Do not populate user roles information (prevents additional API call) // // Deprecated: Because admin_roles has been removed, this attribute is a no op and will be removed 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 ¶
type UserArray ¶
type UserArray []UserInput
func (UserArray) ElementType ¶
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 ¶
func (UserMap) ElementType ¶
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) CostCenter ¶
func (o UserOutput) CostCenter() pulumi.StringPtrOutput
User profile property.
func (UserOutput) CountryCode ¶
func (o UserOutput) CountryCode() pulumi.StringPtrOutput
User profile property.
func (UserOutput) CustomProfileAttributes ¶
func (o UserOutput) CustomProfileAttributes() pulumi.StringOutput
raw JSON containing all custom profile attributes.
func (UserOutput) CustomProfileAttributesToIgnores ¶
func (o UserOutput) CustomProfileAttributesToIgnores() pulumi.StringArrayOutput
List of custom_profile_attribute keys that should be excluded from being managed by Terraform.
func (UserOutput) Department ¶
func (o UserOutput) Department() pulumi.StringPtrOutput
User profile property.
func (UserOutput) DisplayName ¶
func (o UserOutput) DisplayName() pulumi.StringPtrOutput
User profile property.
func (UserOutput) Division ¶
func (o UserOutput) Division() pulumi.StringPtrOutput
User profile property.
func (UserOutput) ElementType ¶
func (UserOutput) ElementType() reflect.Type
func (UserOutput) EmployeeNumber ¶
func (o UserOutput) EmployeeNumber() pulumi.StringPtrOutput
User profile property.
func (UserOutput) ExpirePasswordOnCreate ¶
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 ¶
func (o UserOutput) FirstName() pulumi.StringOutput
User's First Name, required by default.
func (UserOutput) HonorificPrefix ¶
func (o UserOutput) HonorificPrefix() pulumi.StringPtrOutput
User profile property.
func (UserOutput) HonorificSuffix ¶
func (o UserOutput) HonorificSuffix() pulumi.StringPtrOutput
User profile property.
func (UserOutput) LastName ¶
func (o UserOutput) LastName() pulumi.StringOutput
User's Last Name, required by default.
func (UserOutput) Locale ¶
func (o UserOutput) Locale() pulumi.StringPtrOutput
User profile property.
func (UserOutput) Manager ¶
func (o UserOutput) Manager() pulumi.StringPtrOutput
User profile property.
func (UserOutput) ManagerId ¶
func (o UserOutput) ManagerId() pulumi.StringPtrOutput
User profile property.
func (UserOutput) MiddleName ¶
func (o UserOutput) MiddleName() pulumi.StringPtrOutput
User profile property.
func (UserOutput) MobilePhone ¶
func (o UserOutput) MobilePhone() pulumi.StringPtrOutput
User profile property.
func (UserOutput) NickName ¶
func (o UserOutput) NickName() pulumi.StringPtrOutput
User profile property.
func (UserOutput) OldPassword ¶
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 ¶
func (o UserOutput) Organization() pulumi.StringPtrOutput
User profile property.
func (UserOutput) PasswordHash ¶
func (o UserOutput) PasswordHash() UserPasswordHashPtrOutput
Specifies a hashed password to import into Okta.
func (UserOutput) PasswordInlineHook ¶
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 ¶
func (o UserOutput) PostalAddress() pulumi.StringPtrOutput
User profile property.
func (UserOutput) PreferredLanguage ¶
func (o UserOutput) PreferredLanguage() pulumi.StringPtrOutput
User profile property.
func (UserOutput) PrimaryPhone ¶
func (o UserOutput) PrimaryPhone() pulumi.StringPtrOutput
User profile property.
func (UserOutput) ProfileUrl ¶
func (o UserOutput) ProfileUrl() pulumi.StringPtrOutput
User profile property.
func (UserOutput) RawStatus ¶
func (o UserOutput) RawStatus() pulumi.StringOutput
The raw status of the User in Okta - (status is mapped)
func (UserOutput) RecoveryAnswer ¶
func (o UserOutput) RecoveryAnswer() pulumi.StringPtrOutput
User password recovery answer.
- `password hash` - (Optional) Specifies a hashed password to import into Okta. When updating a user with a hashed password the user must be in the `STAGED` status. - `algorithm"` - (Required) The algorithm used to generate the hash using the password (and salt, when applicable). Must be set to BCRYPT, SHA-512, SHA-256, SHA-1 or MD5.
func (UserOutput) RecoveryQuestion ¶
func (o UserOutput) RecoveryQuestion() pulumi.StringPtrOutput
User password recovery question.
func (UserOutput) SecondEmail ¶
func (o UserOutput) SecondEmail() pulumi.StringPtrOutput
User profile property.
func (UserOutput) SkipRoles
deprecated
added in
v4.0.2
func (o UserOutput) SkipRoles() pulumi.BoolPtrOutput
Do not populate user roles information (prevents additional API call)
Deprecated: Because admin_roles has been removed, this attribute is a no op and will be removed
func (UserOutput) Status ¶
func (o UserOutput) Status() pulumi.StringPtrOutput
User profile property. Valid values are "ACTIVE", "DEPROVISIONED", "STAGED", "SUSPENDED"
func (UserOutput) StreetAddress ¶
func (o UserOutput) StreetAddress() pulumi.StringPtrOutput
User profile property.
func (UserOutput) Timezone ¶
func (o UserOutput) Timezone() 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 ¶
func (o UserOutput) UserType() pulumi.StringPtrOutput
User profile property.
func (UserOutput) ZipCode ¶
func (o UserOutput) ZipCode() pulumi.StringPtrOutput
User profile property.
type UserPasswordHash ¶
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 ¶
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 ¶
func (UserPasswordHashArgs) ElementType() reflect.Type
func (UserPasswordHashArgs) ToOutput ¶ added in v4.4.0
func (i UserPasswordHashArgs) ToOutput(ctx context.Context) pulumix.Output[UserPasswordHash]
func (UserPasswordHashArgs) ToUserPasswordHashOutput ¶
func (i UserPasswordHashArgs) ToUserPasswordHashOutput() UserPasswordHashOutput
func (UserPasswordHashArgs) ToUserPasswordHashOutputWithContext ¶
func (i UserPasswordHashArgs) ToUserPasswordHashOutputWithContext(ctx context.Context) UserPasswordHashOutput
func (UserPasswordHashArgs) ToUserPasswordHashPtrOutput ¶
func (i UserPasswordHashArgs) ToUserPasswordHashPtrOutput() UserPasswordHashPtrOutput
func (UserPasswordHashArgs) ToUserPasswordHashPtrOutputWithContext ¶
func (i UserPasswordHashArgs) ToUserPasswordHashPtrOutputWithContext(ctx context.Context) UserPasswordHashPtrOutput
type UserPasswordHashInput ¶
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 ¶
type UserPasswordHashOutput struct{ *pulumi.OutputState }
func (UserPasswordHashOutput) Algorithm ¶
func (o UserPasswordHashOutput) Algorithm() pulumi.StringOutput
func (UserPasswordHashOutput) ElementType ¶
func (UserPasswordHashOutput) ElementType() reflect.Type
func (UserPasswordHashOutput) Salt ¶
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 ¶
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) ToOutput ¶ added in v4.4.0
func (o UserPasswordHashOutput) ToOutput(ctx context.Context) pulumix.Output[UserPasswordHash]
func (UserPasswordHashOutput) ToUserPasswordHashOutput ¶
func (o UserPasswordHashOutput) ToUserPasswordHashOutput() UserPasswordHashOutput
func (UserPasswordHashOutput) ToUserPasswordHashOutputWithContext ¶
func (o UserPasswordHashOutput) ToUserPasswordHashOutputWithContext(ctx context.Context) UserPasswordHashOutput
func (UserPasswordHashOutput) ToUserPasswordHashPtrOutput ¶
func (o UserPasswordHashOutput) ToUserPasswordHashPtrOutput() UserPasswordHashPtrOutput
func (UserPasswordHashOutput) ToUserPasswordHashPtrOutputWithContext ¶
func (o UserPasswordHashOutput) ToUserPasswordHashPtrOutputWithContext(ctx context.Context) UserPasswordHashPtrOutput
func (UserPasswordHashOutput) Value ¶
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 ¶
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 ¶
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 ¶
func UserPasswordHashPtr(v *UserPasswordHashArgs) UserPasswordHashPtrInput
type UserPasswordHashPtrOutput ¶
type UserPasswordHashPtrOutput struct{ *pulumi.OutputState }
func (UserPasswordHashPtrOutput) Algorithm ¶
func (o UserPasswordHashPtrOutput) Algorithm() pulumi.StringPtrOutput
func (UserPasswordHashPtrOutput) Elem ¶
func (o UserPasswordHashPtrOutput) Elem() UserPasswordHashOutput
func (UserPasswordHashPtrOutput) ElementType ¶
func (UserPasswordHashPtrOutput) ElementType() reflect.Type
func (UserPasswordHashPtrOutput) Salt ¶
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 ¶
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) ToOutput ¶ added in v4.4.0
func (o UserPasswordHashPtrOutput) ToOutput(ctx context.Context) pulumix.Output[*UserPasswordHash]
func (UserPasswordHashPtrOutput) ToUserPasswordHashPtrOutput ¶
func (o UserPasswordHashPtrOutput) ToUserPasswordHashPtrOutput() UserPasswordHashPtrOutput
func (UserPasswordHashPtrOutput) ToUserPasswordHashPtrOutputWithContext ¶
func (o UserPasswordHashPtrOutput) ToUserPasswordHashPtrOutputWithContext(ctx context.Context) UserPasswordHashPtrOutput
func (UserPasswordHashPtrOutput) Value ¶
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 ¶
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 { // 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. 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. // // - `password hash` - (Optional) Specifies a hashed password to import into Okta. When updating a user with a hashed password the user must be in the `STAGED` status. // - `algorithm"` - (Required) The algorithm used to generate the hash using the password (and salt, when applicable). Must be set to BCRYPT, SHA-512, SHA-256, SHA-1 or MD5. RecoveryAnswer pulumi.StringPtrInput // User password recovery question. RecoveryQuestion pulumi.StringPtrInput // User profile property. SecondEmail pulumi.StringPtrInput // Do not populate user roles information (prevents additional API call) // // Deprecated: Because admin_roles has been removed, this attribute is a no op and will be removed 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 ¶
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/v4/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 <user type id>
```
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) 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 ¶
func (o UserTypeOutput) Description() pulumi.StringOutput
Description of the User Type.
func (UserTypeOutput) DisplayName ¶
func (o UserTypeOutput) DisplayName() pulumi.StringOutput
Display Name of the User Type.
func (UserTypeOutput) ElementType ¶
func (UserTypeOutput) ElementType() reflect.Type
func (UserTypeOutput) Name ¶
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