GetUsers

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

Example Usage

using Pulumi;
using Okta = Pulumi.Okta;

class MyStack : Stack
{
    public MyStack()
    {
        var example = Output.Create(Okta.User.GetUsers.InvokeAsync(new Okta.User.GetUsersArgs
        {
            Searches = 
            {
                new Okta.User.Inputs.GetUsersSearchArgs
                {
                    Comparison = "sw",
                    Name = "profile.company",
                    Value = "Articulate",
                },
            },
        }));
    }

}

Coming soon!

import pulumi
import pulumi_okta as okta

example = okta.user.get_users(searches=[{
    "comparison": "sw",
    "name": "profile.company",
    "value": "Articulate",
}])

import * as pulumi from "@pulumi/pulumi";
import * as okta from "@pulumi/okta";

const example = pulumi.output(okta.user.getUsers({
    searches: [{
        comparison: "sw",
        name: "profile.company",
        value: "Articulate",
    }],
}, { async: true }));

Using GetUsers

function getUsers(args: GetUsersArgs, opts?: InvokeOptions): Promise<GetUsersResult>

function  get_users(searches=None, users=None, opts=None)

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

public static class GetUsers {
    public static Task<GetUsersResult> InvokeAsync(GetUsersArgs args, InvokeOptions? opts = null)
}

The following arguments are supported:

Searches List<GetUsersSearchArgs>: Map of search criteria to use to find users. It supports the following properties.
Users List<GetUsersUserArgs>: collection of users retrieved from Okta with the following properties.

Searches []GetUsersSearch: Map of search criteria to use to find users. It supports the following properties.
Users []GetUsersUser: collection of users retrieved from Okta with the following properties.

searches GetUsersSearch[]: Map of search criteria to use to find users. It supports the following properties.
users GetUsersUser[]: collection of users retrieved from Okta with the following properties.

searches List[GetUsersSearch]: Map of search criteria to use to find users. It supports the following properties.
users List[GetUsersUser]: collection of users retrieved from Okta with the following properties.

GetUsers Result

The following output properties are available:

Id string: The provider-assigned unique ID for this managed resource.
Searches List<GetUsersSearch>
Users List<GetUsersUser>: collection of users retrieved from Okta with the following properties.

Id string: The provider-assigned unique ID for this managed resource.
Searches []GetUsersSearch
Users []GetUsersUser: collection of users retrieved from Okta with the following properties.

id string: The provider-assigned unique ID for this managed resource.
searches GetUsersSearch[]
users GetUsersUser[]: collection of users retrieved from Okta with the following properties.

id str: The provider-assigned unique ID for this managed resource.
searches List[GetUsersSearch]
users List[GetUsersUser]: collection of users retrieved from Okta with the following properties.

Supporting Types

GetUsersSearch

See the input and output API doc for this type.

Name string: Name of property to search against.
Value string: Value to compare with.
Comparison string: Comparison to use.

Name string: Name of property to search against.
Value string: Value to compare with.
Comparison string: Comparison to use.

name string: Name of property to search against.
value string: Value to compare with.
comparison string: Comparison to use.

name str: Name of property to search against.
value str: Value to compare with.
comparison str: Comparison to use.

GetUsersUser

See the input and output API doc for this type.

AdminRoles List<string>: Administrator roles assigned to user.
City string: user profile property.
CostCenter string: user profile property.
CountryCode string: user profile property.
CustomProfileAttributes string: raw JSON containing all custom profile attributes.
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.
FirstName string: user profile property.
GroupMemberships List<string>: user profile property.
HonorificPrefix string: user profile property.
HonorificSuffix string: user profile property.
LastName string: user profile property.
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.
Organization string: user profile property.
PostalAddress string: user profile property.
PreferredLanguage string: user profile property.
PrimaryPhone string: user profile property.
ProfileUrl string: user profile property.
SecondEmail string: user profile property.
State string: user profile property.
Status string: user profile property.
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.

AdminRoles []string: Administrator roles assigned to user.
City string: user profile property.
CostCenter string: user profile property.
CountryCode string: user profile property.
CustomProfileAttributes string: raw JSON containing all custom profile attributes.
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.
FirstName string: user profile property.
GroupMemberships []string: user profile property.
HonorificPrefix string: user profile property.
HonorificSuffix string: user profile property.
LastName string: user profile property.
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.
Organization string: user profile property.
PostalAddress string: user profile property.
PreferredLanguage string: user profile property.
PrimaryPhone string: user profile property.
ProfileUrl string: user profile property.
SecondEmail string: user profile property.
State string: user profile property.
Status string: user profile property.
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.

adminRoles string[]: Administrator roles assigned to user.
city string: user profile property.
costCenter string: user profile property.
countryCode string: user profile property.
customProfileAttributes string: raw JSON containing all custom profile attributes.
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.
firstName string: user profile property.
groupMemberships string[]: user profile property.
honorificPrefix string: user profile property.
honorificSuffix string: user profile property.
lastName string: user profile property.
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.
organization string: user profile property.
postalAddress string: user profile property.
preferredLanguage string: user profile property.
primaryPhone string: user profile property.
profileUrl string: user profile property.
secondEmail string: user profile property.
state string: user profile property.
status string: user profile property.
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.

admin_roles List[str]: Administrator roles assigned to user.
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.
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.
first_name str: user profile property.
group_memberships List[str]: user profile property.
honorific_prefix str: user profile property.
honorific_suffix str: user profile property.
last_name str: user profile property.
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.
organization str: user profile property.
postal_address str: user profile property.
preferred_language str: user profile property.
primary_phone str: user profile property.
profile_url str: user profile property.
second_email str: user profile property.
state str: user profile property.
status str: user profile property.
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.

Package Details

Repository: https://github.com/pulumi/pulumi-okta
License: Apache-2.0
Notes: This Pulumi package is based on the okta Terraform Provider.

The Pulumi Platform

Get Started

Migrate to Pulumi

Solutions for All Teams and Engineers

Any Code

Any Cloud

GetUsers

Example Usage

Using GetUsers

GetUsers Result

Supporting Types

GetUsersSearch

GetUsersUser

Package Details

On This Page