Class: Ansible::Ruby::Modules::Cyberark_user

Inherits:
Base show all
Defined in:
lib/ansible/ruby/modules/generated/identity/cyberark/cyberark_user.rb

Overview

CyberArk User Management using PAS Web Services SDK. It currently supports the following actions Get User Details, Add User, Update User, Delete User.

Instance Method Summary collapse

Methods inherited from Base

#ansible_name, #to_h

Methods inherited from Ansible::Ruby::Models::Base

attr_option, attr_options, attribute, fix_inclusion, #initialize, remove_existing_validations, #to_h, validates

Constructor Details

This class inherits a constructor from Ansible::Ruby::Models::Base

Instance Method Details

#change_password_on_the_next_logon ⇒ :yes, ...

Returns Whether or not the user must change their password in their next logon. Valid values = true/false.

Returns:

  • (:yes, :no, nil) —

    Whether or not the user must change their password in their next logon. Valid values = true/false.



41
 
# File 'lib/ansible/ruby/modules/generated/identity/cyberark/cyberark_user.rb', line 41

attribute :change_password_on_the_next_logon

#cyberark_session ⇒ String

Returns Dictionary set by a CyberArk authentication containing the different values to perform actions on a logged-on CyberArk session, please see M(cyberark_authentication) module for an example of cyberark_session.

Returns:

  • (String) —

    Dictionary set by a CyberArk authentication containing the different values to perform actions on a logged-on CyberArk session, please see M(cyberark_authentication) module for an example of cyberark_session.



20
 
# File 'lib/ansible/ruby/modules/generated/identity/cyberark/cyberark_user.rb', line 20

attribute :cyberark_session

#disabled ⇒ :yes, ...

Returns Whether or not the user will be disabled. Valid values = true/false.

Returns:

  • (:yes, :no, nil) —

    Whether or not the user will be disabled. Valid values = true/false.



52
 
# File 'lib/ansible/ruby/modules/generated/identity/cyberark/cyberark_user.rb', line 52

attribute :disabled

#email ⇒ Object?

Returns The user email address.

Returns:

  • (Object, nil) —

    The user email address.



32
 
# File 'lib/ansible/ruby/modules/generated/identity/cyberark/cyberark_user.rb', line 32

attribute :email

#expiry_date ⇒ Object?

Returns The date and time when the user account will expire and become disabled.

Returns:

  • (Object, nil) —

    The date and time when the user account will expire and become disabled.



45
 
# File 'lib/ansible/ruby/modules/generated/identity/cyberark/cyberark_user.rb', line 45

attribute :expiry_date

#first_name ⇒ Object?

Returns The user first name.

Returns:

  • (Object, nil) —

    The user first name.



35
 
# File 'lib/ansible/ruby/modules/generated/identity/cyberark/cyberark_user.rb', line 35

attribute :first_name

#group_name ⇒ String?

Returns The name of the group the user will be added to.

Returns:

  • (String, nil) —

    The name of the group the user will be added to.



59
 
# File 'lib/ansible/ruby/modules/generated/identity/cyberark/cyberark_user.rb', line 59

attribute :group_name

#initial_password ⇒ String?

Returns The password that the new user will use to log on the first time. This password must meet the password policy requirements. this parameter is required when state is present – Add User.

Returns:

  • (String, nil) —

    The password that the new user will use to log on the first time. This password must meet the password policy requirements. this parameter is required when state is present – Add User.



24
 
# File 'lib/ansible/ruby/modules/generated/identity/cyberark/cyberark_user.rb', line 24

attribute :initial_password

#last_name ⇒ Object?

Returns The user last name.

Returns:

  • (Object, nil) —

    The user last name.



38
 
# File 'lib/ansible/ruby/modules/generated/identity/cyberark/cyberark_user.rb', line 38

attribute :last_name

#location ⇒ Object?

Returns The Vault Location for the user.

Returns:

  • (Object, nil) —

    The Vault Location for the user.



56
 
# File 'lib/ansible/ruby/modules/generated/identity/cyberark/cyberark_user.rb', line 56

attribute :location

#new_password ⇒ String?

Returns The user updated password. Make sure that this password meets the password policy requirements.

Returns:

  • (String, nil) —

    The user updated password. Make sure that this password meets the password policy requirements.



28
 
# File 'lib/ansible/ruby/modules/generated/identity/cyberark/cyberark_user.rb', line 28

attribute :new_password

#state ⇒ :present, ...

Returns Specifies the state needed for the user present for create user, absent for delete user.

Returns:

  • (:present, :absent, nil) —

    Specifies the state needed for the user present for create user, absent for delete user.



16
 
# File 'lib/ansible/ruby/modules/generated/identity/cyberark/cyberark_user.rb', line 16

attribute :state

#user_type_name ⇒ String?

Returns The type of user.

Returns:

  • (String, nil) —

    The type of user.



48
 
# File 'lib/ansible/ruby/modules/generated/identity/cyberark/cyberark_user.rb', line 48

attribute :user_type_name

#username ⇒ String

Returns The name of the user who will be queried (for details), added, updated or deleted.

Returns:

  • (String) —

    The name of the user who will be queried (for details), added, updated or deleted.



12
 
# File 'lib/ansible/ruby/modules/generated/identity/cyberark/cyberark_user.rb', line 12

attribute :username