onelogin.User
Explore with Pulumi AI
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)
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:
- Activated
At string - Comment string
Free text related to the user.
- Company string
The user's company.
- Created
At string - Department string
The user's department.
- Directory
Id int The ID of the OneLogin Directory of the user.
- Distinguished
Name string The distinguished name of the user.
- Email string
A valid email for the user.
- External
Id string The ID of the user in an external directory.
- Firstname string
The user's first name.
- Group
Id int The ID of the Group in OneLogin that the user is assigned to.
- Invalid
Login intAttempts - Invitation
Sent stringAt - Last
Login string - Lastname string
The user's last name.
- Locked
Until string - Manager
Ad stringId The ID of the user's manager in Active Directory.
- Manager
User stringId The OneLogin User ID for the user's manager.
- Member
Of string The user's directory membership.
- Password string
The password to set for a user.
- Password
Algorithm 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
- Password
Changed stringAt - Password
Confirmation string Required if the password is being set.
- Phone string
The E.164 format phone number for a user.
- Preferred
Locale stringCode - Role
Ids 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.
- Trusted
Idp intId The ID of the OneLogin Trusted IDP of the user.
- Updated
At string - Username string
A username for the user.
- Userprincipalname string
The principle name of the user.
- Activated
At string - Comment string
Free text related to the user.
- Company string
The user's company.
- Created
At string - Department string
The user's department.
- Directory
Id int The ID of the OneLogin Directory of the user.
- Distinguished
Name string The distinguished name of the user.
- Email string
A valid email for the user.
- External
Id string The ID of the user in an external directory.
- Firstname string
The user's first name.
- Group
Id int The ID of the Group in OneLogin that the user is assigned to.
- Invalid
Login intAttempts - Invitation
Sent stringAt - Last
Login string - Lastname string
The user's last name.
- Locked
Until string - Manager
Ad stringId The ID of the user's manager in Active Directory.
- Manager
User stringId The OneLogin User ID for the user's manager.
- Member
Of string The user's directory membership.
- Password string
The password to set for a user.
- Password
Algorithm 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
- Password
Changed stringAt - Password
Confirmation string Required if the password is being set.
- Phone string
The E.164 format phone number for a user.
- Preferred
Locale stringCode - Role
Ids []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.
- Trusted
Idp intId The ID of the OneLogin Trusted IDP of the user.
- Updated
At string - Username string
A username for the user.
- Userprincipalname string
The principle name of the user.
- activated
At String - comment String
Free text related to the user.
- company String
The user's company.
- created
At String - department String
The user's department.
- directory
Id Integer The ID of the OneLogin Directory of the user.
- distinguished
Name String The distinguished name of the user.
- email String
A valid email for the user.
- external
Id String The ID of the user in an external directory.
- firstname String
The user's first name.
- group
Id Integer The ID of the Group in OneLogin that the user is assigned to.
- invalid
Login IntegerAttempts - invitation
Sent StringAt - last
Login String - lastname String
The user's last name.
- locked
Until String - manager
Ad StringId The ID of the user's manager in Active Directory.
- manager
User StringId The OneLogin User ID for the user's manager.
- member
Of String The user's directory membership.
- password String
The password to set for a user.
- password
Algorithm 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
- password
Changed StringAt - password
Confirmation String Required if the password is being set.
- phone String
The E.164 format phone number for a user.
- preferred
Locale StringCode - role
Ids 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.
- trusted
Idp IntegerId The ID of the OneLogin Trusted IDP of the user.
- updated
At String - username String
A username for the user.
- userprincipalname String
The principle name of the user.
- activated
At string - comment string
Free text related to the user.
- company string
The user's company.
- created
At string - department string
The user's department.
- directory
Id number The ID of the OneLogin Directory of the user.
- distinguished
Name string The distinguished name of the user.
- email string
A valid email for the user.
- external
Id string The ID of the user in an external directory.
- firstname string
The user's first name.
- group
Id number The ID of the Group in OneLogin that the user is assigned to.
- invalid
Login numberAttempts - invitation
Sent stringAt - last
Login string - lastname string
The user's last name.
- locked
Until string - manager
Ad stringId The ID of the user's manager in Active Directory.
- manager
User stringId The OneLogin User ID for the user's manager.
- member
Of string The user's directory membership.
- password string
The password to set for a user.
- password
Algorithm 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
- password
Changed stringAt - password
Confirmation string Required if the password is being set.
- phone string
The E.164 format phone number for a user.
- preferred
Locale stringCode - role
Ids 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.
- trusted
Idp numberId The ID of the OneLogin Trusted IDP of the user.
- updated
At 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_ intattempts - invitation_
sent_ strat - last_
login str - lastname str
The user's last name.
- locked_
until str - manager_
ad_ strid The ID of the user's manager in Active Directory.
- manager_
user_ strid 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_ strat - password_
confirmation str Required if the password is being set.
- phone str
The E.164 format phone number for a user.
- preferred_
locale_ strcode - 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_ intid 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.
- activated
At String - comment String
Free text related to the user.
- company String
The user's company.
- created
At String - department String
The user's department.
- directory
Id Number The ID of the OneLogin Directory of the user.
- distinguished
Name String The distinguished name of the user.
- email String
A valid email for the user.
- external
Id String The ID of the user in an external directory.
- firstname String
The user's first name.
- group
Id Number The ID of the Group in OneLogin that the user is assigned to.
- invalid
Login NumberAttempts - invitation
Sent StringAt - last
Login String - lastname String
The user's last name.
- locked
Until String - manager
Ad StringId The ID of the user's manager in Active Directory.
- manager
User StringId The OneLogin User ID for the user's manager.
- member
Of String The user's directory membership.
- password String
The password to set for a user.
- password
Algorithm 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
- password
Changed StringAt - password
Confirmation String Required if the password is being set.
- phone String
The E.164 format phone number for a user.
- preferred
Locale StringCode - role
Ids 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.
- trusted
Idp NumberId The ID of the OneLogin Trusted IDP of the user.
- updated
At 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.
- Activated
At string - Comment string
Free text related to the user.
- Company string
The user's company.
- Created
At string - Department string
The user's department.
- Directory
Id int The ID of the OneLogin Directory of the user.
- Distinguished
Name string The distinguished name of the user.
- Email string
A valid email for the user.
- External
Id string The ID of the user in an external directory.
- Firstname string
The user's first name.
- Group
Id int The ID of the Group in OneLogin that the user is assigned to.
- Invalid
Login intAttempts - Invitation
Sent stringAt - Last
Login string - Lastname string
The user's last name.
- Locked
Until string - Manager
Ad stringId The ID of the user's manager in Active Directory.
- Manager
User stringId The OneLogin User ID for the user's manager.
- Member
Of string The user's directory membership.
- Password string
The password to set for a user.
- Password
Algorithm 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
- Password
Changed stringAt - Password
Confirmation string Required if the password is being set.
- Phone string
The E.164 format phone number for a user.
- Preferred
Locale stringCode - Role
Ids 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.
- Trusted
Idp intId The ID of the OneLogin Trusted IDP of the user.
- Updated
At string - Username string
A username for the user.
- Userprincipalname string
The principle name of the user.
- Activated
At string - Comment string
Free text related to the user.
- Company string
The user's company.
- Created
At string - Department string
The user's department.
- Directory
Id int The ID of the OneLogin Directory of the user.
- Distinguished
Name string The distinguished name of the user.
- Email string
A valid email for the user.
- External
Id string The ID of the user in an external directory.
- Firstname string
The user's first name.
- Group
Id int The ID of the Group in OneLogin that the user is assigned to.
- Invalid
Login intAttempts - Invitation
Sent stringAt - Last
Login string - Lastname string
The user's last name.
- Locked
Until string - Manager
Ad stringId The ID of the user's manager in Active Directory.
- Manager
User stringId The OneLogin User ID for the user's manager.
- Member
Of string The user's directory membership.
- Password string
The password to set for a user.
- Password
Algorithm 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
- Password
Changed stringAt - Password
Confirmation string Required if the password is being set.
- Phone string
The E.164 format phone number for a user.
- Preferred
Locale stringCode - Role
Ids []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.
- Trusted
Idp intId The ID of the OneLogin Trusted IDP of the user.
- Updated
At string - Username string
A username for the user.
- Userprincipalname string
The principle name of the user.
- activated
At String - comment String
Free text related to the user.
- company String
The user's company.
- created
At String - department String
The user's department.
- directory
Id Integer The ID of the OneLogin Directory of the user.
- distinguished
Name String The distinguished name of the user.
- email String
A valid email for the user.
- external
Id String The ID of the user in an external directory.
- firstname String
The user's first name.
- group
Id Integer The ID of the Group in OneLogin that the user is assigned to.
- invalid
Login IntegerAttempts - invitation
Sent StringAt - last
Login String - lastname String
The user's last name.
- locked
Until String - manager
Ad StringId The ID of the user's manager in Active Directory.
- manager
User StringId The OneLogin User ID for the user's manager.
- member
Of String The user's directory membership.
- password String
The password to set for a user.
- password
Algorithm 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
- password
Changed StringAt - password
Confirmation String Required if the password is being set.
- phone String
The E.164 format phone number for a user.
- preferred
Locale StringCode - role
Ids 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.
- trusted
Idp IntegerId The ID of the OneLogin Trusted IDP of the user.
- updated
At String - username String
A username for the user.
- userprincipalname String
The principle name of the user.
- activated
At string - comment string
Free text related to the user.
- company string
The user's company.
- created
At string - department string
The user's department.
- directory
Id number The ID of the OneLogin Directory of the user.
- distinguished
Name string The distinguished name of the user.
- email string
A valid email for the user.
- external
Id string The ID of the user in an external directory.
- firstname string
The user's first name.
- group
Id number The ID of the Group in OneLogin that the user is assigned to.
- invalid
Login numberAttempts - invitation
Sent stringAt - last
Login string - lastname string
The user's last name.
- locked
Until string - manager
Ad stringId The ID of the user's manager in Active Directory.
- manager
User stringId The OneLogin User ID for the user's manager.
- member
Of string The user's directory membership.
- password string
The password to set for a user.
- password
Algorithm 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
- password
Changed stringAt - password
Confirmation string Required if the password is being set.
- phone string
The E.164 format phone number for a user.
- preferred
Locale stringCode - role
Ids 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.
- trusted
Idp numberId The ID of the OneLogin Trusted IDP of the user.
- updated
At 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_ intattempts - invitation_
sent_ strat - last_
login str - lastname str
The user's last name.
- locked_
until str - manager_
ad_ strid The ID of the user's manager in Active Directory.
- manager_
user_ strid 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_ strat - password_
confirmation str Required if the password is being set.
- phone str
The E.164 format phone number for a user.
- preferred_
locale_ strcode - 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_ intid 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.
- activated
At String - comment String
Free text related to the user.
- company String
The user's company.
- created
At String - department String
The user's department.
- directory
Id Number The ID of the OneLogin Directory of the user.
- distinguished
Name String The distinguished name of the user.
- email String
A valid email for the user.
- external
Id String The ID of the user in an external directory.
- firstname String
The user's first name.
- group
Id Number The ID of the Group in OneLogin that the user is assigned to.
- invalid
Login NumberAttempts - invitation
Sent StringAt - last
Login String - lastname String
The user's last name.
- locked
Until String - manager
Ad StringId The ID of the user's manager in Active Directory.
- manager
User StringId The OneLogin User ID for the user's manager.
- member
Of String The user's directory membership.
- password String
The password to set for a user.
- password
Algorithm 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
- password
Changed StringAt - password
Confirmation String Required if the password is being set.
- phone String
The E.164 format phone number for a user.
- preferred
Locale StringCode - role
Ids 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.
- trusted
Idp NumberId The ID of the OneLogin Trusted IDP of the user.
- updated
At 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.