1. Packages
  2. Okta
  3. API Docs
  4. user
  5. getUsers
Okta v4.8.1 published on Thursday, Apr 18, 2024 by Pulumi

okta.user.getUsers

Explore with Pulumi AI

okta logo
Okta v4.8.1 published on Thursday, Apr 18, 2024 by Pulumi

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

    Example Usage

    Lookup Users by Search Criteria

    import * as pulumi from "@pulumi/pulumi";
    import * as okta from "@pulumi/okta";
    
    const example = okta.user.getUsers({
        searches: [{
            expression: "profile.department eq \"Engineering\" and (created lt \"2014-01-01T00:00:00.000Z\" or status eq \"ACTIVE\")",
        }],
    });
    
    import pulumi
    import pulumi_okta as okta
    
    example = okta.user.get_users(searches=[okta.user.GetUsersSearchArgs(
        expression="profile.department eq \"Engineering\" and (created lt \"2014-01-01T00:00:00.000Z\" or status eq \"ACTIVE\")",
    )])
    
    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
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Okta = Pulumi.Okta;
    
    return await Deployment.RunAsync(() => 
    {
        var example = Okta.User.GetUsers.Invoke(new()
        {
            Searches = new[]
            {
                new Okta.User.Inputs.GetUsersSearchInputArgs
                {
                    Expression = "profile.department eq \"Engineering\" and (created lt \"2014-01-01T00:00:00.000Z\" or status eq \"ACTIVE\")",
                },
            },
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.okta.user.UserFunctions;
    import com.pulumi.okta.user.inputs.GetUsersArgs;
    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) {
            final var example = UserFunctions.getUsers(GetUsersArgs.builder()
                .searches(GetUsersSearchArgs.builder()
                    .expression("profile.department eq \"Engineering\" and (created lt \"2014-01-01T00:00:00.000Z\" or status eq \"ACTIVE\")")
                    .build())
                .build());
    
        }
    }
    
    variables:
      example:
        fn::invoke:
          Function: okta:user:getUsers
          Arguments:
            searches:
              - expression: profile.department eq "Engineering" and (created lt "2014-01-01T00:00:00.000Z" or status eq "ACTIVE")
    

    Lookup Users by Group Membership

    import * as pulumi from "@pulumi/pulumi";
    import * as okta from "@pulumi/okta";
    
    const exampleGroup = new okta.group.Group("exampleGroup", {});
    const exampleUsers = okta.user.getUsersOutput({
        groupId: exampleGroup.id,
        includeGroups: true,
        includeRoles: true,
    });
    
    import pulumi
    import pulumi_okta as okta
    
    example_group = okta.group.Group("exampleGroup")
    example_users = okta.user.get_users_output(group_id=example_group.id,
        include_groups=True,
        include_roles=True)
    
    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
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Okta = Pulumi.Okta;
    
    return await Deployment.RunAsync(() => 
    {
        var exampleGroup = new Okta.Group.Group("exampleGroup");
    
        var exampleUsers = Okta.User.GetUsers.Invoke(new()
        {
            GroupId = exampleGroup.Id,
            IncludeGroups = true,
            IncludeRoles = true,
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.okta.group.Group;
    import com.pulumi.okta.user.UserFunctions;
    import com.pulumi.okta.user.inputs.GetUsersArgs;
    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 exampleGroup = new Group("exampleGroup");
    
            final var exampleUsers = UserFunctions.getUsers(GetUsersArgs.builder()
                .groupId(exampleGroup.id())
                .includeGroups(true)
                .includeRoles(true)
                .build());
    
        }
    }
    
    resources:
      exampleGroup:
        type: okta:group:Group
    variables:
      exampleUsers:
        fn::invoke:
          Function: okta:user:getUsers
          Arguments:
            groupId: ${exampleGroup.id}
            includeGroups: true
            includeRoles: true
    

    Using getUsers

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getUsers(args: GetUsersArgs, opts?: InvokeOptions): Promise<GetUsersResult>
    function getUsersOutput(args: GetUsersOutputArgs, opts?: InvokeOptions): Output<GetUsersResult>
    def get_users(compound_search_operator: Optional[str] = None,
                  delay_read_seconds: Optional[str] = None,
                  group_id: Optional[str] = None,
                  include_groups: Optional[bool] = None,
                  include_roles: Optional[bool] = None,
                  searches: Optional[Sequence[GetUsersSearch]] = None,
                  opts: Optional[InvokeOptions] = None) -> GetUsersResult
    def get_users_output(compound_search_operator: Optional[pulumi.Input[str]] = None,
                  delay_read_seconds: Optional[pulumi.Input[str]] = None,
                  group_id: Optional[pulumi.Input[str]] = None,
                  include_groups: Optional[pulumi.Input[bool]] = None,
                  include_roles: Optional[pulumi.Input[bool]] = None,
                  searches: Optional[pulumi.Input[Sequence[pulumi.Input[GetUsersSearchArgs]]]] = None,
                  opts: Optional[InvokeOptions] = None) -> Output[GetUsersResult]
    func GetUsers(ctx *Context, args *GetUsersArgs, opts ...InvokeOption) (*GetUsersResult, error)
    func GetUsersOutput(ctx *Context, args *GetUsersOutputArgs, opts ...InvokeOption) GetUsersResultOutput

    > Note: This function is named GetUsers in the Go SDK.

    public static class GetUsers 
    {
        public static Task<GetUsersResult> InvokeAsync(GetUsersArgs args, InvokeOptions? opts = null)
        public static Output<GetUsersResult> Invoke(GetUsersInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetUsersResult> getUsers(GetUsersArgs args, InvokeOptions options)
    // Output-based functions aren't available in Java yet
    
    fn::invoke:
      function: okta:user/getUsers:getUsers
      arguments:
        # arguments dictionary

    The following arguments are supported:

    CompoundSearchOperator string
    Given multiple search elements they will be compounded together with the op. Default is and, or is also valid.
    DelayReadSeconds string
    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.
    GroupId string
    Id of group used to find users based on membership.
    IncludeGroups bool
    Fetch each user's group memberships. Defaults to false, in which case the group_memberships user attribute will be empty.
    IncludeRoles bool
    Fetch each user's administrator roles. Defaults to false, in which case the admin_roles user attribute will be empty.
    Searches List<GetUsersSearch>
    Map of search criteria. It supports the following properties.
    CompoundSearchOperator string
    Given multiple search elements they will be compounded together with the op. Default is and, or is also valid.
    DelayReadSeconds string
    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.
    GroupId string
    Id of group used to find users based on membership.
    IncludeGroups bool
    Fetch each user's group memberships. Defaults to false, in which case the group_memberships user attribute will be empty.
    IncludeRoles bool
    Fetch each user's administrator roles. Defaults to false, in which case the admin_roles user attribute will be empty.
    Searches []GetUsersSearch
    Map of search criteria. It supports the following properties.
    compoundSearchOperator String
    Given multiple search elements they will be compounded together with the op. Default is and, or is also valid.
    delayReadSeconds String
    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.
    groupId String
    Id of group used to find users based on membership.
    includeGroups Boolean
    Fetch each user's group memberships. Defaults to false, in which case the group_memberships user attribute will be empty.
    includeRoles Boolean
    Fetch each user's administrator roles. Defaults to false, in which case the admin_roles user attribute will be empty.
    searches List<GetUsersSearch>
    Map of search criteria. It supports the following properties.
    compoundSearchOperator string
    Given multiple search elements they will be compounded together with the op. Default is and, or is also valid.
    delayReadSeconds string
    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.
    groupId string
    Id of group used to find users based on membership.
    includeGroups boolean
    Fetch each user's group memberships. Defaults to false, in which case the group_memberships user attribute will be empty.
    includeRoles boolean
    Fetch each user's administrator roles. Defaults to false, in which case the admin_roles user attribute will be empty.
    searches GetUsersSearch[]
    Map of search criteria. It supports the following properties.
    compound_search_operator str
    Given multiple search elements they will be compounded together with the op. Default is and, or is also valid.
    delay_read_seconds str
    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.
    group_id str
    Id of group used to find users based on membership.
    include_groups bool
    Fetch each user's group memberships. Defaults to false, in which case the group_memberships user attribute will be empty.
    include_roles bool
    Fetch each user's administrator roles. Defaults to false, in which case the admin_roles user attribute will be empty.
    searches Sequence[GetUsersSearch]
    Map of search criteria. It supports the following properties.
    compoundSearchOperator String
    Given multiple search elements they will be compounded together with the op. Default is and, or is also valid.
    delayReadSeconds String
    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.
    groupId String
    Id of group used to find users based on membership.
    includeGroups Boolean
    Fetch each user's group memberships. Defaults to false, in which case the group_memberships user attribute will be empty.
    includeRoles Boolean
    Fetch each user's administrator roles. Defaults to false, in which case the admin_roles user attribute will be empty.
    searches List<Property Map>
    Map of search criteria. It supports the following properties.

    getUsers Result

    The following output properties are available:

    Id string
    The provider-assigned unique ID for this managed resource.
    Users List<GetUsersUser>
    collection of users retrieved from Okta with the following properties.
    CompoundSearchOperator string
    DelayReadSeconds string
    GroupId string
    IncludeGroups bool
    IncludeRoles bool
    Searches List<GetUsersSearch>
    Id string
    The provider-assigned unique ID for this managed resource.
    Users []GetUsersUser
    collection of users retrieved from Okta with the following properties.
    CompoundSearchOperator string
    DelayReadSeconds string
    GroupId string
    IncludeGroups bool
    IncludeRoles bool
    Searches []GetUsersSearch
    id String
    The provider-assigned unique ID for this managed resource.
    users List<GetUsersUser>
    collection of users retrieved from Okta with the following properties.
    compoundSearchOperator String
    delayReadSeconds String
    groupId String
    includeGroups Boolean
    includeRoles Boolean
    searches List<GetUsersSearch>
    id string
    The provider-assigned unique ID for this managed resource.
    users GetUsersUser[]
    collection of users retrieved from Okta with the following properties.
    compoundSearchOperator string
    delayReadSeconds string
    groupId string
    includeGroups boolean
    includeRoles boolean
    searches GetUsersSearch[]
    id str
    The provider-assigned unique ID for this managed resource.
    users Sequence[GetUsersUser]
    collection of users retrieved from Okta with the following properties.
    compound_search_operator str
    delay_read_seconds str
    group_id str
    include_groups bool
    include_roles bool
    searches Sequence[GetUsersSearch]
    id String
    The provider-assigned unique ID for this managed resource.
    users List<Property Map>
    collection of users retrieved from Okta with the following properties.
    compoundSearchOperator String
    delayReadSeconds String
    groupId String
    includeGroups Boolean
    includeRoles Boolean
    searches List<Property Map>

    Supporting Types

    GetUsersSearch

    Comparison string
    Comparison to use. Comparitors for strings: eq, ge, gt, le, lt, ne, pr, sw.
    Expression string
    A raw search expression string. If present it will override name/comparison/value.
    Name string
    Name of property to search against.
    Value string
    Value to compare with.
    Comparison string
    Comparison to use. Comparitors for strings: eq, ge, gt, le, lt, ne, pr, sw.
    Expression string
    A raw search expression string. If present it will override name/comparison/value.
    Name string
    Name of property to search against.
    Value string
    Value to compare with.
    comparison String
    Comparison to use. Comparitors for strings: eq, ge, gt, le, lt, ne, pr, sw.
    expression String
    A raw search expression string. If present it will override name/comparison/value.
    name String
    Name of property to search against.
    value String
    Value to compare with.
    comparison string
    Comparison to use. Comparitors for strings: eq, ge, gt, le, lt, ne, pr, sw.
    expression string
    A raw search expression string. If present it will override name/comparison/value.
    name string
    Name of property to search against.
    value string
    Value to compare with.
    comparison str
    Comparison to use. Comparitors for strings: eq, ge, gt, le, lt, ne, pr, sw.
    expression str
    A raw search expression string. If present it will override name/comparison/value.
    name str
    Name of property to search against.
    value str
    Value to compare with.
    comparison String
    Comparison to use. Comparitors for strings: eq, ge, gt, le, lt, ne, pr, sw.
    expression String
    A raw search expression string. If present it will override name/comparison/value.
    name String
    Name of property to search against.
    value String
    Value to compare with.

    GetUsersUser

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

    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.1 published on Thursday, Apr 18, 2024 by Pulumi