onelogin v0.6.0, Apr 25 23

onelogin v0.6.0 published on Tuesday, Apr 25, 2023 by Pulumi

onelogin.User

Explore with Pulumi AI

onelogin v0.6.0 published on Tuesday, Apr 25, 2023 by Pulumi

Create User Resource

new User(name: string, args?: UserArgs, opts?: CustomResourceOptions);

@overload
def User(resource_name: str,
         opts: Optional[ResourceOptions] = None,
         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,
         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)
@overload
def User(resource_name: str,
         args: Optional[UserArgs] = None,
         opts: Optional[ResourceOptions] = None)

func NewUser(ctx *Context, name string, args *UserArgs, opts ...ResourceOption) (*User, error)

public User(string name, UserArgs? args = null, 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:

ActivatedAt string
Comment string: Free text related to the user.
Company string: The user's company.
CreatedAt string
Department string: The user's department.
DirectoryId int: The ID of the OneLogin Directory of the user.
DistinguishedName string: The distinguished name of the user.
Email string: A valid email for the user.
ExternalId string: The ID of the user in an external directory.
Firstname string: The user's first name.
GroupId int: The ID of the Group in OneLogin that the user is assigned to.
InvalidLoginAttempts int
InvitationSentAt string
LastLogin string
Lastname string: The user's last name.
LockedUntil string
ManagerAdId string: The ID of the user's manager in Active Directory.
ManagerUserId string: The OneLogin User ID for the user's manager.
MemberOf string: The user's directory membership.
Password string: The password to set for a user.
PasswordAlgorithm string: Use this when importing a password that's already hashed. Prepend the salt value to the cleartext password value before SHA-256-encoding it
PasswordChangedAt string
PasswordConfirmation string: Required if the password is being set.
Phone string: The E.164 format phone number for a user.
PreferredLocaleCode string
RoleIds List<int>: A list of OneLogin Role IDs of the user
Salt string: The salt value used with the password_algorithm.
Samaccountname string: The user's Active Directory username.
State int
Status int
Title string: The user's job title.
TrustedIdpId int: The ID of the OneLogin Trusted IDP of the user.
UpdatedAt string
Username string: A username for the user.
Userprincipalname string: The principle name of the user.

ActivatedAt string
Comment string: Free text related to the user.
Company string: The user's company.
CreatedAt string
Department string: The user's department.
DirectoryId int: The ID of the OneLogin Directory of the user.
DistinguishedName string: The distinguished name of the user.
Email string: A valid email for the user.
ExternalId string: The ID of the user in an external directory.
Firstname string: The user's first name.
GroupId int: The ID of the Group in OneLogin that the user is assigned to.
InvalidLoginAttempts int
InvitationSentAt string
LastLogin string
Lastname string: The user's last name.
LockedUntil string
ManagerAdId string: The ID of the user's manager in Active Directory.
ManagerUserId string: The OneLogin User ID for the user's manager.
MemberOf string: The user's directory membership.
Password string: The password to set for a user.
PasswordAlgorithm string: Use this when importing a password that's already hashed. Prepend the salt value to the cleartext password value before SHA-256-encoding it
PasswordChangedAt string
PasswordConfirmation string: Required if the password is being set.
Phone string: The E.164 format phone number for a user.
PreferredLocaleCode string
RoleIds []int: A list of OneLogin Role IDs of the user
Salt string: The salt value used with the password_algorithm.
Samaccountname string: The user's Active Directory username.
State int
Status int
Title string: The user's job title.
TrustedIdpId int: The ID of the OneLogin Trusted IDP of the user.
UpdatedAt string
Username string: A username for the user.
Userprincipalname string: The principle name of the user.

activatedAt String
comment String: Free text related to the user.
company String: The user's company.
createdAt String
department String: The user's department.
directoryId Integer: The ID of the OneLogin Directory of the user.
distinguishedName String: The distinguished name of the user.
email String: A valid email for the user.
externalId String: The ID of the user in an external directory.
firstname String: The user's first name.
groupId Integer: The ID of the Group in OneLogin that the user is assigned to.
invalidLoginAttempts Integer
invitationSentAt String
lastLogin String
lastname String: The user's last name.
lockedUntil String
managerAdId String: The ID of the user's manager in Active Directory.
managerUserId String: The OneLogin User ID for the user's manager.
memberOf String: The user's directory membership.
password String: The password to set for a user.
passwordAlgorithm String: Use this when importing a password that's already hashed. Prepend the salt value to the cleartext password value before SHA-256-encoding it
passwordChangedAt String
passwordConfirmation String: Required if the password is being set.
phone String: The E.164 format phone number for a user.
preferredLocaleCode String
roleIds List<Integer>: A list of OneLogin Role IDs of the user
salt String: The salt value used with the password_algorithm.
samaccountname String: The user's Active Directory username.
state Integer
status Integer
title String: The user's job title.
trustedIdpId Integer: The ID of the OneLogin Trusted IDP of the user.
updatedAt String
username String: A username for the user.
userprincipalname String: The principle name of the user.

activatedAt string
comment string: Free text related to the user.
company string: The user's company.
createdAt string
department string: The user's department.
directoryId number: The ID of the OneLogin Directory of the user.
distinguishedName string: The distinguished name of the user.
email string: A valid email for the user.
externalId string: The ID of the user in an external directory.
firstname string: The user's first name.
groupId number: The ID of the Group in OneLogin that the user is assigned to.
invalidLoginAttempts number
invitationSentAt string
lastLogin string
lastname string: The user's last name.
lockedUntil string
managerAdId string: The ID of the user's manager in Active Directory.
managerUserId string: The OneLogin User ID for the user's manager.
memberOf string: The user's directory membership.
password string: The password to set for a user.
passwordAlgorithm string: Use this when importing a password that's already hashed. Prepend the salt value to the cleartext password value before SHA-256-encoding it
passwordChangedAt string
passwordConfirmation string: Required if the password is being set.
phone string: The E.164 format phone number for a user.
preferredLocaleCode string
roleIds number[]: A list of OneLogin Role IDs of the user
salt string: The salt value used with the password_algorithm.
samaccountname string: The user's Active Directory username.
state number
status number
title string: The user's job title.
trustedIdpId number: The ID of the OneLogin Trusted IDP of the user.
updatedAt string
username string: A username for the user.
userprincipalname string: The principle name of the user.

activated_at str
comment str: Free text related to the user.
company str: The user's company.
created_at str
department str: The user's department.
directory_id int: The ID of the OneLogin Directory of the user.
distinguished_name str: The distinguished name of the user.
email str: A valid email for the user.
external_id str: The ID of the user in an external directory.
firstname str: The user's first name.
group_id int: The ID of the Group in OneLogin that the user is assigned to.
invalid_login_attempts int
invitation_sent_at str
last_login str
lastname str: The user's last name.
locked_until str
manager_ad_id str: The ID of the user's manager in Active Directory.
manager_user_id str: The OneLogin User ID for the user's manager.
member_of str: The user's directory membership.
password str: The password to set for a user.
password_algorithm str: Use this when importing a password that's already hashed. Prepend the salt value to the cleartext password value before SHA-256-encoding it
password_changed_at str
password_confirmation str: Required if the password is being set.
phone str: The E.164 format phone number for a user.
preferred_locale_code str
role_ids Sequence[int]: A list of OneLogin Role IDs of the user
salt str: The salt value used with the password_algorithm.
samaccountname str: The user's Active Directory username.
state int
status int
title str: The user's job title.
trusted_idp_id int: The ID of the OneLogin Trusted IDP of the user.
updated_at str
username str: A username for the user.
userprincipalname str: The principle name of the user.

activatedAt String
comment String: Free text related to the user.
company String: The user's company.
createdAt String
department String: The user's department.
directoryId Number: The ID of the OneLogin Directory of the user.
distinguishedName String: The distinguished name of the user.
email String: A valid email for the user.
externalId String: The ID of the user in an external directory.
firstname String: The user's first name.
groupId Number: The ID of the Group in OneLogin that the user is assigned to.
invalidLoginAttempts Number
invitationSentAt String
lastLogin String
lastname String: The user's last name.
lockedUntil String
managerAdId String: The ID of the user's manager in Active Directory.
managerUserId String: The OneLogin User ID for the user's manager.
memberOf String: The user's directory membership.
password String: The password to set for a user.
passwordAlgorithm String: Use this when importing a password that's already hashed. Prepend the salt value to the cleartext password value before SHA-256-encoding it
passwordChangedAt String
passwordConfirmation String: Required if the password is being set.
phone String: The E.164 format phone number for a user.
preferredLocaleCode String
roleIds List<Number>: A list of OneLogin Role IDs of the user
salt String: The salt value used with the password_algorithm.
samaccountname String: The user's Active Directory username.
state Number
status Number
title String: The user's job title.
trustedIdpId Number: The ID of the OneLogin Trusted IDP of the user.
updatedAt String
username String: A username for the user.
userprincipalname String: The principle name of the user.

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,
        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,
        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) -> 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:

