1. Packages
  2. Okta
  3. API Docs
  4. user
  5. User
Okta v4.8.0 published on Saturday, Mar 2, 2024 by Pulumi

okta.user.User

Explore with Pulumi AI

okta logo
Okta v4.8.0 published on Saturday, Mar 2, 2024 by Pulumi

    Creates an Okta User.

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

    Example Usage

    Full profile

    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Okta = Pulumi.Okta;
    
    return await Deployment.RunAsync(() => 
    {
        var example = new Okta.User.User("example", new()
        {
            City = "New York",
            CostCenter = "10",
            CountryCode = "US",
            Department = "IT",
            DisplayName = "Dr. John Smith",
            Division = "Acquisitions",
            Email = "john.smith@example.com",
            EmployeeNumber = "111111",
            FirstName = "John",
            HonorificPrefix = "Dr.",
            HonorificSuffix = "Jr.",
            LastName = "Smith",
            Locale = "en_US",
            Login = "john.smith@example.com",
            Manager = "Jimbo",
            ManagerId = "222222",
            MiddleName = "John",
            MobilePhone = "1112223333",
            NickName = "Johnny",
            Organization = "Testing Inc.",
            PostalAddress = "1234 Testing St.",
            PreferredLanguage = "en-us",
            PrimaryPhone = "4445556666",
            ProfileUrl = "https://www.example.com/profile",
            SecondEmail = "john.smith.fun@example.com",
            State = "NY",
            StreetAddress = "5678 Testing Ave.",
            Timezone = "America/New_York",
            Title = "Director",
            UserType = "Employee",
            ZipCode = "11111",
        });
    
    });
    
    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
    	})
    }
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.okta.user.User;
    import com.pulumi.okta.user.UserArgs;
    import java.util.List;
    import java.util.ArrayList;
    import java.util.Map;
    import java.io.File;
    import java.nio.file.Files;
    import java.nio.file.Paths;
    
    public class App {
        public static void main(String[] args) {
            Pulumi.run(App::stack);
        }
    
        public static void stack(Context ctx) {
            var example = new User("example", UserArgs.builder()        
                .city("New York")
                .costCenter("10")
                .countryCode("US")
                .department("IT")
                .displayName("Dr. John Smith")
                .division("Acquisitions")
                .email("john.smith@example.com")
                .employeeNumber("111111")
                .firstName("John")
                .honorificPrefix("Dr.")
                .honorificSuffix("Jr.")
                .lastName("Smith")
                .locale("en_US")
                .login("john.smith@example.com")
                .manager("Jimbo")
                .managerId("222222")
                .middleName("John")
                .mobilePhone("1112223333")
                .nickName("Johnny")
                .organization("Testing Inc.")
                .postalAddress("1234 Testing St.")
                .preferredLanguage("en-us")
                .primaryPhone("4445556666")
                .profileUrl("https://www.example.com/profile")
                .secondEmail("john.smith.fun@example.com")
                .state("NY")
                .streetAddress("5678 Testing Ave.")
                .timezone("America/New_York")
                .title("Director")
                .userType("Employee")
                .zipCode("11111")
                .build());
    
        }
    }
    
    import pulumi
    import pulumi_okta as okta
    
    example = okta.user.User("example",
        city="New York",
        cost_center="10",
        country_code="US",
        department="IT",
        display_name="Dr. John Smith",
        division="Acquisitions",
        email="john.smith@example.com",
        employee_number="111111",
        first_name="John",
        honorific_prefix="Dr.",
        honorific_suffix="Jr.",
        last_name="Smith",
        locale="en_US",
        login="john.smith@example.com",
        manager="Jimbo",
        manager_id="222222",
        middle_name="John",
        mobile_phone="1112223333",
        nick_name="Johnny",
        organization="Testing Inc.",
        postal_address="1234 Testing St.",
        preferred_language="en-us",
        primary_phone="4445556666",
        profile_url="https://www.example.com/profile",
        second_email="john.smith.fun@example.com",
        state="NY",
        street_address="5678 Testing Ave.",
        timezone="America/New_York",
        title="Director",
        user_type="Employee",
        zip_code="11111")
    
    import * as pulumi from "@pulumi/pulumi";
    import * as okta from "@pulumi/okta";
    
    const example = new okta.user.User("example", {
        city: "New York",
        costCenter: "10",
        countryCode: "US",
        department: "IT",
        displayName: "Dr. John Smith",
        division: "Acquisitions",
        email: "john.smith@example.com",
        employeeNumber: "111111",
        firstName: "John",
        honorificPrefix: "Dr.",
        honorificSuffix: "Jr.",
        lastName: "Smith",
        locale: "en_US",
        login: "john.smith@example.com",
        manager: "Jimbo",
        managerId: "222222",
        middleName: "John",
        mobilePhone: "1112223333",
        nickName: "Johnny",
        organization: "Testing Inc.",
        postalAddress: "1234 Testing St.",
        preferredLanguage: "en-us",
        primaryPhone: "4445556666",
        profileUrl: "https://www.example.com/profile",
        secondEmail: "john.smith.fun@example.com",
        state: "NY",
        streetAddress: "5678 Testing Ave.",
        timezone: "America/New_York",
        title: "Director",
        userType: "Employee",
        zipCode: "11111",
    });
    
    resources:
      example:
        type: okta:user:User
        properties:
          city: New York
          costCenter: '10'
          countryCode: US
          department: IT
          displayName: Dr. John Smith
          division: Acquisitions
          email: john.smith@example.com
          employeeNumber: '111111'
          firstName: John
          honorificPrefix: Dr.
          honorificSuffix: Jr.
          lastName: Smith
          locale: en_US
          login: john.smith@example.com
          manager: Jimbo
          managerId: '222222'
          middleName: John
          mobilePhone: '1112223333'
          nickName: Johnny
          organization: Testing Inc.
          postalAddress: 1234 Testing St.
          preferredLanguage: en-us
          primaryPhone: '4445556666'
          profileUrl: https://www.example.com/profile
          secondEmail: john.smith.fun@example.com
          state: NY
          streetAddress: 5678 Testing Ave.
          timezone: America/New_York
          title: Director
          userType: Employee
          zipCode: '11111'
    

    With Password Inline Hook

    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Okta = Pulumi.Okta;
    
    return await Deployment.RunAsync(() => 
    {
        var test2 = new Okta.User.User("test2", new()
        {
            Email = "example@example.com",
            FirstName = "John",
            LastName = "Smith",
            Login = "example@example.com",
            PasswordInlineHook = "default",
        });
    
    });
    
    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
    	})
    }
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.okta.user.User;
    import com.pulumi.okta.user.UserArgs;
    import java.util.List;
    import java.util.ArrayList;
    import java.util.Map;
    import java.io.File;
    import java.nio.file.Files;
    import java.nio.file.Paths;
    
    public class App {
        public static void main(String[] args) {
            Pulumi.run(App::stack);
        }
    
        public static void stack(Context ctx) {
            var test2 = new User("test2", UserArgs.builder()        
                .email("example@example.com")
                .firstName("John")
                .lastName("Smith")
                .login("example@example.com")
                .passwordInlineHook("default")
                .build());
    
        }
    }
    
    import pulumi
    import pulumi_okta as okta
    
    test2 = okta.user.User("test2",
        email="example@example.com",
        first_name="John",
        last_name="Smith",
        login="example@example.com",
        password_inline_hook="default")
    
    import * as pulumi from "@pulumi/pulumi";
    import * as okta from "@pulumi/okta";
    
    const test2 = new okta.user.User("test2", {
        email: "example@example.com",
        firstName: "John",
        lastName: "Smith",
        login: "example@example.com",
        passwordInlineHook: "default",
    });
    
    resources:
      test2:
        type: okta:user:User
        properties:
          email: example@example.com
          firstName: John
          lastName: Smith
          login: example@example.com
          passwordInlineHook: default
    

    Create User Resource

    new User(name: string, args: UserArgs, opts?: CustomResourceOptions);
    @overload
    def User(resource_name: str,
             opts: Optional[ResourceOptions] = None,
             city: Optional[str] = None,
             cost_center: Optional[str] = None,
             country_code: Optional[str] = None,
             custom_profile_attributes: Optional[str] = None,
             custom_profile_attributes_to_ignores: Optional[Sequence[str]] = None,
             department: Optional[str] = None,
             display_name: Optional[str] = None,
             division: Optional[str] = None,
             email: Optional[str] = None,
             employee_number: Optional[str] = None,
             expire_password_on_create: Optional[bool] = None,
             first_name: Optional[str] = None,
             honorific_prefix: Optional[str] = None,
             honorific_suffix: Optional[str] = None,
             last_name: Optional[str] = None,
             locale: Optional[str] = None,
             login: Optional[str] = None,
             manager: Optional[str] = None,
             manager_id: Optional[str] = None,
             middle_name: Optional[str] = None,
             mobile_phone: Optional[str] = None,
             nick_name: Optional[str] = None,
             old_password: Optional[str] = None,
             organization: Optional[str] = None,
             password: Optional[str] = None,
             password_hash: Optional[UserPasswordHashArgs] = None,
             password_inline_hook: Optional[str] = None,
             postal_address: Optional[str] = None,
             preferred_language: Optional[str] = None,
             primary_phone: Optional[str] = None,
             profile_url: Optional[str] = None,
             recovery_answer: Optional[str] = None,
             recovery_question: Optional[str] = None,
             second_email: Optional[str] = None,
             skip_roles: Optional[bool] = None,
             state: Optional[str] = None,
             status: Optional[str] = None,
             street_address: Optional[str] = None,
             timezone: Optional[str] = None,
             title: Optional[str] = None,
             user_type: Optional[str] = None,
             zip_code: Optional[str] = None)
    @overload
    def User(resource_name: str,
             args: UserArgs,
             opts: Optional[ResourceOptions] = None)
    func NewUser(ctx *Context, name string, args UserArgs, opts ...ResourceOption) (*User, error)
    public User(string name, UserArgs args, CustomResourceOptions? opts = null)
    public User(String name, UserArgs args)
    public User(String name, UserArgs args, CustomResourceOptions options)
    
    type: okta:user:User
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    
    name string
    The unique name of the resource.
    args UserArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args UserArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args UserArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args UserArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args UserArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    User Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    The User resource accepts the following input properties:

    Email string
    User profile property.
    FirstName string
    User's First Name, required by default.
    LastName string
    User's Last Name, required by default.
    Login string
    User profile property.
    City string
    User profile property.
    CostCenter string
    User profile property.
    CountryCode string
    User profile property.
    CustomProfileAttributes string
    raw JSON containing all custom profile attributes.
    CustomProfileAttributesToIgnores List<string>
    List of custom_profile_attribute keys that should be excluded from being managed by Terraform.
    Department string
    User profile property.
    DisplayName string
    User profile property.
    Division string
    User profile property.
    EmployeeNumber string
    User profile property.
    ExpirePasswordOnCreate bool
    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.
    HonorificPrefix string
    User profile property.
    HonorificSuffix string
    User profile property.
    Locale string
    User profile property.
    Manager string
    User profile property.
    ManagerId string
    User profile property.
    MiddleName string
    User profile property.
    MobilePhone string
    User profile property.
    NickName string
    User profile property.
    OldPassword string
    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.
    Organization string
    User profile property.
    Password string
    User password.
    PasswordHash UserPasswordHash
    Specifies a hashed password to import into Okta.
    PasswordInlineHook string
    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.
    PostalAddress string
    User profile property.
    PreferredLanguage string
    User profile property.
    PrimaryPhone string
    User profile property.
    ProfileUrl string
    User profile property.
    RecoveryAnswer string
    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.
    RecoveryQuestion string
    User password recovery question.
    SecondEmail string
    User profile property.
    SkipRoles bool
    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

    State string
    User profile property.
    Status string
    User profile property. Valid values are "ACTIVE", "DEPROVISIONED", "STAGED", "SUSPENDED"
    StreetAddress string
    User profile property.
    Timezone string
    User profile property.
    Title string
    User profile property.
    UserType string
    User profile property.
    ZipCode string
    User profile property.
    Email string
    User profile property.
    FirstName string
    User's First Name, required by default.
    LastName string
    User's Last Name, required by default.
    Login string
    User profile property.
    City string
    User profile property.
    CostCenter string
    User profile property.
    CountryCode string
    User profile property.
    CustomProfileAttributes string
    raw JSON containing all custom profile attributes.
    CustomProfileAttributesToIgnores []string
    List of custom_profile_attribute keys that should be excluded from being managed by Terraform.
    Department string
    User profile property.
    DisplayName string
    User profile property.
    Division string
    User profile property.
    EmployeeNumber string
    User profile property.
    ExpirePasswordOnCreate bool
    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.
    HonorificPrefix string
    User profile property.
    HonorificSuffix string
    User profile property.
    Locale string
    User profile property.
    Manager string
    User profile property.
    ManagerId string
    User profile property.
    MiddleName string
    User profile property.
    MobilePhone string
    User profile property.
    NickName string
    User profile property.
    OldPassword string
    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.
    Organization string
    User profile property.
    Password string
    User password.
    PasswordHash UserPasswordHashArgs
    Specifies a hashed password to import into Okta.
    PasswordInlineHook string
    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.
    PostalAddress string
    User profile property.
    PreferredLanguage string
    User profile property.
    PrimaryPhone string
    User profile property.
    ProfileUrl string
    User profile property.
    RecoveryAnswer string
    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.
    RecoveryQuestion string
    User password recovery question.
    SecondEmail string
    User profile property.
    SkipRoles bool
    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

    State string
    User profile property.
    Status string
    User profile property. Valid values are "ACTIVE", "DEPROVISIONED", "STAGED", "SUSPENDED"
    StreetAddress string
    User profile property.
    Timezone string
    User profile property.
    Title string
    User profile property.
    UserType string
    User profile property.
    ZipCode string
    User profile property.
    email String
    User profile property.
    firstName String
    User's First Name, required by default.
    lastName String
    User's Last Name, required by default.
    login String
    User profile property.
    city String
    User profile property.
    costCenter String
    User profile property.
    countryCode String
    User profile property.
    customProfileAttributes String
    raw JSON containing all custom profile attributes.
    customProfileAttributesToIgnores List<String>
    List of custom_profile_attribute keys that should be excluded from being managed by Terraform.
    department String
    User profile property.
    displayName String
    User profile property.
    division String
    User profile property.
    employeeNumber String
    User profile property.
    expirePasswordOnCreate Boolean
    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.
    honorificPrefix String
    User profile property.
    honorificSuffix String
    User profile property.
    locale String
    User profile property.
    manager String
    User profile property.
    managerId String
    User profile property.
    middleName String
    User profile property.
    mobilePhone String
    User profile property.
    nickName String
    User profile property.
    oldPassword String
    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.
    organization String
    User profile property.
    password String
    User password.
    passwordHash UserPasswordHash
    Specifies a hashed password to import into Okta.
    passwordInlineHook String
    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.
    postalAddress String
    User profile property.
    preferredLanguage String
    User profile property.
    primaryPhone String
    User profile property.
    profileUrl String
    User profile property.
    recoveryAnswer String
    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.
    recoveryQuestion String
    User password recovery question.
    secondEmail String
    User profile property.
    skipRoles Boolean
    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

    state String
    User profile property.
    status String
    User profile property. Valid values are "ACTIVE", "DEPROVISIONED", "STAGED", "SUSPENDED"
    streetAddress String
    User profile property.
    timezone String
    User profile property.
    title String
    User profile property.
    userType String
    User profile property.
    zipCode String
    User profile property.
    email string
    User profile property.
    firstName string
    User's First Name, required by default.
    lastName string
    User's Last Name, required by default.
    login string
    User profile property.
    city string
    User profile property.
    costCenter string
    User profile property.
    countryCode string
    User profile property.
    customProfileAttributes string
    raw JSON containing all custom profile attributes.
    customProfileAttributesToIgnores string[]
    List of custom_profile_attribute keys that should be excluded from being managed by Terraform.
    department string
    User profile property.
    displayName string
    User profile property.
    division string
    User profile property.
    employeeNumber string
    User profile property.
    expirePasswordOnCreate boolean
    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.
    honorificPrefix string
    User profile property.
    honorificSuffix string
    User profile property.
    locale string
    User profile property.
    manager string
    User profile property.
    managerId string
    User profile property.
    middleName string
    User profile property.
    mobilePhone string
    User profile property.
    nickName string
    User profile property.
    oldPassword string
    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.
    organization string
    User profile property.
    password string
    User password.
    passwordHash UserPasswordHash
    Specifies a hashed password to import into Okta.
    passwordInlineHook string
    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.
    postalAddress string
    User profile property.
    preferredLanguage string
    User profile property.
    primaryPhone string
    User profile property.
    profileUrl string
    User profile property.
    recoveryAnswer string
    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.
    recoveryQuestion string
    User password recovery question.
    secondEmail string
    User profile property.
    skipRoles boolean
    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

    state string
    User profile property.
    status string
    User profile property. Valid values are "ACTIVE", "DEPROVISIONED", "STAGED", "SUSPENDED"
    streetAddress string
    User profile property.
    timezone string
    User profile property.
    title string
    User profile property.
    userType string
    User profile property.
    zipCode string
    User profile property.
    email str
    User profile property.
    first_name str
    User's First Name, required by default.
    last_name str
    User's Last Name, required by default.
    login str
    User profile property.
    city str
    User profile property.
    cost_center str
    User profile property.
    country_code str
    User profile property.
    custom_profile_attributes str
    raw JSON containing all custom profile attributes.
    custom_profile_attributes_to_ignores Sequence[str]
    List of custom_profile_attribute keys that should be excluded from being managed by Terraform.
    department str
    User profile property.
    display_name str
    User profile property.
    division str
    User profile property.
    employee_number str
    User profile property.
    expire_password_on_create bool
    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.
    honorific_prefix str
    User profile property.
    honorific_suffix str
    User profile property.
    locale str
    User profile property.
    manager str
    User profile property.
    manager_id str
    User profile property.
    middle_name str
    User profile property.
    mobile_phone str
    User profile property.
    nick_name str
    User profile property.
    old_password str
    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.
    organization str
    User profile property.
    password str
    User password.
    password_hash UserPasswordHashArgs
    Specifies a hashed password to import into Okta.
    password_inline_hook str
    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.
    postal_address str
    User profile property.
    preferred_language str
    User profile property.
    primary_phone str
    User profile property.
    profile_url str
    User profile property.
    recovery_answer str
    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.
    recovery_question str
    User password recovery question.
    second_email str
    User profile property.
    skip_roles bool
    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

    state str
    User profile property.
    status str
    User profile property. Valid values are "ACTIVE", "DEPROVISIONED", "STAGED", "SUSPENDED"
    street_address str
    User profile property.
    timezone str
    User profile property.
    title str
    User profile property.
    user_type str
    User profile property.
    zip_code str
    User profile property.
    email String
    User profile property.
    firstName String
    User's First Name, required by default.
    lastName String
    User's Last Name, required by default.
    login String
    User profile property.
    city String
    User profile property.
    costCenter String
    User profile property.
    countryCode String
    User profile property.
    customProfileAttributes String
    raw JSON containing all custom profile attributes.
    customProfileAttributesToIgnores List<String>
    List of custom_profile_attribute keys that should be excluded from being managed by Terraform.
    department String
    User profile property.
    displayName String
    User profile property.
    division String
    User profile property.
    employeeNumber String
    User profile property.
    expirePasswordOnCreate Boolean
    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.
    honorificPrefix String
    User profile property.
    honorificSuffix String
    User profile property.
    locale String
    User profile property.
    manager String
    User profile property.
    managerId String
    User profile property.
    middleName String
    User profile property.
    mobilePhone String
    User profile property.
    nickName String
    User profile property.
    oldPassword String
    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.
    organization String
    User profile property.
    password String
    User password.
    passwordHash Property Map
    Specifies a hashed password to import into Okta.
    passwordInlineHook String
    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.
    postalAddress String
    User profile property.
    preferredLanguage String
    User profile property.
    primaryPhone String
    User profile property.
    profileUrl String
    User profile property.
    recoveryAnswer String
    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.
    recoveryQuestion String
    User password recovery question.
    secondEmail String
    User profile property.
    skipRoles Boolean
    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

    state String
    User profile property.
    status String
    User profile property. Valid values are "ACTIVE", "DEPROVISIONED", "STAGED", "SUSPENDED"
    streetAddress String
    User profile property.
    timezone String
    User profile property.
    title String
    User profile property.
    userType String
    User profile property.
    zipCode String
    User profile property.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the User resource produces the following output properties:

    Id string
    The provider-assigned unique ID for this managed resource.
    RawStatus string
    The raw status of the User in Okta - (status is mapped)
    Id string
    The provider-assigned unique ID for this managed resource.
    RawStatus string
    The raw status of the User in Okta - (status is mapped)
    id String
    The provider-assigned unique ID for this managed resource.
    rawStatus String
    The raw status of the User in Okta - (status is mapped)
    id string
    The provider-assigned unique ID for this managed resource.
    rawStatus string
    The raw status of the User in Okta - (status is mapped)
    id str
    The provider-assigned unique ID for this managed resource.
    raw_status str
    The raw status of the User in Okta - (status is mapped)
    id String
    The provider-assigned unique ID for this managed resource.
    rawStatus String
    The raw status of the User in Okta - (status is mapped)

    Look up Existing User Resource

    Get an existing User resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: UserState, opts?: CustomResourceOptions): User
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            city: Optional[str] = None,
            cost_center: Optional[str] = None,
            country_code: Optional[str] = None,
            custom_profile_attributes: Optional[str] = None,
            custom_profile_attributes_to_ignores: Optional[Sequence[str]] = None,
            department: Optional[str] = None,
            display_name: Optional[str] = None,
            division: Optional[str] = None,
            email: Optional[str] = None,
            employee_number: Optional[str] = None,
            expire_password_on_create: Optional[bool] = None,
            first_name: Optional[str] = None,
            honorific_prefix: Optional[str] = None,
            honorific_suffix: Optional[str] = None,
            last_name: Optional[str] = None,
            locale: Optional[str] = None,
            login: Optional[str] = None,
            manager: Optional[str] = None,
            manager_id: Optional[str] = None,
            middle_name: Optional[str] = None,
            mobile_phone: Optional[str] = None,
            nick_name: Optional[str] = None,
            old_password: Optional[str] = None,
            organization: Optional[str] = None,
            password: Optional[str] = None,
            password_hash: Optional[UserPasswordHashArgs] = None,
            password_inline_hook: Optional[str] = None,
            postal_address: Optional[str] = None,
            preferred_language: Optional[str] = None,
            primary_phone: Optional[str] = None,
            profile_url: Optional[str] = None,
            raw_status: Optional[str] = None,
            recovery_answer: Optional[str] = None,
            recovery_question: Optional[str] = None,
            second_email: Optional[str] = None,
            skip_roles: Optional[bool] = None,
            state: Optional[str] = None,
            status: Optional[str] = None,
            street_address: Optional[str] = None,
            timezone: Optional[str] = None,
            title: Optional[str] = None,
            user_type: Optional[str] = None,
            zip_code: Optional[str] = None) -> User
    func GetUser(ctx *Context, name string, id IDInput, state *UserState, opts ...ResourceOption) (*User, error)
    public static User Get(string name, Input<string> id, UserState? state, CustomResourceOptions? opts = null)
    public static User get(String name, Output<String> id, UserState state, CustomResourceOptions options)
    Resource lookup is not supported in YAML
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    City string
    User profile property.
    CostCenter string
    User profile property.
    CountryCode string
    User profile property.
    CustomProfileAttributes string
    raw JSON containing all custom profile attributes.
    CustomProfileAttributesToIgnores List<string>
    List of custom_profile_attribute keys that should be excluded from being managed by Terraform.
    Department string
    User profile property.
    DisplayName string
    User profile property.
    Division string
    User profile property.
    Email string
    User profile property.
    EmployeeNumber string
    User profile property.
    ExpirePasswordOnCreate bool
    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.
    FirstName string
    User's First Name, required by default.
    HonorificPrefix string
    User profile property.
    HonorificSuffix string
    User profile property.
    LastName string
    User's Last Name, required by default.
    Locale string
    User profile property.
    Login string
    User profile property.
    Manager string
    User profile property.
    ManagerId string
    User profile property.
    MiddleName string
    User profile property.
    MobilePhone string
    User profile property.
    NickName string
    User profile property.
    OldPassword string
    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.
    Organization string
    User profile property.
    Password string
    User password.
    PasswordHash UserPasswordHash
    Specifies a hashed password to import into Okta.
    PasswordInlineHook string
    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.
    PostalAddress string
    User profile property.
    PreferredLanguage string
    User profile property.
    PrimaryPhone string
    User profile property.
    ProfileUrl string
    User profile property.
    RawStatus string
    The raw status of the User in Okta - (status is mapped)
    RecoveryAnswer string
    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.
    RecoveryQuestion string
    User password recovery question.
    SecondEmail string
    User profile property.
    SkipRoles bool
    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

    State string
    User profile property.
    Status string
    User profile property. Valid values are "ACTIVE", "DEPROVISIONED", "STAGED", "SUSPENDED"
    StreetAddress string
    User profile property.
    Timezone string
    User profile property.
    Title string
    User profile property.
    UserType string
    User profile property.
    ZipCode string
    User profile property.
    City string
    User profile property.
    CostCenter string
    User profile property.
    CountryCode string
    User profile property.
    CustomProfileAttributes string
    raw JSON containing all custom profile attributes.
    CustomProfileAttributesToIgnores []string
    List of custom_profile_attribute keys that should be excluded from being managed by Terraform.
    Department string
    User profile property.
    DisplayName string
    User profile property.
    Division string
    User profile property.
    Email string
    User profile property.
    EmployeeNumber string
    User profile property.
    ExpirePasswordOnCreate bool
    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.
    FirstName string
    User's First Name, required by default.
    HonorificPrefix string
    User profile property.
    HonorificSuffix string
    User profile property.
    LastName string
    User's Last Name, required by default.
    Locale string
    User profile property.
    Login string
    User profile property.
    Manager string
    User profile property.
    ManagerId string
    User profile property.
    MiddleName string
    User profile property.
    MobilePhone string
    User profile property.
    NickName string
    User profile property.
    OldPassword string
    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.
    Organization string
    User profile property.
    Password string
    User password.
    PasswordHash UserPasswordHashArgs
    Specifies a hashed password to import into Okta.
    PasswordInlineHook string
    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.
    PostalAddress string
    User profile property.
    PreferredLanguage string
    User profile property.
    PrimaryPhone string
    User profile property.
    ProfileUrl string
    User profile property.
    RawStatus string
    The raw status of the User in Okta - (status is mapped)
    RecoveryAnswer string
    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.
    RecoveryQuestion string
    User password recovery question.
    SecondEmail string
    User profile property.
    SkipRoles bool
    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

    State string
    User profile property.
    Status string
    User profile property. Valid values are "ACTIVE", "DEPROVISIONED", "STAGED", "SUSPENDED"
    StreetAddress string
    User profile property.
    Timezone string
    User profile property.
    Title string
    User profile property.
    UserType string
    User profile property.
    ZipCode string
    User profile property.
    city String
    User profile property.
    costCenter String
    User profile property.
    countryCode String
    User profile property.
    customProfileAttributes String
    raw JSON containing all custom profile attributes.
    customProfileAttributesToIgnores List<String>
    List of custom_profile_attribute keys that should be excluded from being managed by Terraform.
    department String
    User profile property.
    displayName String
    User profile property.
    division String
    User profile property.
    email String
    User profile property.
    employeeNumber String
    User profile property.
    expirePasswordOnCreate Boolean
    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.
    firstName String
    User's First Name, required by default.
    honorificPrefix String
    User profile property.
    honorificSuffix String
    User profile property.
    lastName String
    User's Last Name, required by default.
    locale String
    User profile property.
    login String
    User profile property.
    manager String
    User profile property.
    managerId String
    User profile property.
    middleName String
    User profile property.
    mobilePhone String
    User profile property.
    nickName String
    User profile property.
    oldPassword String
    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.
    organization String
    User profile property.
    password String
    User password.
    passwordHash UserPasswordHash
    Specifies a hashed password to import into Okta.
    passwordInlineHook String
    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.
    postalAddress String
    User profile property.
    preferredLanguage String
    User profile property.
    primaryPhone String
    User profile property.
    profileUrl String
    User profile property.
    rawStatus String
    The raw status of the User in Okta - (status is mapped)
    recoveryAnswer String
    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.
    recoveryQuestion String
    User password recovery question.
    secondEmail String
    User profile property.
    skipRoles Boolean
    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

    state String
    User profile property.
    status String
    User profile property. Valid values are "ACTIVE", "DEPROVISIONED", "STAGED", "SUSPENDED"
    streetAddress String
    User profile property.
    timezone String
    User profile property.
    title String
    User profile property.
    userType String
    User profile property.
    zipCode String
    User profile property.
    city string
    User profile property.
    costCenter string
    User profile property.
    countryCode string
    User profile property.
    customProfileAttributes string
    raw JSON containing all custom profile attributes.
    customProfileAttributesToIgnores string[]
    List of custom_profile_attribute keys that should be excluded from being managed by Terraform.
    department string
    User profile property.
    displayName string
    User profile property.
    division string
    User profile property.
    email string
    User profile property.
    employeeNumber string
    User profile property.
    expirePasswordOnCreate boolean
    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.
    firstName string
    User's First Name, required by default.
    honorificPrefix string
    User profile property.
    honorificSuffix string
    User profile property.
    lastName string
    User's Last Name, required by default.
    locale string
    User profile property.
    login string
    User profile property.
    manager string
    User profile property.
    managerId string
    User profile property.
    middleName string
    User profile property.
    mobilePhone string
    User profile property.
    nickName string
    User profile property.
    oldPassword string
    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.
    organization string
    User profile property.
    password string
    User password.
    passwordHash UserPasswordHash
    Specifies a hashed password to import into Okta.
    passwordInlineHook string
    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.
    postalAddress string
    User profile property.
    preferredLanguage string
    User profile property.
    primaryPhone string
    User profile property.
    profileUrl string
    User profile property.
    rawStatus string
    The raw status of the User in Okta - (status is mapped)
    recoveryAnswer string
    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.
    recoveryQuestion string
    User password recovery question.
    secondEmail string
    User profile property.
    skipRoles boolean
    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

    state string
    User profile property.
    status string
    User profile property. Valid values are "ACTIVE", "DEPROVISIONED", "STAGED", "SUSPENDED"
    streetAddress string
    User profile property.
    timezone string
    User profile property.
    title string
    User profile property.
    userType string
    User profile property.
    zipCode string
    User profile property.
    city str
    User profile property.
    cost_center str
    User profile property.
    country_code str
    User profile property.
    custom_profile_attributes str
    raw JSON containing all custom profile attributes.
    custom_profile_attributes_to_ignores Sequence[str]
    List of custom_profile_attribute keys that should be excluded from being managed by Terraform.
    department str
    User profile property.
    display_name str
    User profile property.
    division str
    User profile property.
    email str
    User profile property.
    employee_number str
    User profile property.
    expire_password_on_create bool
    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.
    first_name str
    User's First Name, required by default.
    honorific_prefix str
    User profile property.
    honorific_suffix str
    User profile property.
    last_name str
    User's Last Name, required by default.
    locale str
    User profile property.
    login str
    User profile property.
    manager str
    User profile property.
    manager_id str
    User profile property.
    middle_name str
    User profile property.
    mobile_phone str
    User profile property.
    nick_name str
    User profile property.
    old_password str
    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.
    organization str
    User profile property.
    password str
    User password.
    password_hash UserPasswordHashArgs
    Specifies a hashed password to import into Okta.
    password_inline_hook str
    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.
    postal_address str
    User profile property.
    preferred_language str
    User profile property.
    primary_phone str
    User profile property.
    profile_url str
    User profile property.
    raw_status str
    The raw status of the User in Okta - (status is mapped)
    recovery_answer str
    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.
    recovery_question str
    User password recovery question.
    second_email str
    User profile property.
    skip_roles bool
    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

    state str
    User profile property.
    status str
    User profile property. Valid values are "ACTIVE", "DEPROVISIONED", "STAGED", "SUSPENDED"
    street_address str
    User profile property.
    timezone str
    User profile property.
    title str
    User profile property.
    user_type str
    User profile property.
    zip_code str
    User profile property.
    city String
    User profile property.
    costCenter String
    User profile property.
    countryCode String
    User profile property.
    customProfileAttributes String
    raw JSON containing all custom profile attributes.
    customProfileAttributesToIgnores List<String>
    List of custom_profile_attribute keys that should be excluded from being managed by Terraform.
    department String
    User profile property.
    displayName String
    User profile property.
    division String
    User profile property.
    email String
    User profile property.
    employeeNumber String
    User profile property.
    expirePasswordOnCreate Boolean
    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.
    firstName String
    User's First Name, required by default.
    honorificPrefix String
    User profile property.
    honorificSuffix String
    User profile property.
    lastName String
    User's Last Name, required by default.
    locale String
    User profile property.
    login String
    User profile property.
    manager String
    User profile property.
    managerId String
    User profile property.
    middleName String
    User profile property.
    mobilePhone String
    User profile property.
    nickName String
    User profile property.
    oldPassword String
    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.
    organization String
    User profile property.
    password String
    User password.
    passwordHash Property Map
    Specifies a hashed password to import into Okta.
    passwordInlineHook String
    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.
    postalAddress String
    User profile property.
    preferredLanguage String
    User profile property.
    primaryPhone String
    User profile property.
    profileUrl String
    User profile property.
    rawStatus String
    The raw status of the User in Okta - (status is mapped)
    recoveryAnswer String
    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.
    recoveryQuestion String
    User password recovery question.
    secondEmail String
    User profile property.
    skipRoles Boolean
    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

    state String
    User profile property.
    status String
    User profile property. Valid values are "ACTIVE", "DEPROVISIONED", "STAGED", "SUSPENDED"
    streetAddress String
    User profile property.
    timezone String
    User profile property.
    title String
    User profile property.
    userType String
    User profile property.
    zipCode String
    User profile property.

    Supporting Types

    UserPasswordHash, UserPasswordHashArgs

    Algorithm string
    The algorithm used to generate the hash using the password
    Value string
    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.
    Salt string
    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.
    SaltOrder string
    Specifies whether salt was pre- or postfixed to the password before hashing. Only required for salted algorithms.
    WorkFactor int
    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.
    Algorithm string
    The algorithm used to generate the hash using the password
    Value string
    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.
    Salt string
    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.
    SaltOrder string
    Specifies whether salt was pre- or postfixed to the password before hashing. Only required for salted algorithms.
    WorkFactor int
    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.
    algorithm String
    The algorithm used to generate the hash using the password
    value String
    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.
    salt String
    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.
    saltOrder String
    Specifies whether salt was pre- or postfixed to the password before hashing. Only required for salted algorithms.
    workFactor Integer
    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.
    algorithm string
    The algorithm used to generate the hash using the password
    value string
    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.
    salt string
    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.
    saltOrder string
    Specifies whether salt was pre- or postfixed to the password before hashing. Only required for salted algorithms.
    workFactor number
    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.
    algorithm str
    The algorithm used to generate the hash using the password
    value str
    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.
    salt str
    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_order str
    Specifies whether salt was pre- or postfixed to the password before hashing. Only required for salted algorithms.
    work_factor int
    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.
    algorithm String
    The algorithm used to generate the hash using the password
    value String
    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.
    salt String
    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.
    saltOrder String
    Specifies whether salt was pre- or postfixed to the password before hashing. Only required for salted algorithms.
    workFactor Number
    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.

    Import

    An Okta User can be imported via the ID.

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

    Package Details

    Repository
    Okta pulumi/pulumi-okta
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the okta Terraform Provider.
    okta logo
    Okta v4.8.0 published on Saturday, Mar 2, 2024 by Pulumi