okta.user.getUsers

Explore with Pulumi AI

Okta v4.15.0 published on Friday, Mar 7, 2025 by Pulumi

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)
public static Output<GetUsersResult> getUsers(GetUsersArgs args, InvokeOptions options)

fn::invoke:
  function: okta:user/getUsers:getUsers
  arguments:
    # arguments dictionary

The following arguments are supported:

CompoundSearchOperator string: Search operator used when joining multiple search clauses
DelayReadSeconds string: Force delay of the users read by N seconds. Useful when eventual consistency of users information needs to be allowed for.
GroupId string: Find users based on group membership using the id of the group.
IncludeGroups bool: Fetch group memberships for each user
IncludeRoles bool: Fetch user roles for each user
Searches List<GetUsersSearch>: Filter to find user/users. Each filter will be concatenated with the compound search operator. Please be aware profile properties must match what is in Okta, which is likely camel case. Expression is a free form expression filter https://developer.okta.com/docs/reference/core-okta-api/#filter . The set name/value/comparison properties will be ignored if expression is present

CompoundSearchOperator string: Search operator used when joining multiple search clauses
DelayReadSeconds string: Force delay of the users read by N seconds. Useful when eventual consistency of users information needs to be allowed for.
GroupId string: Find users based on group membership using the id of the group.
IncludeGroups bool: Fetch group memberships for each user
IncludeRoles bool: Fetch user roles for each user
Searches []GetUsersSearch: Filter to find user/users. Each filter will be concatenated with the compound search operator. Please be aware profile properties must match what is in Okta, which is likely camel case. Expression is a free form expression filter https://developer.okta.com/docs/reference/core-okta-api/#filter . The set name/value/comparison properties will be ignored if expression is present

compoundSearchOperator String: Search operator used when joining multiple search clauses
delayReadSeconds String: Force delay of the users read by N seconds. Useful when eventual consistency of users information needs to be allowed for.
groupId String: Find users based on group membership using the id of the group.
includeGroups Boolean: Fetch group memberships for each user
includeRoles Boolean: Fetch user roles for each user
searches List<GetUsersSearch>: Filter to find user/users. Each filter will be concatenated with the compound search operator. Please be aware profile properties must match what is in Okta, which is likely camel case. Expression is a free form expression filter https://developer.okta.com/docs/reference/core-okta-api/#filter . The set name/value/comparison properties will be ignored if expression is present

compoundSearchOperator string: Search operator used when joining multiple search clauses
delayReadSeconds string: Force delay of the users read by N seconds. Useful when eventual consistency of users information needs to be allowed for.
groupId string: Find users based on group membership using the id of the group.
includeGroups boolean: Fetch group memberships for each user
includeRoles boolean: Fetch user roles for each user
searches GetUsersSearch[]: Filter to find user/users. Each filter will be concatenated with the compound search operator. Please be aware profile properties must match what is in Okta, which is likely camel case. Expression is a free form expression filter https://developer.okta.com/docs/reference/core-okta-api/#filter . The set name/value/comparison properties will be ignored if expression is present

compound_search_operator str: Search operator used when joining multiple search clauses
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.
group_id str: Find users based on group membership using the id of the group.
include_groups bool: Fetch group memberships for each user
include_roles bool: Fetch user roles for each user
searches Sequence[GetUsersSearch]: Filter to find user/users. Each filter will be concatenated with the compound search operator. Please be aware profile properties must match what is in Okta, which is likely camel case. Expression is a free form expression filter https://developer.okta.com/docs/reference/core-okta-api/#filter . The set name/value/comparison properties will be ignored if expression is present

compoundSearchOperator String: Search operator used when joining multiple search clauses
delayReadSeconds String: Force delay of the users read by N seconds. Useful when eventual consistency of users information needs to be allowed for.
groupId String: Find users based on group membership using the id of the group.
includeGroups Boolean: Fetch group memberships for each user
includeRoles Boolean: Fetch user roles for each user
searches List<Property Map>: Filter to find user/users. Each filter will be concatenated with the compound search operator. Please be aware profile properties must match what is in Okta, which is likely camel case. Expression is a free form expression filter https://developer.okta.com/docs/reference/core-okta-api/#filter . The set name/value/comparison properties will be ignored if expression is present

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.
CompoundSearchOperator string: Search operator used when joining multiple search clauses
DelayReadSeconds string: Force delay of the users read by N seconds. Useful when eventual consistency of users information needs to be allowed for.
GroupId string: Find users based on group membership using the id of the group.
IncludeGroups bool: Fetch group memberships for each user
IncludeRoles bool: Fetch user roles for each user
Searches List<GetUsersSearch>: Filter to find user/users. Each filter will be concatenated with the compound search operator. Please be aware profile properties must match what is in Okta, which is likely camel case. Expression is a free form expression filter https://developer.okta.com/docs/reference/core-okta-api/#filter . The set name/value/comparison properties will be ignored if expression is present

Id string: The provider-assigned unique ID for this managed resource.
Users []GetUsersUser: collection of users retrieved from Okta.
CompoundSearchOperator string: Search operator used when joining multiple search clauses
DelayReadSeconds string: Force delay of the users read by N seconds. Useful when eventual consistency of users information needs to be allowed for.
GroupId string: Find users based on group membership using the id of the group.
IncludeGroups bool: Fetch group memberships for each user
IncludeRoles bool: Fetch user roles for each user
Searches []GetUsersSearch: Filter to find user/users. Each filter will be concatenated with the compound search operator. Please be aware profile properties must match what is in Okta, which is likely camel case. Expression is a free form expression filter https://developer.okta.com/docs/reference/core-okta-api/#filter . The set name/value/comparison properties will be ignored if expression is present