ActivatedAt string
Comment string: Free text related to the user.
Company string: The user's company.
CreatedAt string
Department string: The user's department.
DirectoryId int: The ID of the OneLogin Directory of the user.
DistinguishedName string: The distinguished name of the user.
Email string: A valid email for the user.
ExternalId string: The ID of the user in an external directory.
Firstname string: The user's first name.
GroupId int: The ID of the Group in OneLogin that the user is assigned to.
InvalidLoginAttempts int
InvitationSentAt string
LastLogin string
Lastname string: The user's last name.
LockedUntil string
ManagerAdId string: The ID of the user's manager in Active Directory.
ManagerUserId string: The OneLogin User ID for the user's manager.
MemberOf string: The user's directory membership.
Password string: The password to set for a user.
PasswordAlgorithm string: Use this when importing a password that's already hashed. Prepend the salt value to the cleartext password value before SHA-256-encoding it
PasswordChangedAt string
PasswordConfirmation string: Required if the password is being set.
Phone string: The E.164 format phone number for a user.
PreferredLocaleCode string
RoleIds List<int>: A list of OneLogin Role IDs of the user
Salt string: The salt value used with the password_algorithm.
Samaccountname string: The user's Active Directory username.
State int
Status int
Title string: The user's job title.
TrustedIdpId int: The ID of the OneLogin Trusted IDP of the user.
UpdatedAt string
Username string: A username for the user.
Userprincipalname string: The principle name of the user.

