onelogin

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

User

Manage User resources.

This resource allows you to create and configure Users.

Example Usage

using Pulumi;
using Onelogin = Pulumi.Onelogin;

class MyStack : Stack
{
    public MyStack()
    {
        var example = new Onelogin.User("example", new Onelogin.UserArgs
        {
            Email = "timmy.tester@test.com",
            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.NewUser(ctx, "example", &onelogin.UserArgs{
			Email:    pulumi.String("timmy.tester@test.com"),
			Username: pulumi.String("timmy.tester"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

Coming soon!

import pulumi
import pulumi_onelogin as onelogin

example = onelogin.User("example",
    email="timmy.tester@test.com",
    username="timmy.tester")
import * as pulumi from "@pulumi/pulumi";
import * as onelogin from "@pulumi/onelogin";

const example = new onelogin.User("example", {
    email: "timmy.tester@test.com",
    username: "timmy.tester",
});

Coming soon!

Create User Resource

new User(name: string, args: UserArgs, opts?: CustomResourceOptions);
@overload
def User(resource_name: str,
         opts: Optional[ResourceOptions] = None,
         comment: Optional[str] = None,
         company: Optional[str] = None,
         custom_attributes: Optional[Mapping[str, str]] = None,
         department: Optional[str] = None,
         directory_id: Optional[int] = None,
         distinguished_name: Optional[str] = None,
         email: Optional[str] = None,
         external_id: Optional[int] = None,
         firstname: Optional[str] = None,
         group_id: Optional[int] = None,
         lastname: Optional[str] = None,
         manager_ad_id: Optional[int] = None,
         manager_user_id: Optional[int] = None,
         member_of: Optional[str] = None,
         phone: 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,
         username: Optional[str] = None,
         userprincipalname: Optional[str] = None)
@overload
def User(resource_name: str,
         args: UserArgs,
         opts: Optional[ResourceOptions] = None)
func NewUser(ctx *Context, name string, args UserArgs, opts ...ResourceOption) (*User, error)
public User(string name, UserArgs args, CustomResourceOptions? opts = null)
public User(String name, UserArgs args)
public User(String name, UserArgs args, CustomResourceOptions options)
type: onelogin:User
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

name string
The unique name of the resource.
args UserArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name str
The unique name of the resource.
args UserArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name string
The unique name of the resource.
args UserArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name string
The unique name of the resource.
args UserArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name String
The unique name of the resource.
args UserArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

User Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

The User resource accepts the following input properties:

Email string

The user's email.

Username string

The user's username.

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

ExternalId int

The user's external_id

Firstname string

The user's first name

GroupId int

The user's group_id

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

Userprincipalname string

The user's user principal name

Email string

The user's email.

Username string

The user's username.

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

ExternalId int

The user's external_id

Firstname string

The user's first name

GroupId int

The user's group_id

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

Userprincipalname string

The user's user principal name

email String

The user's email.

username String

The user's username.

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

externalId Integer

The user's external_id

firstname String

The user's first name

groupId Integer

The user's group_id

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

userprincipalname String

The user's user principal name

email string

The user's email.

username string

The user's username.

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

externalId number

The user's external_id

firstname string

The user's first name

groupId number

The user's group_id

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

userprincipalname string

The user's user principal name

email str

The user's email.

username str

The user's username.

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

external_id int

The user's external_id

firstname str

The user's first name

group_id int

The user's group_id

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

userprincipalname str

The user's user principal name

email String

The user's email.

username String

The user's username.

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

externalId Number

The user's external_id

firstname String

The user's first name

groupId Number

The user's group_id

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

userprincipalname String

The user's user principal name

Outputs

All input properties are implicitly available as output properties. Additionally, the User resource produces the following output properties:

Id string

The provider-assigned unique ID for this managed resource.

Id string

The provider-assigned unique ID for this managed resource.

id String

The provider-assigned unique ID for this managed resource.

id string

The provider-assigned unique ID for this managed resource.

id str

The provider-assigned unique ID for this managed resource.

id String

The provider-assigned unique ID for this managed resource.

Look up Existing User Resource

Get an existing User resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

public static get(name: string, id: Input<ID>, state?: UserState, opts?: CustomResourceOptions): User
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        comment: Optional[str] = None,
        company: Optional[str] = None,
        custom_attributes: Optional[Mapping[str, str]] = None,
        department: Optional[str] = None,
        directory_id: Optional[int] = None,
        distinguished_name: Optional[str] = None,
        email: Optional[str] = None,
        external_id: Optional[int] = None,
        firstname: Optional[str] = None,
        group_id: Optional[int] = None,
        lastname: Optional[str] = None,
        manager_ad_id: Optional[int] = None,
        manager_user_id: Optional[int] = None,
        member_of: Optional[str] = None,
        phone: 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,
        username: Optional[str] = None,
        userprincipalname: Optional[str] = None) -> User
func GetUser(ctx *Context, name string, id IDInput, state *UserState, opts ...ResourceOption) (*User, error)
public static User Get(string name, Input<string> id, UserState? state, CustomResourceOptions? opts = null)
public static User get(String name, Output<String> id, UserState state, CustomResourceOptions options)
Resource lookup is not supported in YAML
name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
resource_name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
The following state arguments are supported:
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

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

The user's username.

Userprincipalname string

The user's user principal name

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

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

The user's username.

Userprincipalname string

The user's user principal name

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

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

The user's username.

userprincipalname String

The user's user principal name

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

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

The user's username.

userprincipalname string

The user's user principal name

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

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

The user's username.

userprincipalname str

The user's user principal name

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

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

The user's username.

userprincipalname String

The user's user principal name

Import

A User can be imported via the OneLogin User ID.

 $ pulumi import onelogin:index/user:User example 12345678

Package Details

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

This Pulumi package is based on the onelogin Terraform Provider.