1. Packages
  2. Onelogin Provider
  3. API Docs
  4. getUsers
onelogin 0.5.4 published on Wednesday, Apr 30, 2025 by onelogin

onelogin.getUsers

Explore with Pulumi AI

onelogin logo
onelogin 0.5.4 published on Wednesday, Apr 30, 2025 by onelogin

    Returns User IDs matching the given attributes.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as onelogin from "@pulumi/onelogin";
    
    const example = onelogin.getUsers({
        firstname: "tom",
    });
    
    import pulumi
    import pulumi_onelogin as onelogin
    
    example = onelogin.get_users(firstname="tom")
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-terraform-provider/sdks/go/onelogin/onelogin"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := onelogin.LookupUsers(ctx, &onelogin.LookupUsersArgs{
    			Firstname: pulumi.StringRef("tom"),
    		}, nil)
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Onelogin = Pulumi.Onelogin;
    
    return await Deployment.RunAsync(() => 
    {
        var example = Onelogin.GetUsers.Invoke(new()
        {
            Firstname = "tom",
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.onelogin.OneloginFunctions;
    import com.pulumi.onelogin.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 = OneloginFunctions.getUsers(GetUsersArgs.builder()
                .firstname("tom")
                .build());
    
        }
    }
    
    variables:
      example:
        fn::invoke:
          function: onelogin:getUsers
          arguments:
            firstname: tom
    

    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(directory_id: Optional[float] = None,
                  external_id: Optional[float] = None,
                  firstname: Optional[str] = None,
                  id: Optional[str] = None,
                  lastname: Optional[str] = None,
                  samaccountname: Optional[str] = None,
                  user_id: Optional[str] = None,
                  username: Optional[str] = None,
                  opts: Optional[InvokeOptions] = None) -> GetUsersResult
    def get_users_output(directory_id: Optional[pulumi.Input[float]] = None,
                  external_id: Optional[pulumi.Input[float]] = None,
                  firstname: Optional[pulumi.Input[str]] = None,
                  id: Optional[pulumi.Input[str]] = None,
                  lastname: Optional[pulumi.Input[str]] = None,
                  samaccountname: Optional[pulumi.Input[str]] = None,
                  user_id: Optional[pulumi.Input[str]] = None,
                  username: Optional[pulumi.Input[str]] = None,
                  opts: Optional[InvokeOptions] = None) -> Output[GetUsersResult]
    func LookupUsers(ctx *Context, args *LookupUsersArgs, opts ...InvokeOption) (*LookupUsersResult, error)
    func LookupUsersOutput(ctx *Context, args *LookupUsersOutputArgs, opts ...InvokeOption) LookupUsersResultOutput

    > Note: This function is named LookupUsers 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: onelogin:index/getUsers:getUsers
      arguments:
        # arguments dictionary

    The following arguments are supported:

    DirectoryId double
    The user's directory_id
    ExternalId double
    The user's external_id
    Firstname string
    The user's first name
    Id string
    Lastname string
    The user's last name
    Samaccountname string
    The user's samaccount name
    UserId string
    Username string
    The user's username.
    DirectoryId float64
    The user's directory_id
    ExternalId float64
    The user's external_id
    Firstname string
    The user's first name
    Id string
    Lastname string
    The user's last name
    Samaccountname string
    The user's samaccount name
    UserId string
    Username string
    The user's username.
    directoryId Double
    The user's directory_id
    externalId Double
    The user's external_id
    firstname String
    The user's first name
    id String
    lastname String
    The user's last name
    samaccountname String
    The user's samaccount name
    userId String
    username String
    The user's username.
    directoryId number
    The user's directory_id
    externalId number
    The user's external_id
    firstname string
    The user's first name
    id string
    lastname string
    The user's last name
    samaccountname string
    The user's samaccount name
    userId string
    username string
    The user's username.
    directory_id float
    The user's directory_id
    external_id float
    The user's external_id
    firstname str
    The user's first name
    id str
    lastname str
    The user's last name
    samaccountname str
    The user's samaccount name
    user_id str
    username str
    The user's username.
    directoryId Number
    The user's directory_id
    externalId Number
    The user's external_id
    firstname String
    The user's first name
    id String
    lastname String
    The user's last name
    samaccountname String
    The user's samaccount name
    userId String
    username String
    The user's username.

    getUsers Result

    The following output properties are available:

    Id string
    Ids List<string>
    List of user's id
    Users List<GetUsersUser>
    DirectoryId double
    ExternalId double
    Firstname string
    Lastname string
    Samaccountname string
    UserId string
    Username string
    Id string
    Ids []string
    List of user's id
    Users []GetUsersUser
    DirectoryId float64
    ExternalId float64
    Firstname string
    Lastname string
    Samaccountname string
    UserId string
    Username string
    id String
    ids List<String>
    List of user's id
    users List<GetUsersUser>
    directoryId Double
    externalId Double
    firstname String
    lastname String
    samaccountname String
    userId String
    username String
    id string
    ids string[]
    List of user's id
    users GetUsersUser[]
    directoryId number
    externalId number
    firstname string
    lastname string
    samaccountname string
    userId string
    username string
    id str
    ids Sequence[str]
    List of user's id
    users Sequence[GetUsersUser]
    directory_id float
    external_id float
    firstname str
    lastname str
    samaccountname str
    user_id str
    username str
    id String
    ids List<String>
    List of user's id
    users List<Property Map>
    directoryId Number
    externalId Number
    firstname String
    lastname String
    samaccountname String
    userId String
    username String

    Supporting Types

    GetUsersUser

    DirectoryId double
    The user's directory_id
    Email string
    The user's email.
    ExternalId double
    The user's external_id
    Firstname string
    The user's first name
    Id double
    LastLogin string
    Lastname string
    The user's last name
    Samaccountname string
    The user's samaccount name
    Username string
    The user's username.
    DirectoryId float64
    The user's directory_id
    Email string
    The user's email.
    ExternalId float64
    The user's external_id
    Firstname string
    The user's first name
    Id float64
    LastLogin string
    Lastname string
    The user's last name
    Samaccountname string
    The user's samaccount name
    Username string
    The user's username.
    directoryId Double
    The user's directory_id
    email String
    The user's email.
    externalId Double
    The user's external_id
    firstname String
    The user's first name
    id Double
    lastLogin String
    lastname String
    The user's last name
    samaccountname String
    The user's samaccount name
    username String
    The user's username.
    directoryId number
    The user's directory_id
    email string
    The user's email.
    externalId number
    The user's external_id
    firstname string
    The user's first name
    id number
    lastLogin string
    lastname string
    The user's last name
    samaccountname string
    The user's samaccount name
    username string
    The user's username.
    directory_id float
    The user's directory_id
    email str
    The user's email.
    external_id float
    The user's external_id
    firstname str
    The user's first name
    id float
    last_login str
    lastname str
    The user's last name
    samaccountname str
    The user's samaccount name
    username str
    The user's username.
    directoryId Number
    The user's directory_id
    email String
    The user's email.
    externalId Number
    The user's external_id
    firstname String
    The user's first name
    id Number
    lastLogin String
    lastname String
    The user's last name
    samaccountname String
    The user's samaccount name
    username String
    The user's username.

    Package Details

    Repository
    onelogin onelogin/terraform-provider-onelogin
    License
    Notes
    This Pulumi package is based on the onelogin Terraform Provider.
    onelogin logo
    onelogin 0.5.4 published on Wednesday, Apr 30, 2025 by onelogin