okta.user.getUser

Explore with Pulumi AI

Okta v4.11.3 published on Monday, Oct 21, 2024 by Pulumi

Using getUser

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 getUser(args: GetUserArgs, opts?: InvokeOptions): Promise<GetUserResult>
function getUserOutput(args: GetUserOutputArgs, opts?: InvokeOptions): Output<GetUserResult>

def get_user(compound_search_operator: Optional[str] = None,
             delay_read_seconds: Optional[str] = None,
             searches: Optional[Sequence[GetUserSearch]] = None,
             skip_groups: Optional[bool] = None,
             skip_roles: Optional[bool] = None,
             user_id: Optional[str] = None,
             opts: Optional[InvokeOptions] = None) -> GetUserResult
def get_user_output(compound_search_operator: Optional[pulumi.Input[str]] = None,
             delay_read_seconds: Optional[pulumi.Input[str]] = None,
             searches: Optional[pulumi.Input[Sequence[pulumi.Input[GetUserSearchArgs]]]] = None,
             skip_groups: Optional[pulumi.Input[bool]] = None,
             skip_roles: Optional[pulumi.Input[bool]] = None,
             user_id: Optional[pulumi.Input[str]] = None,
             opts: Optional[InvokeOptions] = None) -> Output[GetUserResult]

func LookupUser(ctx *Context, args *LookupUserArgs, opts ...InvokeOption) (*LookupUserResult, error)
func LookupUserOutput(ctx *Context, args *LookupUserOutputArgs, opts ...InvokeOption) LookupUserResultOutput

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

