onelogin

v0.3.0 published on Wednesday, Jun 1, 2022 by Pulumi

getUser

Returns User resource.

Example Usage

using Pulumi;
using Onelogin = Pulumi.Onelogin;

class MyStack : Stack
{
    public MyStack()
    {
        var example = Output.Create(Onelogin.GetUser.InvokeAsync(new Onelogin.GetUserArgs
        {
            Username = "timmy.tester",
        }));
    }

}
package main

import (
	"github.com/pulumi/pulumi-onelogin/sdk/go/onelogin"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := onelogin.LookupUser(ctx, &GetUserArgs{
			Username: pulumi.StringRef("timmy.tester"),
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

Coming soon!

import pulumi
import pulumi_onelogin as onelogin

example = onelogin.get_user(username="timmy.tester")
import * as pulumi from "@pulumi/pulumi";
import * as onelogin from "@pulumi/onelogin";

const example = pulumi.output(onelogin.getUser({
    username: "timmy.tester",
}));

Coming soon!

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(external_id: Optional[int] = None,
             user_id: Optional[str] = None,
             username: Optional[str] = None,
             opts: Optional[InvokeOptions] = None) -> GetUserResult
def get_user_output(external_id: Optional[pulumi.Input[int]] = None,
             user_id: Optional[pulumi.Input[str]] = None,
             username: 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: onelogin:index/getUser:getUser
  arguments:
    # arguments dictionary

The following arguments are supported:

ExternalId int

The user's external_id

UserId string

The user's ID.

Username string

The user's username.

ExternalId int

The user's external_id

UserId string

The user's ID.

Username string

The user's username.

externalId Integer

The user's external_id

userId String

The user's ID.

username String

The user's username.

externalId number

The user's external_id

userId string

The user's ID.

username string

The user's username.

external_id int

The user's external_id

user_id str

The user's ID.

username str

The user's username.

externalId Number

The user's external_id

userId String

The user's ID.

username String

The user's username.

getUser Result

The following output properties are available:

Comment string

A comment about the user

Company string

The user's company

CustomAttributes Dictionary<string, string>
Department string

The user's department

DirectoryId int

The user's directory_id

DistinguishedName string

The user's distinguished name

Email string

The user's email.

ExternalId int

The user's external_id

Firstname string

The user's first name

GroupId int

The user's group_id

Id string

The provider-assigned unique ID for this managed resource.

Lastname string

The user's last name

ManagerAdId int

The user's manager_ad_id

ManagerUserId int

The user's manager_user_id

MemberOf string

The user's member_of

Phone string

The user's phone number

Samaccountname string

The user's samaccount name

State int

The user's state. Must be one of 0: Unapproved 1: Approved 2: Rejected 3: Unlicensed

Status int

The user's status. Must be one of 0: Unactivated 1: Active 2: Suspended 3: Locked 4: Password expired 5: Awaiting password reset 7: Password Pending 8: Security questions required

Title string

The user's title

TrustedIdpId int

The user's trusted_idp_id

Username string
Userprincipalname string

The user's user principal name

UserId string
Comment string

A comment about the user

Company string

The user's company

CustomAttributes map[string]string
Department string

The user's department

DirectoryId int

The user's directory_id

DistinguishedName string

The user's distinguished name

Email string

The user's email.

ExternalId int

The user's external_id

Firstname string

The user's first name

GroupId int

The user's group_id

Id string

The provider-assigned unique ID for this managed resource.

Lastname string

The user's last name

ManagerAdId int

The user's manager_ad_id

ManagerUserId int

The user's manager_user_id

MemberOf string

The user's member_of

Phone string

The user's phone number

Samaccountname string

The user's samaccount name

State int

The user's state. Must be one of 0: Unapproved 1: Approved 2: Rejected 3: Unlicensed

Status int

The user's status. Must be one of 0: Unactivated 1: Active 2: Suspended 3: Locked 4: Password expired 5: Awaiting password reset 7: Password Pending 8: Security questions required

Title string

The user's title

TrustedIdpId int

The user's trusted_idp_id

Username string
Userprincipalname string

The user's user principal name

UserId string
comment String

A comment about the user

company String

The user's company

customAttributes Map<String,String>
department String

The user's department

directoryId Integer

The user's directory_id

distinguishedName String

The user's distinguished name

email String

The user's email.

externalId Integer

The user's external_id

firstname String

The user's first name

groupId Integer

The user's group_id

id String

The provider-assigned unique ID for this managed resource.

lastname String

The user's last name

managerAdId Integer

The user's manager_ad_id

managerUserId Integer

The user's manager_user_id

memberOf String

The user's member_of

phone String

The user's phone number

samaccountname String

The user's samaccount name

state Integer

The user's state. Must be one of 0: Unapproved 1: Approved 2: Rejected 3: Unlicensed

status Integer

The user's status. Must be one of 0: Unactivated 1: Active 2: Suspended 3: Locked 4: Password expired 5: Awaiting password reset 7: Password Pending 8: Security questions required

title String

The user's title

trustedIdpId Integer

The user's trusted_idp_id

username String
userprincipalname String

The user's user principal name

userId String
comment string

A comment about the user

company string

The user's company

customAttributes {[key: string]: string}
department string

The user's department

directoryId number

The user's directory_id

distinguishedName string

The user's distinguished name

email string

The user's email.

externalId number

The user's external_id

firstname string

The user's first name

groupId number

The user's group_id

id string

The provider-assigned unique ID for this managed resource.

lastname string

The user's last name

managerAdId number

The user's manager_ad_id

managerUserId number

The user's manager_user_id

memberOf string

The user's member_of

phone string

The user's phone number

samaccountname string

The user's samaccount name

state number

The user's state. Must be one of 0: Unapproved 1: Approved 2: Rejected 3: Unlicensed

status number

The user's status. Must be one of 0: Unactivated 1: Active 2: Suspended 3: Locked 4: Password expired 5: Awaiting password reset 7: Password Pending 8: Security questions required

title string

The user's title

trustedIdpId number

The user's trusted_idp_id

username string
userprincipalname string

The user's user principal name

userId string
comment str

A comment about the user

company str

The user's company

custom_attributes Mapping[str, str]
department str

The user's department

directory_id int

The user's directory_id

distinguished_name str

The user's distinguished name

email str

The user's email.

external_id int

The user's external_id

firstname str

The user's first name

group_id int

The user's group_id

id str

The provider-assigned unique ID for this managed resource.

lastname str

The user's last name

manager_ad_id int

The user's manager_ad_id

manager_user_id int

The user's manager_user_id

member_of str

The user's member_of

phone str

The user's phone number

samaccountname str

The user's samaccount name

state int

The user's state. Must be one of 0: Unapproved 1: Approved 2: Rejected 3: Unlicensed

status int

The user's status. Must be one of 0: Unactivated 1: Active 2: Suspended 3: Locked 4: Password expired 5: Awaiting password reset 7: Password Pending 8: Security questions required

title str

The user's title

trusted_idp_id int

The user's trusted_idp_id

username str
userprincipalname str

The user's user principal name

user_id str
comment String

A comment about the user

company String

The user's company

customAttributes Map<String>
department String

The user's department

directoryId Number

The user's directory_id

distinguishedName String

The user's distinguished name

email String

The user's email.

externalId Number

The user's external_id

firstname String

The user's first name

groupId Number

The user's group_id

id String

The provider-assigned unique ID for this managed resource.

lastname String

The user's last name

managerAdId Number

The user's manager_ad_id

managerUserId Number

The user's manager_user_id

memberOf String

The user's member_of

phone String

The user's phone number

samaccountname String

The user's samaccount name

state Number

The user's state. Must be one of 0: Unapproved 1: Approved 2: Rejected 3: Unlicensed

status Number

The user's status. Must be one of 0: Unactivated 1: Active 2: Suspended 3: Locked 4: Password expired 5: Awaiting password reset 7: Password Pending 8: Security questions required

title String

The user's title

trustedIdpId Number

The user's trusted_idp_id

username String
userprincipalname String

The user's user principal name

userId String

Package Details

Repository
https://github.com/pulumi/pulumi-onelogin
License
Apache-2.0
Notes

This Pulumi package is based on the onelogin Terraform Provider.