id String: The provider-assigned unique ID for this managed resource.
users List<GetUsersUser>: collection of users retrieved from Okta.
compoundSearchOperator String: Search operator used when joining multiple search clauses
delayReadSeconds String: Force delay of the users read by N seconds. Useful when eventual consistency of users information needs to be allowed for.
groupId String: Find users based on group membership using the id of the group.
includeGroups Boolean: Fetch group memberships for each user
includeRoles Boolean: Fetch user roles for each user
searches List<GetUsersSearch>: Filter to find user/users. Each filter will be concatenated with the compound search operator. Please be aware profile properties must match what is in Okta, which is likely camel case. Expression is a free form expression filter https://developer.okta.com/docs/reference/core-okta-api/#filter . The set name/value/comparison properties will be ignored if expression is present

id string: The provider-assigned unique ID for this managed resource.
users GetUsersUser[]: collection of users retrieved from Okta.
compoundSearchOperator string: Search operator used when joining multiple search clauses
delayReadSeconds string: Force delay of the users read by N seconds. Useful when eventual consistency of users information needs to be allowed for.
groupId string: Find users based on group membership using the id of the group.
includeGroups boolean: Fetch group memberships for each user
includeRoles boolean: Fetch user roles for each user
searches GetUsersSearch[]: Filter to find user/users. Each filter will be concatenated with the compound search operator. Please be aware profile properties must match what is in Okta, which is likely camel case. Expression is a free form expression filter https://developer.okta.com/docs/reference/core-okta-api/#filter . The set name/value/comparison properties will be ignored if expression is present

id str: The provider-assigned unique ID for this managed resource.
users Sequence[GetUsersUser]: collection of users retrieved from Okta.
compound_search_operator str: Search operator used when joining multiple search clauses
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.
group_id str: Find users based on group membership using the id of the group.
include_groups bool: Fetch group memberships for each user
include_roles bool: Fetch user roles for each user
searches Sequence[GetUsersSearch]: Filter to find user/users. Each filter will be concatenated with the compound search operator. Please be aware profile properties must match what is in Okta, which is likely camel case. Expression is a free form expression filter https://developer.okta.com/docs/reference/core-okta-api/#filter . The set name/value/comparison properties will be ignored if expression is present

id String: The provider-assigned unique ID for this managed resource.
users List<Property Map>: collection of users retrieved from Okta.
compoundSearchOperator String: Search operator used when joining multiple search clauses
delayReadSeconds String: Force delay of the users read by N seconds. Useful when eventual consistency of users information needs to be allowed for.
groupId String: Find users based on group membership using the id of the group.
includeGroups Boolean: Fetch group memberships for each user
includeRoles Boolean: Fetch user roles for each user
searches List<Property Map>: Filter to find user/users. Each filter will be concatenated with the compound search operator. Please be aware profile properties must match what is in Okta, which is likely camel case. Expression is a free form expression filter https://developer.okta.com/docs/reference/core-okta-api/#filter . The set name/value/comparison properties will be ignored if expression is present

Supporting Types

GetUsersSearch

Comparison string
Expression string: A raw search expression string. This requires the search feature be on. Please see Okta documentation on their filter API for users. https://developer.okta.com/docs/api/resources/users#list-users-with-search
Name string: Property name to search for. This requires the search feature be on. Please see Okta documentation on their filter API for users. https://developer.okta.com/docs/api/resources/users#list-users-with-search
Value string

Comparison string
Expression string: A raw search expression string. This requires the search feature be on. Please see Okta documentation on their filter API for users. https://developer.okta.com/docs/api/resources/users#list-users-with-search
Name string: Property name to search for. This requires the search feature be on. Please see Okta documentation on their filter API for users. https://developer.okta.com/docs/api/resources/users#list-users-with-search
Value string

comparison String
expression String: A raw search expression string. This requires the search feature be on. Please see Okta documentation on their filter API for users. https://developer.okta.com/docs/api/resources/users#list-users-with-search
name String: Property name to search for. This requires the search feature be on. Please see Okta documentation on their filter API for users. https://developer.okta.com/docs/api/resources/users#list-users-with-search
value String

comparison string
expression string: A raw search expression string. This requires the search feature be on. Please see Okta documentation on their filter API for users. https://developer.okta.com/docs/api/resources/users#list-users-with-search
name string: Property name to search for. This requires the search feature be on. Please see Okta documentation on their filter API for users. https://developer.okta.com/docs/api/resources/users#list-users-with-search
value string

comparison str
expression str: A raw search expression string. This requires the search feature be on. Please see Okta documentation on their filter API for users. https://developer.okta.com/docs/api/resources/users#list-users-with-search
name str: Property name to search for. This requires the search feature be on. Please see Okta documentation on their filter API for users. https://developer.okta.com/docs/api/resources/users#list-users-with-search
value str

comparison String
expression String: A raw search expression string. This requires the search feature be on. Please see Okta documentation on their filter API for users. https://developer.okta.com/docs/api/resources/users#list-users-with-search
name String: Property name to search for. This requires the search feature be on. Please see Okta documentation on their filter API for users. https://developer.okta.com/docs/api/resources/users#list-users-with-search
value String