Class: Artifactory::Resource::User
- Defined in:
- lib/artifactory/resources/user.rb
Class Method Summary collapse
-
.all(options = {}) ⇒ Array<Resource::User>
Get a list of all users in the system.
-
.find(name, options = {}) ⇒ Resource::User?
Find (fetch) a user by its name.
Instance Method Summary collapse
-
#admin ⇒ Object
Return this object’s
admin
. -
#admin=(value) ⇒ Object
Set this object’s
admin
. -
#admin? ⇒ Boolean
Determines if the
admin
value exists and is truthy. -
#delete ⇒ Boolean
Delete this user from artifactory, suppressing any
ResourceNotFound
exceptions might occur. -
#email ⇒ Object
Return this object’s
email
. -
#email=(value) ⇒ Object
Set this object’s
email
. -
#email? ⇒ Boolean
Determines if the
email
value exists and is truthy. -
#groups ⇒ Object
Return this object’s
groups
. -
#groups=(value) ⇒ Object
Set this object’s
groups
. -
#groups? ⇒ Boolean
Determines if the
groups
value exists and is truthy. -
#internal_password_disabled ⇒ Object
Return this object’s
internal_password_disabled
. -
#internal_password_disabled=(value) ⇒ Object
Set this object’s
internal_password_disabled
. -
#internal_password_disabled? ⇒ Boolean
Determines if the
internal_password_disabled
value exists and is truthy. -
#last_logged_in ⇒ Object
Return this object’s
last_logged_in
. -
#last_logged_in=(value) ⇒ Object
Set this object’s
last_logged_in
. -
#last_logged_in? ⇒ Boolean
Determines if the
last_logged_in
value exists and is truthy. -
#name ⇒ Object
Return this object’s
name
. -
#name=(value) ⇒ Object
Set this object’s
name
. -
#name? ⇒ Boolean
Determines if the
name
value exists and is truthy. -
#password ⇒ Object
Return this object’s
password
. -
#password=(value) ⇒ Object
Set this object’s
password
. -
#password? ⇒ Boolean
Determines if the
password
value exists and is truthy. -
#profile_updatable ⇒ Object
Return this object’s
profile_updatable
. -
#profile_updatable=(value) ⇒ Object
Set this object’s
profile_updatable
. -
#profile_updatable? ⇒ Boolean
Determines if the
profile_updatable
value exists and is truthy. -
#realm ⇒ Object
Return this object’s
realm
. -
#realm=(value) ⇒ Object
Set this object’s
realm
. -
#realm? ⇒ Boolean
Determines if the
realm
value exists and is truthy. -
#save ⇒ Boolean
Save the user to the artifactory server.
Methods inherited from Base
attribute, attributes, #attributes, #client, #client=, #client?, #extract_client!, extract_client!, find_from_config, #format_repos!, format_repos!, from_hash, from_url, has_attribute?, #initialize, #inspect, list_from_config, #set, #to_hash, #to_json, #to_matrix_properties, #to_s, url_safe, #url_safe
Constructor Details
This class inherits a constructor from Artifactory::Resource::Base
Class Method Details
.all(options = {}) ⇒ Array<Resource::User>
Get a list of all users in the system.
16 17 18 19 20 21 |
# File 'lib/artifactory/resources/user.rb', line 16 def all( = {}) client = extract_client!() client.get('/api/security/users').map do |hash| from_url(hash['uri'], client: client) end end |
.find(name, options = {}) ⇒ Resource::User?
Find (fetch) a user by its name.
41 42 43 44 45 46 47 48 49 |
# File 'lib/artifactory/resources/user.rb', line 41 def find(name, = {}) client = extract_client!() response = client.get("/api/security/users/#{url_safe(name)}") from_hash(response, client: client) rescue Error::HTTPError => e raise unless e.code == 404 nil end |
Instance Method Details
#admin ⇒ Object
Return this object’s admin
52 |
# File 'lib/artifactory/resources/user.rb', line 52 attribute :admin, false |
#admin=(value) ⇒ Object
Set this object’s admin
52 |
# File 'lib/artifactory/resources/user.rb', line 52 attribute :admin, false |
#admin? ⇒ Boolean
Determines if the admin
value exists and is truthy
52 |
# File 'lib/artifactory/resources/user.rb', line 52 attribute :admin, false |
#delete ⇒ Boolean
Delete this user from artifactory, suppressing any ResourceNotFound
exceptions might occur.
69 70 71 72 73 74 |
# File 'lib/artifactory/resources/user.rb', line 69 def delete client.delete(api_path) true rescue Error::HTTPError => e false end |
#email ⇒ Object
Return this object’s email
53 |
# File 'lib/artifactory/resources/user.rb', line 53 attribute :email |
#email=(value) ⇒ Object
Set this object’s email
53 |
# File 'lib/artifactory/resources/user.rb', line 53 attribute :email |
#email? ⇒ Boolean
Determines if the email
value exists and is truthy
53 |
# File 'lib/artifactory/resources/user.rb', line 53 attribute :email |
#groups ⇒ Object
Return this object’s groups
54 |
# File 'lib/artifactory/resources/user.rb', line 54 attribute :groups, [] |
#groups=(value) ⇒ Object
Set this object’s groups
54 |
# File 'lib/artifactory/resources/user.rb', line 54 attribute :groups, [] |
#groups? ⇒ Boolean
Determines if the groups
value exists and is truthy
54 |
# File 'lib/artifactory/resources/user.rb', line 54 attribute :groups, [] |
#internal_password_disabled ⇒ Object
Return this object’s internal_password_disabled
55 |
# File 'lib/artifactory/resources/user.rb', line 55 attribute :internal_password_disabled, false |
#internal_password_disabled=(value) ⇒ Object
Set this object’s internal_password_disabled
55 |
# File 'lib/artifactory/resources/user.rb', line 55 attribute :internal_password_disabled, false |
#internal_password_disabled? ⇒ Boolean
Determines if the internal_password_disabled
value exists and is truthy
55 |
# File 'lib/artifactory/resources/user.rb', line 55 attribute :internal_password_disabled, false |
#last_logged_in ⇒ Object
Return this object’s last_logged_in
56 |
# File 'lib/artifactory/resources/user.rb', line 56 attribute :last_logged_in |
#last_logged_in=(value) ⇒ Object
Set this object’s last_logged_in
56 |
# File 'lib/artifactory/resources/user.rb', line 56 attribute :last_logged_in |
#last_logged_in? ⇒ Boolean
Determines if the last_logged_in
value exists and is truthy
56 |
# File 'lib/artifactory/resources/user.rb', line 56 attribute :last_logged_in |
#name ⇒ Object
Return this object’s name
57 |
# File 'lib/artifactory/resources/user.rb', line 57 attribute :name, -> { raise 'Name missing' } |
#name=(value) ⇒ Object
Set this object’s name
57 |
# File 'lib/artifactory/resources/user.rb', line 57 attribute :name, -> { raise 'Name missing' } |
#name? ⇒ Boolean
Determines if the name
value exists and is truthy
57 |
# File 'lib/artifactory/resources/user.rb', line 57 attribute :name, -> { raise 'Name missing' } |
#password ⇒ Object
Return this object’s password
58 |
# File 'lib/artifactory/resources/user.rb', line 58 attribute :password |
#password=(value) ⇒ Object
Set this object’s password
58 |
# File 'lib/artifactory/resources/user.rb', line 58 attribute :password |
#password? ⇒ Boolean
Determines if the password
value exists and is truthy
58 |
# File 'lib/artifactory/resources/user.rb', line 58 attribute :password |
#profile_updatable ⇒ Object
Return this object’s profile_updatable
59 |
# File 'lib/artifactory/resources/user.rb', line 59 attribute :profile_updatable, true |
#profile_updatable=(value) ⇒ Object
Set this object’s profile_updatable
59 |
# File 'lib/artifactory/resources/user.rb', line 59 attribute :profile_updatable, true |
#profile_updatable? ⇒ Boolean
Determines if the profile_updatable
value exists and is truthy
59 |
# File 'lib/artifactory/resources/user.rb', line 59 attribute :profile_updatable, true |
#realm ⇒ Object
Return this object’s realm
60 |
# File 'lib/artifactory/resources/user.rb', line 60 attribute :realm |
#realm=(value) ⇒ Object
Set this object’s realm
60 |
# File 'lib/artifactory/resources/user.rb', line 60 attribute :realm |
#realm? ⇒ Boolean
Determines if the realm
value exists and is truthy
60 |
# File 'lib/artifactory/resources/user.rb', line 60 attribute :realm |
#save ⇒ Boolean
Save the user to the artifactory server.
81 82 83 84 |
# File 'lib/artifactory/resources/user.rb', line 81 def save client.put(api_path, to_json, headers) true end |