onelogin v0.6.3 published on Friday, May 10, 2024 by Pulumi
onelogin.users.getUsers
Explore with Pulumi AI
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(activated_at: Optional[str] = None,
comment: Optional[str] = None,
company: Optional[str] = None,
created_at: Optional[str] = None,
department: Optional[str] = None,
directory_id: Optional[int] = None,
distinguished_name: Optional[str] = None,
email: Optional[str] = None,
external_id: Optional[str] = None,
filters: Optional[Sequence[GetUsersFilter]] = None,
firstname: Optional[str] = None,
group_id: Optional[int] = None,
invalid_login_attempts: Optional[int] = None,
invitation_sent_at: Optional[str] = None,
last_login: Optional[str] = None,
lastname: Optional[str] = None,
locked_until: Optional[str] = None,
manager_ad_id: Optional[str] = None,
manager_user_id: Optional[str] = None,
member_of: Optional[str] = None,
password: Optional[str] = None,
password_algorithm: Optional[str] = None,
password_changed_at: Optional[str] = None,
password_confirmation: Optional[str] = None,
phone: Optional[str] = None,
preferred_locale_code: Optional[str] = None,
role_ids: Optional[Sequence[int]] = None,
salt: Optional[str] = None,
samaccountname: Optional[str] = None,
state: Optional[int] = None,
status: Optional[int] = None,
title: Optional[str] = None,
trusted_idp_id: Optional[int] = None,
updated_at: Optional[str] = None,
username: Optional[str] = None,
userprincipalname: Optional[str] = None,
opts: Optional[InvokeOptions] = None) -> GetUsersResult
def get_users_output(activated_at: Optional[pulumi.Input[str]] = None,
comment: Optional[pulumi.Input[str]] = None,
company: Optional[pulumi.Input[str]] = None,
created_at: Optional[pulumi.Input[str]] = None,
department: Optional[pulumi.Input[str]] = None,
directory_id: Optional[pulumi.Input[int]] = None,
distinguished_name: Optional[pulumi.Input[str]] = None,
email: Optional[pulumi.Input[str]] = None,
external_id: Optional[pulumi.Input[str]] = None,
filters: Optional[pulumi.Input[Sequence[pulumi.Input[GetUsersFilterArgs]]]] = None,
firstname: Optional[pulumi.Input[str]] = None,
group_id: Optional[pulumi.Input[int]] = None,
invalid_login_attempts: Optional[pulumi.Input[int]] = None,
invitation_sent_at: Optional[pulumi.Input[str]] = None,
last_login: Optional[pulumi.Input[str]] = None,
lastname: Optional[pulumi.Input[str]] = None,
locked_until: Optional[pulumi.Input[str]] = None,
manager_ad_id: Optional[pulumi.Input[str]] = None,
manager_user_id: Optional[pulumi.Input[str]] = None,
member_of: Optional[pulumi.Input[str]] = None,
password: Optional[pulumi.Input[str]] = None,
password_algorithm: Optional[pulumi.Input[str]] = None,
password_changed_at: Optional[pulumi.Input[str]] = None,
password_confirmation: Optional[pulumi.Input[str]] = None,
phone: Optional[pulumi.Input[str]] = None,
preferred_locale_code: Optional[pulumi.Input[str]] = None,
role_ids: Optional[pulumi.Input[Sequence[pulumi.Input[int]]]] = None,
salt: Optional[pulumi.Input[str]] = None,
samaccountname: Optional[pulumi.Input[str]] = None,
state: Optional[pulumi.Input[int]] = None,
status: Optional[pulumi.Input[int]] = None,
title: Optional[pulumi.Input[str]] = None,
trusted_idp_id: Optional[pulumi.Input[int]] = None,
updated_at: Optional[pulumi.Input[str]] = None,
username: Optional[pulumi.Input[str]] = None,
userprincipalname: Optional[pulumi.Input[str]] = 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: onelogin:users/getUsers:getUsers
arguments:
# arguments dictionary
The following arguments are supported:
- Activated
At string - Comment string
- Company string
- Created
At string - Department string
- Directory
Id int - Distinguished
Name string - Email string
- External
Id string - Filters
List<Get
Users Filter> - Firstname string
- Group
Id int - Invalid
Login intAttempts - Invitation
Sent stringAt - Last
Login string - Lastname string
- Locked
Until string - Manager
Ad stringId - Manager
User stringId - Member
Of string - Password string
- Password
Algorithm string - Password
Changed stringAt - Password
Confirmation string - Phone string
- Preferred
Locale stringCode - Role
Ids List<int> - Salt string
- Samaccountname string
- State int
- Status int
- Title string
- Trusted
Idp intId - Updated
At string - Username string
- Userprincipalname string
- Activated
At string - Comment string
- Company string
- Created
At string - Department string
- Directory
Id int - Distinguished
Name string - Email string
- External
Id string - Filters
[]Get
Users Filter - Firstname string
- Group
Id int - Invalid
Login intAttempts - Invitation
Sent stringAt - Last
Login string - Lastname string
- Locked
Until string - Manager
Ad stringId - Manager
User stringId - Member
Of string - Password string
- Password
Algorithm string - Password
Changed stringAt - Password
Confirmation string - Phone string
- Preferred
Locale stringCode - Role
Ids []int - Salt string
- Samaccountname string
- State int
- Status int
- Title string
- Trusted
Idp intId - Updated
At string - Username string
- Userprincipalname string
- activated
At String - comment String
- company String
- created
At String - department String
- directory
Id Integer - distinguished
Name String - email String
- external
Id String - filters
List<Get
Users Filter> - firstname String
- group
Id Integer - invalid
Login IntegerAttempts - invitation
Sent StringAt - last
Login String - lastname String
- locked
Until String - manager
Ad StringId - manager
User StringId - member
Of String - password String
- password
Algorithm String - password
Changed StringAt - password
Confirmation String - phone String
- preferred
Locale StringCode - role
Ids List<Integer> - salt String
- samaccountname String
- state Integer
- status Integer
- title String
- trusted
Idp IntegerId - updated
At String - username String
- userprincipalname String
- activated
At string - comment string
- company string
- created
At string - department string
- directory
Id number - distinguished
Name string - email string
- external
Id string - filters
Get
Users Filter[] - firstname string
- group
Id number - invalid
Login numberAttempts - invitation
Sent stringAt - last
Login string - lastname string
- locked
Until string - manager
Ad stringId - manager
User stringId - member
Of string - password string
- password
Algorithm string - password
Changed stringAt - password
Confirmation string - phone string
- preferred
Locale stringCode - role
Ids number[] - salt string
- samaccountname string
- state number
- status number
- title string
- trusted
Idp numberId - updated
At string - username string
- userprincipalname string
- activated_
at str - comment str
- company str
- created_
at str - department str
- directory_
id int - distinguished_
name str - email str
- external_
id str - filters
Sequence[Get
Users Filter] - firstname str
- group_
id int - invalid_
login_ intattempts - invitation_
sent_ strat - last_
login str - lastname str
- locked_
until str - manager_
ad_ strid - manager_
user_ strid - member_
of str - password str
- password_
algorithm str - password_
changed_ strat - password_
confirmation str - phone str
- preferred_
locale_ strcode - role_
ids Sequence[int] - salt str
- samaccountname str
- state int
- status int
- title str
- trusted_
idp_ intid - updated_
at str - username str
- userprincipalname str
- activated
At String - comment String
- company String
- created
At String - department String
- directory
Id Number - distinguished
Name String - email String
- external
Id String - filters List<Property Map>
- firstname String
- group
Id Number - invalid
Login NumberAttempts - invitation
Sent StringAt - last
Login String - lastname String
- locked
Until String - manager
Ad StringId - manager
User StringId - member
Of String - password String
- password
Algorithm String - password
Changed StringAt - password
Confirmation String - phone String
- preferred
Locale StringCode - role
Ids List<Number> - salt String
- samaccountname String
- state Number
- status Number
- title String
- trusted
Idp NumberId - updated
At String - username String
- userprincipalname String
getUsers Result
The following output properties are available:
- Activated
At string - Comment string
- Company string
- Created
At string - Department string
- Directory
Id int - Distinguished
Name string - Email string
- External
Id string - Firstname string
- Group
Id int - Id string
- The provider-assigned unique ID for this managed resource.
- Invalid
Login intAttempts - Invitation
Sent stringAt - Last
Login string - Lastname string
- Locked
Until string - Manager
Ad stringId - Manager
User stringId - Member
Of string - Password string
- Password
Algorithm string - Password
Changed stringAt - Password
Confirmation string - Phone string
- Preferred
Locale stringCode - Role
Ids List<int> - Salt string
- Samaccountname string
- State int
- Status int
- Title string
- Trusted
Idp intId - Updated
At string - Username string
- Userprincipalname string
- Filters
List<Get
Users Filter>
- Activated
At string - Comment string
- Company string
- Created
At string - Department string
- Directory
Id int - Distinguished
Name string - Email string
- External
Id string - Firstname string
- Group
Id int - Id string
- The provider-assigned unique ID for this managed resource.
- Invalid
Login intAttempts - Invitation
Sent stringAt - Last
Login string - Lastname string
- Locked
Until string - Manager
Ad stringId - Manager
User stringId - Member
Of string - Password string
- Password
Algorithm string - Password
Changed stringAt - Password
Confirmation string - Phone string
- Preferred
Locale stringCode - Role
Ids []int - Salt string
- Samaccountname string
- State int
- Status int
- Title string
- Trusted
Idp intId - Updated
At string - Username string
- Userprincipalname string
- Filters
[]Get
Users Filter
- activated
At String - comment String
- company String
- created
At String - department String
- directory
Id Integer - distinguished
Name String - email String
- external
Id String - firstname String
- group
Id Integer - id String
- The provider-assigned unique ID for this managed resource.
- invalid
Login IntegerAttempts - invitation
Sent StringAt - last
Login String - lastname String
- locked
Until String - manager
Ad StringId - manager
User StringId - member
Of String - password String
- password
Algorithm String - password
Changed StringAt - password
Confirmation String - phone String
- preferred
Locale StringCode - role
Ids List<Integer> - salt String
- samaccountname String
- state Integer
- status Integer
- title String
- trusted
Idp IntegerId - updated
At String - username String
- userprincipalname String
- filters
List<Get
Users Filter>
- activated
At string - comment string
- company string
- created
At string - department string
- directory
Id number - distinguished
Name string - email string
- external
Id string - firstname string
- group
Id number - id string
- The provider-assigned unique ID for this managed resource.
- invalid
Login numberAttempts - invitation
Sent stringAt - last
Login string - lastname string
- locked
Until string - manager
Ad stringId - manager
User stringId - member
Of string - password string
- password
Algorithm string - password
Changed stringAt - password
Confirmation string - phone string
- preferred
Locale stringCode - role
Ids number[] - salt string
- samaccountname string
- state number
- status number
- title string
- trusted
Idp numberId - updated
At string - username string
- userprincipalname string
- filters
Get
Users Filter[]
- activated_
at str - comment str
- company str
- created_
at str - department str
- directory_
id int - distinguished_
name str - email str
- external_
id str - firstname str
- group_
id int - id str
- The provider-assigned unique ID for this managed resource.
- invalid_
login_ intattempts - invitation_
sent_ strat - last_
login str - lastname str
- locked_
until str - manager_
ad_ strid - manager_
user_ strid - member_
of str - password str
- password_
algorithm str - password_
changed_ strat - password_
confirmation str - phone str
- preferred_
locale_ strcode - role_
ids Sequence[int] - salt str
- samaccountname str
- state int
- status int
- title str
- trusted_
idp_ intid - updated_
at str - username str
- userprincipalname str
- filters
Sequence[Get
Users Filter]
- activated
At String - comment String
- company String
- created
At String - department String
- directory
Id Number - distinguished
Name String - email String
- external
Id String - firstname String
- group
Id Number - id String
- The provider-assigned unique ID for this managed resource.
- invalid
Login NumberAttempts - invitation
Sent StringAt - last
Login String - lastname String
- locked
Until String - manager
Ad StringId - manager
User StringId - member
Of String - password String
- password
Algorithm String - password
Changed StringAt - password
Confirmation String - phone String
- preferred
Locale StringCode - role
Ids List<Number> - salt String
- samaccountname String
- state Number
- status Number
- title String
- trusted
Idp NumberId - updated
At String - username String
- userprincipalname String
- filters List<Property Map>
Supporting Types
GetUsersFilter
Package Details
- Repository
- onelogin pulumi/pulumi-onelogin
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
onelogin
Terraform Provider.