ActivatedAt string
Comment string: Free text related to the user.
Company string: The user's company.
CreatedAt string
Department string: The user's department.
DirectoryId int: The ID of the OneLogin Directory of the user.
DistinguishedName string: The distinguished name of the user.
Email string: A valid email for the user.
ExternalId string: The ID of the user in an external directory.
Firstname string: The user's first name.
GroupId int: The ID of the Group in OneLogin that the user is assigned to.
InvalidLoginAttempts int
InvitationSentAt string
LastLogin string
Lastname string: The user's last name.
LockedUntil string
ManagerAdId string: The ID of the user's manager in Active Directory.
ManagerUserId string: The OneLogin User ID for the user's manager.
MemberOf string: The user's directory membership.
Password string: The password to set for a user.
PasswordAlgorithm string: Use this when importing a password that's already hashed. Prepend the salt value to the cleartext password value before SHA-256-encoding it
PasswordChangedAt string
PasswordConfirmation string: Required if the password is being set.
Phone string: The E.164 format phone number for a user.
PreferredLocaleCode string
RoleIds []int: A list of OneLogin Role IDs of the user
Salt string: The salt value used with the password_algorithm.
Samaccountname string: The user's Active Directory username.
State int
Status int
Title string: The user's job title.
TrustedIdpId int: The ID of the OneLogin Trusted IDP of the user.
UpdatedAt string
Username string: A username for the user.
Userprincipalname string: The principle name of the user.

activatedAt String
comment String: Free text related to the user.
company String: The user's company.
createdAt String
department String: The user's department.
directoryId Integer: The ID of the OneLogin Directory of the user.
distinguishedName String: The distinguished name of the user.
email String: A valid email for the user.
externalId String: The ID of the user in an external directory.
firstname String: The user's first name.
groupId Integer: The ID of the Group in OneLogin that the user is assigned to.
invalidLoginAttempts Integer
invitationSentAt String
lastLogin String
lastname String: The user's last name.
lockedUntil String
managerAdId String: The ID of the user's manager in Active Directory.
managerUserId String: The OneLogin User ID for the user's manager.
memberOf String: The user's directory membership.
password String: The password to set for a user.
passwordAlgorithm String: Use this when importing a password that's already hashed. Prepend the salt value to the cleartext password value before SHA-256-encoding it
passwordChangedAt String
passwordConfirmation String: Required if the password is being set.
phone String: The E.164 format phone number for a user.
preferredLocaleCode String
roleIds List<Integer>: A list of OneLogin Role IDs of the user
salt String: The salt value used with the password_algorithm.
samaccountname String: The user's Active Directory username.
state Integer
status Integer
title String: The user's job title.
trustedIdpId Integer: The ID of the OneLogin Trusted IDP of the user.
updatedAt String
username String: A username for the user.
userprincipalname String: The principle name of the user.