public static class GetUser 
{
    public static Task<GetUserResult> InvokeAsync(GetUserArgs args, InvokeOptions? opts = null)
    public static Output<GetUserResult> Invoke(GetUserInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetUserResult> getUser(GetUserArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet

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

The following arguments are supported:

CompoundSearchOperator string: Search operator used when joining multiple search clauses
DelayReadSeconds string: Force delay of the user read by N seconds. Useful when eventual consistency of user information needs to be allowed for.
Searches List<GetUserSearch>: 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
SkipGroups bool: Do not populate user groups information (prevents additional API call)
SkipRoles bool: Do not populate user roles information (prevents additional API call)
UserId string: Retrieve a single user based on their id

CompoundSearchOperator string: Search operator used when joining multiple search clauses
DelayReadSeconds string: Force delay of the user read by N seconds. Useful when eventual consistency of user information needs to be allowed for.
Searches []GetUserSearch: 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
SkipGroups bool: Do not populate user groups information (prevents additional API call)
SkipRoles bool: Do not populate user roles information (prevents additional API call)
UserId string: Retrieve a single user based on their id

compoundSearchOperator String: Search operator used when joining multiple search clauses
delayReadSeconds String: Force delay of the user read by N seconds. Useful when eventual consistency of user information needs to be allowed for.
searches List<GetUserSearch>: 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
skipGroups Boolean: Do not populate user groups information (prevents additional API call)
skipRoles Boolean: Do not populate user roles information (prevents additional API call)
userId String: Retrieve a single user based on their id

compoundSearchOperator string: Search operator used when joining multiple search clauses
delayReadSeconds string: Force delay of the user read by N seconds. Useful when eventual consistency of user information needs to be allowed for.
searches GetUserSearch[]: 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
skipGroups boolean: Do not populate user groups information (prevents additional API call)
skipRoles boolean: Do not populate user roles information (prevents additional API call)
userId string: Retrieve a single user based on their id

compound_search_operator str: Search operator used when joining multiple search clauses
delay_read_seconds str: Force delay of the user read by N seconds. Useful when eventual consistency of user information needs to be allowed for.
searches Sequence[GetUserSearch]: 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
skip_groups bool: Do not populate user groups information (prevents additional API call)
skip_roles bool: Do not populate user roles information (prevents additional API call)
user_id str: Retrieve a single user based on their id

compoundSearchOperator String: Search operator used when joining multiple search clauses
delayReadSeconds String: Force delay of the user read by N seconds. Useful when eventual consistency of user information needs to be allowed for.
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
skipGroups Boolean: Do not populate user groups information (prevents additional API call)
skipRoles Boolean: Do not populate user roles information (prevents additional API call)
userId String: Retrieve a single user based on their id

getUser Result

The following output properties are available:

AdminRoles List<string>
City string
CostCenter string
CountryCode string
CustomProfileAttributes string
Department string
DisplayName string
Division string
Email string
EmployeeNumber string
FirstName string
GroupMemberships List<string>
HonorificPrefix string
HonorificSuffix string
Id string: The provider-assigned unique ID for this managed resource.
LastName string
Locale string
Login string
Manager string
ManagerId string
MiddleName string
MobilePhone string
NickName string
Organization string
PostalAddress string
PreferredLanguage string
PrimaryPhone string
ProfileUrl string
Roles List<string>
SecondEmail string
State string
Status string
StreetAddress string
Timezone string
Title string
UserType string
ZipCode string
CompoundSearchOperator string: Search operator used when joining multiple search clauses
DelayReadSeconds string: Force delay of the user read by N seconds. Useful when eventual consistency of user information needs to be allowed for.
Searches List<GetUserSearch>: 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
SkipGroups bool: Do not populate user groups information (prevents additional API call)
SkipRoles bool: Do not populate user roles information (prevents additional API call)
UserId string: Retrieve a single user based on their id

AdminRoles []string
City string
CostCenter string
CountryCode string
CustomProfileAttributes string
Department string
DisplayName string
Division string
Email string
EmployeeNumber string
FirstName string
GroupMemberships []string
HonorificPrefix string
HonorificSuffix string
Id string: The provider-assigned unique ID for this managed resource.
LastName string
Locale string
Login string
Manager string
ManagerId string
MiddleName string
MobilePhone string
NickName string
Organization string
PostalAddress string
PreferredLanguage string
PrimaryPhone string
ProfileUrl string
Roles []string
SecondEmail string
State string
Status string
StreetAddress string
Timezone string
Title string
UserType string
ZipCode string
CompoundSearchOperator string: Search operator used when joining multiple search clauses
DelayReadSeconds string: Force delay of the user read by N seconds. Useful when eventual consistency of user information needs to be allowed for.
Searches []GetUserSearch: 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
SkipGroups bool: Do not populate user groups information (prevents additional API call)
SkipRoles bool: Do not populate user roles information (prevents additional API call)
UserId string: Retrieve a single user based on their id

adminRoles List<String>
city String
costCenter String
countryCode String
customProfileAttributes String
department String
displayName String
division String
email String
employeeNumber String
firstName String
groupMemberships List<String>
honorificPrefix String
honorificSuffix String
id String: The provider-assigned unique ID for this managed resource.
lastName String
locale String
login String
manager String
managerId String
middleName String
mobilePhone String
nickName String
organization String
postalAddress String
preferredLanguage String
primaryPhone String
profileUrl String
roles List<String>
secondEmail String
state String
status String
streetAddress String
timezone String
title String
userType String
zipCode String
compoundSearchOperator String: Search operator used when joining multiple search clauses
delayReadSeconds String: Force delay of the user read by N seconds. Useful when eventual consistency of user information needs to be allowed for.
searches List<GetUserSearch>: 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
skipGroups Boolean: Do not populate user groups information (prevents additional API call)
skipRoles Boolean: Do not populate user roles information (prevents additional API call)
userId String: Retrieve a single user based on their id

adminRoles string[]
city string
costCenter string
countryCode string
customProfileAttributes string
department string
displayName string
division string
email string
employeeNumber string
firstName string
groupMemberships string[]
honorificPrefix string
honorificSuffix string
id string: The provider-assigned unique ID for this managed resource.
lastName string
locale string
login string
manager string
managerId string
middleName string
mobilePhone string
nickName string
organization string
postalAddress string
preferredLanguage string
primaryPhone string
profileUrl string
roles string[]
secondEmail string
state string
status string
streetAddress string
timezone string
title string
userType string
zipCode string
compoundSearchOperator string: Search operator used when joining multiple search clauses
delayReadSeconds string: Force delay of the user read by N seconds. Useful when eventual consistency of user information needs to be allowed for.
searches GetUserSearch[]: 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
skipGroups boolean: Do not populate user groups information (prevents additional API call)
skipRoles boolean: Do not populate user roles information (prevents additional API call)
userId string: Retrieve a single user based on their id

admin_roles Sequence[str]
city str
cost_center str
country_code str
custom_profile_attributes str
department str
display_name str
division str
email str
employee_number str
first_name str
group_memberships Sequence[str]
honorific_prefix str
honorific_suffix str
id str: The provider-assigned unique ID for this managed resource.
last_name str
locale str
login str
manager str
manager_id str
middle_name str
mobile_phone str
nick_name str
organization str
postal_address str
preferred_language str
primary_phone str
profile_url str
roles Sequence[str]
second_email str
state str
status str
street_address str
timezone str
title str
user_type str
zip_code str
compound_search_operator str: Search operator used when joining multiple search clauses
delay_read_seconds str: Force delay of the user read by N seconds. Useful when eventual consistency of user information needs to be allowed for.
searches Sequence[GetUserSearch]: 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
skip_groups bool: Do not populate user groups information (prevents additional API call)
skip_roles bool: Do not populate user roles information (prevents additional API call)
user_id str: Retrieve a single user based on their id

adminRoles List<String>
city String
costCenter String
countryCode String
customProfileAttributes String
department String
displayName String
division String
email String
employeeNumber String
firstName String
groupMemberships List<String>
honorificPrefix String
honorificSuffix String
id String: The provider-assigned unique ID for this managed resource.
lastName String
locale String
login String
manager String
managerId String
middleName String
mobilePhone String
nickName String
organization String
postalAddress String
preferredLanguage String
primaryPhone String
profileUrl String
roles List<String>
secondEmail String
state String
status String
streetAddress String
timezone String
title String
userType String
zipCode String
compoundSearchOperator String: Search operator used when joining multiple search clauses
delayReadSeconds String: Force delay of the user read by N seconds. Useful when eventual consistency of user information needs to be allowed for.
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
skipGroups Boolean: Do not populate user groups information (prevents additional API call)
skipRoles Boolean: Do not populate user roles information (prevents additional API call)
userId String: Retrieve a single user based on their id

Supporting Types

GetUserSearch

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

Package Details

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

Okta v4.11.3 published on Monday, Oct 21, 2024 by Pulumi

pulumi/pulumi-okta

okta.user.getUser

On this page

On this page

Using getUser

getUser Result

Supporting Types

GetUserSearch

Package Details

On this page

On this page