activatedAt string
comment string: Free text related to the user.
company string: The user's company.
createdAt string
department string: The user's department.
directoryId number: The ID of the OneLogin Directory of the user.
distinguishedName string: The distinguished name of the user.
email string: A valid email for the user.
externalId string: The ID of the user in an external directory.
firstname string: The user's first name.
groupId number: The ID of the Group in OneLogin that the user is assigned to.
invalidLoginAttempts number
invitationSentAt string
lastLogin string
lastname string: The user's last name.
lockedUntil string
managerAdId string: The ID of the user's manager in Active Directory.
managerUserId string: The OneLogin User ID for the user's manager.
memberOf string: The user's directory membership.
password string: The password to set for a user.
passwordAlgorithm string: Use this when importing a password that's already hashed. Prepend the salt value to the cleartext password value before SHA-256-encoding it
passwordChangedAt string
passwordConfirmation string: Required if the password is being set.
phone string: The E.164 format phone number for a user.
preferredLocaleCode string
roleIds number[]: A list of OneLogin Role IDs of the user
salt string: The salt value used with the password_algorithm.
samaccountname string: The user's Active Directory username.
state number
status number
title string: The user's job title.
trustedIdpId number: The ID of the OneLogin Trusted IDP of the user.
updatedAt string
username string: A username for the user.
userprincipalname string: The principle name of the user.

activated_at str
comment str: Free text related to the user.
company str: The user's company.
created_at str
department str: The user's department.
directory_id int: The ID of the OneLogin Directory of the user.
distinguished_name str: The distinguished name of the user.
email str: A valid email for the user.
external_id str: The ID of the user in an external directory.
firstname str: The user's first name.
group_id int: The ID of the Group in OneLogin that the user is assigned to.
invalid_login_attempts int
invitation_sent_at str
last_login str
lastname str: The user's last name.
locked_until str
manager_ad_id str: The ID of the user's manager in Active Directory.
manager_user_id str: The OneLogin User ID for the user's manager.
member_of str: The user's directory membership.
password str: The password to set for a user.
password_algorithm str: Use this when importing a password that's already hashed. Prepend the salt value to the cleartext password value before SHA-256-encoding it
password_changed_at str
password_confirmation str: Required if the password is being set.
phone str: The E.164 format phone number for a user.
preferred_locale_code str
role_ids Sequence[int]: A list of OneLogin Role IDs of the user
salt str: The salt value used with the password_algorithm.
samaccountname str: The user's Active Directory username.
state int
status int
title str: The user's job title.
trusted_idp_id int: The ID of the OneLogin Trusted IDP of the user.
updated_at str
username str: A username for the user.
userprincipalname str: The principle name of the user.

activatedAt String
comment String: Free text related to the user.
company String: The user's company.
createdAt String
department String: The user's department.
directoryId Number: The ID of the OneLogin Directory of the user.
distinguishedName String: The distinguished name of the user.
email String: A valid email for the user.
externalId String: The ID of the user in an external directory.
firstname String: The user's first name.
groupId Number: The ID of the Group in OneLogin that the user is assigned to.
invalidLoginAttempts Number
invitationSentAt String
lastLogin String
lastname String: The user's last name.
lockedUntil String
managerAdId String: The ID of the user's manager in Active Directory.
managerUserId String: The OneLogin User ID for the user's manager.
memberOf String: The user's directory membership.
password String: The password to set for a user.
passwordAlgorithm String: Use this when importing a password that's already hashed. Prepend the salt value to the cleartext password value before SHA-256-encoding it
passwordChangedAt String
passwordConfirmation String: Required if the password is being set.
phone String: The E.164 format phone number for a user.
preferredLocaleCode String
roleIds List<Number>: A list of OneLogin Role IDs of the user
salt String: The salt value used with the password_algorithm.
samaccountname String: The user's Active Directory username.
state Number
status Number
title String: The user's job title.
trustedIdpId Number: The ID of the OneLogin Trusted IDP of the user.
updatedAt String
username String: A username for the user.
userprincipalname String: The principle name of the user.

Package Details

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

onelogin v0.6.0 published on Tuesday, Apr 25, 2023 by Pulumi

pulumi/pulumi-onelogin

onelogin.User

On this page

On this page

Create User Resource

User Resource Properties

Inputs

Outputs

Look up Existing User Resource

Package Details

On this page

On this page