gitlab-customer-support-operations_gitlab 1.0.0

data/lib/support_ops_gitlab/gitlab/users.rb

@@ -0,0 +1,1059 @@
+# frozen_string_literal: true
+
+# Defines the module SupportOps.
+module SupportOps
+  # Defines the module GitLab
+  module GitLab
+    ##
+    # Defines the class Users within the module {SupportOps::GitLab}.
+    #
+    # @author Jason Colyer
+    # @since 1.0.0
+    # @attr [String] avatar_url URL of the user's avatar
+    # @attr [String] bio User’s biography
+    # @attr [Boolean] can_create_group User can create groups
+    # @attr [Boolean] can_create_project User can create projects
+    # @attr [Integer] color_scheme_id User’s color scheme for the file viewer
+    # @attr [String] commit_email User’s commit email
+    # @attr [String] confirmed_at Timestamp the user's account was confirmed at
+    # @attr [String] created_at Timestamp the user's account was created at
+    # @attr [Interger] created_by The ID of whomever created the user
+    # @attr [String] current_sign_in_at Timestamp the user's most current login
+    # @attr [String] current_sign_in_ip IP address used for most current login
+    # @attr [String] discord Discord account
+    # @attr [String] email User's email
+    # @attr [String] email_reset_offered_at Timestamp the user's got a reset email sent
+    # @attr [Boolean] external Flags the user as external 
+    # @attr [Integer] extra_shared_runners_minutes_limit Additional compute minutes for this user
+    # @attr [Integer] followers Count of accounts following the user
+    # @attr [Integer] following Count of accoutns the user is following
+    # @attr [Boolean] force_random_password Set user password to a random value
+    # @attr [String] github GitHub username
+    # @attr [Integer] group_saml Group ID the user is tied to SAML by
+    # @attr [Integer] id User's ID
+    # @attr [Array] identities User's external identities
+    # @attr [Boolean] is_admin If the user is an admin or not
+    # @attr [Boolean] is_auditor If the user is an auditor or not
+    # @attr [String] job_title User's job title
+    # @attr [String] last_activity_on Timestamp of last actity for the user
+    # @attr [String] last_sign_in_at Timestamp fo the user's last login
+    # @attr [String] last_sign_in_ip IP of the user's last login
+    # @attr [String] linkedin LinkedIn
+    # @attr [String] local_time Human readable format of user's local time
+    # @attr [String] location User’s location
+    # @attr [Boolean] locked If the user is locked or not
+    # @attr [String] name Name
+    # @attr [Integer] namespace_id User's namespace ID
+    # @attr [String] note Administrator notes for this user
+    # @attr [String] organization Organization name
+    # @attr [String] password Password
+    # @attr [String] plan Subscription type for the user's account
+    # @attr [Boolean] private_profile User’s profile is private
+    # @attr [Integer] projects_limit Number of projects user can create
+    # @attr [String] pronouns User’s pronouns
+    # @attr [Integer] provisioned_by_group_id The group ID that provisioned the user
+    # @attr [String] public_email User’s public email address
+    # @attr [Boolean] reset_password Send user password reset link
+    # @attr [Array] scim_identities User's SCIM identities
+    # @attr [Integer] shared_runners_minutes_limit Maximum number of monthly compute minutes for this user.
+    # @attr [Integer] sign_in_count Number of times user has signed in
+    # @attr [String] skype Skype ID
+    # @attr [String] state User's account state
+    # @attr [Integer] theme_id GitLab theme for the user
+    # @attr [Boolean] trial If the user is using a trial or not
+    # @attr [String] twitter X (formerly Twitter) account
+    # @attr [Boolean] two_factor_enabled If the user has 2FA activated on the account
+    # @attr [String] username Username
+    # @attr [String] website_url Website URL
+    # @attr [String] web_url Link to the user's profile
+    # @attr [String] work_information
+    # @todo Upload an avatar for yourself > https://docs.gitlab.com/api/users/#upload-an-avatar-for-yourself
+    # @todo Get a count of your assigned issues, merge requests, and reviews > https://docs.gitlab.com/api/users/#get-a-count-of-your-assigned-issues-merge-requests-and-reviews
+    # @todo Get a count of a user’s projects, groups, issues, and merge requests > https://docs.gitlab.com/api/users/#get-a-count-of-a-users-projects-groups-issues-and-merge-requests
+    # @todo List a user's activity > https://docs.gitlab.com/api/users/#list-a-users-activity
+    # @todo Create a runner linked to a user > https://docs.gitlab.com/api/users/#create-a-runner-linked-to-a-user
+    # @todo Delete authentication identity from a user > https://docs.gitlab.com/api/users/#delete-authentication-identity-from-a-user
+    # @todo Follow a user > https://docs.gitlab.com/api/user_follow_unfollow/#follow-a-user
+    # @todo Unfollow a user > https://docs.gitlab.com/api/user_follow_unfollow/#unfollow-a-user
+    # @todo List all accounts that follow a user > https://docs.gitlab.com/api/user_follow_unfollow/#list-all-accounts-that-follow-a-user
+    # @todo List all accounts followed by a user > https://docs.gitlab.com/api/user_follow_unfollow/#list-all-accounts-followed-by-a-user
+    # @todo Get the status of a user > https://docs.gitlab.com/api/users/#get-the-status-of-a-user
+    # @todo Set your user status > https://docs.gitlab.com/api/users/#set-your-user-status
+    # @todo Get your user preferences > https://docs.gitlab.com/api/users/#get-your-user-preferences
+    # @todo Update your user preferences > https://docs.gitlab.com/api/users/#update-your-user-preferences
+    # @todo Have disable_2fa! update User object to reflect the change
+    # @todo Have deactivate! update User object to reflect the change
+    # @todo Have activate! update User object to reflect the change
+    # @todo Have ban! update User object to reflect the change
+    # @todo Have unban! update User object to reflect the change
+    # @todo Have block! update User object to reflect the change
+    # @todo Have unblock! update User object to reflect the change
+    # @todo Document projects
+    class Users < SupportOps::GitLab::Base
+      # @!parse
+      #   # Creates/updates a user
+      #   # 
+      #   # @author Jason Colyer
+      #   # @since 1.0.0
+      #   # @return [Object] Instance of {SupportOps::GitLab::Users}
+      #   # @note This is inherited from {SupportOps::GitLab::Base#save!}
+      #   # @see
+      #   #   https://docs.gitlab.com/api/users/#create-a-user
+      #   #   GitLab API > Users > Create a User
+      #   # @see
+      #   #   https://docs.gitlab.com/api/users/#modify-a-user
+      #   #   GitLab API > Users > Modify a User
+      #   # @example
+      #   #   require 'support_ops_gitlab'
+      #   #
+      #   #   SupportOps::GitLab::Configuration.configure do |config|
+      #   #     config.token = ENV.fetch('GL_TOKEN')
+      #   #     config.url = 'https://gitlab.com/api/v4'
+      #   #   end
+      #   #
+      #   #   new_user = SupportOps::GitLab::Users.new
+      #   #   new_user.email = 'roge@example.org'
+      #   #   new_user.name = 'Roger Wilco'
+      #   #
+      #   #   new_user.save!
+      #   #
+      #   #   pp new_user.id
+      #   #   # => 9873843
+      #   # @example
+      #   #   require 'support_ops_gitlab'
+      #   #
+      #   #   SupportOps::GitLab::Configuration.configure do |config|
+      #   #     config.token = ENV.fetch('GL_TOKEN')
+      #   #     config.url = 'https://gitlab.com/api/v4'
+      #   #   end
+      #   #
+      #   #   existing_user = SupportOps::GitLab::Users.get!(9873843)
+      #   #   existing_user.name = 'Roger Wilco II'
+      #   #
+      #   #   existing_user.save!
+      #   #
+      #   #   pp existing_user.name
+      #   #   # => "Roger Wilco II"
+      #   def save!; end
+      # @!parse
+      #   # Deletes a user
+      #   # 
+      #   # @author Jason Colyer
+      #   # @since 1.0.0
+      #   # @return [Boolean]
+      #   # @note This is inherited from {SupportOps::GitLab::Base#delete!}
+      #   # @see
+      #   #   https://docs.gitlab.com/api/users/#delete-a-user
+      #   #   GitLab API > Users > Delete a User
+      #   # @example
+      #   #   require 'support_ops_gitlab'
+      #   #
+      #   #   SupportOps::GitLab::Configuration.configure do |config|
+      #   #     config.token = ENV.fetch('GL_TOKEN')
+      #   #     config.url = 'https://gitlab.com/api/v4'
+      #   #   end
+      #   #
+      #   #   existing_user = SupportOps::GitLab::Users.get!(9873843)
+      #   #   existing_user.delete!
+      #   def delete!; end
+      # @!parse
+      #   # Hard deletes a user
+      #   # 
+      #   # @author Jason Colyer
+      #   # @since 1.0.0
+      #   # @return [Boolean]
+      #   # @note This is inherited from {SupportOps::GitLab::Base#hard_delete!}
+      #   # @see
+      #   #   https://docs.gitlab.com/api/users/#delete-a-user
+      #   #   GitLab API > Users > Delete a User
+      #   # @example
+      #   #   require 'support_ops_gitlab'
+      #   #
+      #   #   SupportOps::GitLab::Configuration.configure do |config|
+      #   #     config.token = ENV.fetch('GL_TOKEN')
+      #   #     config.url = 'https://gitlab.com/api/v4'
+      #   #   end
+      #   #
+      #   #   existing_user = SupportOps::GitLab::Users.get!(9873843)
+      #   #   existing_user.hard_delete!
+      #   def hard_delete!; end
+      # @!parse
+      #   # Blocks a user
+      #   # 
+      #   # @author Jason Colyer
+      #   # @since 1.0.0
+      #   # @return [Boolean]
+      #   # @note This is inherited from {SupportOps::GitLab::Base#block!}
+      #   # @see
+      #   #   https://docs.gitlab.com/api/user_moderation/#block-access-to-a-user
+      #   #   GitLab API > User Moderation > Block access to a user
+      #   # @example
+      #   #   require 'support_ops_gitlab'
+      #   #
+      #   #   SupportOps::GitLab::Configuration.configure do |config|
+      #   #     config.token = ENV.fetch('GL_TOKEN')
+      #   #     config.url = 'https://gitlab.com/api/v4'
+      #   #   end
+      #   #
+      #   #   existing_user = SupportOps::GitLab::Users.get!(9873843)
+      #   #   existing_user.block!
+      #   def block!; end
+      # @!parse
+      #   # Unblocks a user
+      #   # 
+      #   # @author Jason Colyer
+      #   # @since 1.0.0
+      #   # @return [Boolean]
+      #   # @note This is inherited from {SupportOps::GitLab::Base#unblock!}
+      #   # @see
+      #   #   https://docs.gitlab.com/api/user_moderation/#unblock-access-to-a-user
+      #   #   GitLab API > User Moderation > Unblock access to a user
+      #   # @example
+      #   #   require 'support_ops_gitlab'
+      #   #
+      #   #   SupportOps::GitLab::Configuration.configure do |config|
+      #   #     config.token = ENV.fetch('GL_TOKEN')
+      #   #     config.url = 'https://gitlab.com/api/v4'
+      #   #   end
+      #   #
+      #   #   existing_user = SupportOps::GitLab::Users.get!(9873843)
+      #   #   existing_user.unblock!
+      #   def unblock!; end
+      # @!parse
+      #   # Bans a user
+      #   # 
+      #   # @author Jason Colyer
+      #   # @since 1.0.0
+      #   # @return [Boolean]
+      #   # @note This is inherited from {SupportOps::GitLab::Base#ban!}
+      #   # @see
+      #   #   https://docs.gitlab.com/api/user_moderation/#ban-a-user
+      #   #   GitLab API > User Moderation > Ban a user
+      #   # @example
+      #   #   require 'support_ops_gitlab'
+      #   #
+      #   #   SupportOps::GitLab::Configuration.configure do |config|
+      #   #     config.token = ENV.fetch('GL_TOKEN')
+      #   #     config.url = 'https://gitlab.com/api/v4'
+      #   #   end
+      #   #
+      #   #   existing_user = SupportOps::GitLab::Users.get!(9873843)
+      #   #   existing_user.ban!
+      #   def ban!; end
+      # @!parse
+      #   # Unbans a user
+      #   # 
+      #   # @author Jason Colyer
+      #   # @since 1.0.0
+      #   # @return [Boolean]
+      #   # @note This is inherited from {SupportOps::GitLab::Base#unban!}
+      #   # @see
+      #   #   https://docs.gitlab.com/api/user_moderation/#unban-a-user
+      #   #   GitLab API > User Moderation > Unban a user
+      #   # @example
+      #   #   require 'support_ops_gitlab'
+      #   #
+      #   #   SupportOps::GitLab::Configuration.configure do |config|
+      #   #     config.token = ENV.fetch('GL_TOKEN')
+      #   #     config.url = 'https://gitlab.com/api/v4'
+      #   #   end
+      #   #
+      #   #   existing_user = SupportOps::GitLab::Users.get!(9873843)
+      #   #   existing_user.unban!
+      #   def unban!; end
+      # @!parse
+      #   # Deactivates a user
+      #   # 
+      #   # @author Jason Colyer
+      #   # @since 1.0.0
+      #   # @return [Boolean]
+      #   # @note This is inherited from {SupportOps::GitLab::Base#deactivate!}
+      #   # @see
+      #   #   https://docs.gitlab.com/api/user_moderation/#deactivate-a-user
+      #   #   GitLab API > User Moderation > Deactivate a user
+      #   # @example
+      #   #   require 'support_ops_gitlab'
+      #   #
+      #   #   SupportOps::GitLab::Configuration.configure do |config|
+      #   #     config.token = ENV.fetch('GL_TOKEN')
+      #   #     config.url = 'https://gitlab.com/api/v4'
+      #   #   end
+      #   #
+      #   #   existing_user = SupportOps::GitLab::Users.get!(9873843)
+      #   #   existing_user.deactivate!
+      #   def deactivate!; end
+      # @!parse
+      #   # Reactivates a user
+      #   # 
+      #   # @author Jason Colyer
+      #   # @since 1.0.0
+      #   # @return [Boolean]
+      #   # @note This is inherited from {SupportOps::GitLab::Base#activate!}
+      #   # @see
+      #   #   https://docs.gitlab.com/api/user_moderation/#reactivate-a-user
+      #   #   GitLab API > User Moderation > Reactivate a user
+      #   # @example
+      #   #   require 'support_ops_gitlab'
+      #   #
+      #   #   SupportOps::GitLab::Configuration.configure do |config|
+      #   #     config.token = ENV.fetch('GL_TOKEN')
+      #   #     config.url = 'https://gitlab.com/api/v4'
+      #   #   end
+      #   #
+      #   #   existing_user = SupportOps::GitLab::Users.get!(9873843)
+      #   #   existing_user.activate!
+      #   def activate!; end
+      # @!parse
+      #   # Approves access to a user
+      #   # 
+      #   # @author Jason Colyer
+      #   # @since 1.0.0
+      #   # @return [Boolean]
+      #   # @note This is inherited from {SupportOps::GitLab::Base#approve!}
+      #   # @see
+      #   #   https://docs.gitlab.com/api/user_moderation/#approve-access-to-a-user
+      #   #   GitLab API > User Moderation > Approve access to a user
+      #   # @example
+      #   #   require 'support_ops_gitlab'
+      #   #
+      #   #   SupportOps::GitLab::Configuration.configure do |config|
+      #   #     config.token = ENV.fetch('GL_TOKEN')
+      #   #     config.url = 'https://gitlab.com/api/v4'
+      #   #   end
+      #   #
+      #   #   existing_user = SupportOps::GitLab::Users.get!(9873843)
+      #   #   existing_user.approve!
+      #   def approve!; end
+      # @!parse
+      #   # Rejects access to a user
+      #   # 
+      #   # @author Jason Colyer
+      #   # @since 1.0.0
+      #   # @return [Boolean]
+      #   # @note This is inherited from {SupportOps::GitLab::Base#reject!}
+      #   # @see
+      #   #   https://docs.gitlab.com/api/user_moderation/#reject-access-to-a-user
+      #   #   GitLab API > User Moderation > Reject access to a user
+      #   # @example
+      #   #   require 'support_ops_gitlab'
+      #   #
+      #   #   SupportOps::GitLab::Configuration.configure do |config|
+      #   #     config.token = ENV.fetch('GL_TOKEN')
+      #   #     config.url = 'https://gitlab.com/api/v4'
+      #   #   end
+      #   #
+      #   #   existing_user = SupportOps::GitLab::Users.get!(9873843)
+      #   #   existing_user.reject!
+      #   def reject!; end
+      # @!parse
+      #   # Disables 2FA for a user
+      #   # 
+      #   # @author Jason Colyer
+      #   # @since 1.0.0
+      #   # @return [Boolean]
+      #   # @note This is inherited from {SupportOps::GitLab::Base#disable_2fa!}
+      #   # @see
+      #   #   https://docs.gitlab.com/api/users/#disable-two-factor-authentication-for-a-user
+      #   #   GitLab API > Users > Disable two factor authentication for a user
+      #   # @example
+      #   #   require 'support_ops_gitlab'
+      #   #
+      #   #   SupportOps::GitLab::Configuration.configure do |config|
+      #   #     config.token = ENV.fetch('GL_TOKEN')
+      #   #     config.url = 'https://gitlab.com/api/v4'
+      #   #   end
+      #   #
+      #   #   existing_user = SupportOps::GitLab::Users.get!(9873843)
+      #   #   existing_user.disable_2fa!
+      #   def disable_2fa!; end
+      # @!parse
+      #   # Lists email addresses for a user
+      #   # 
+      #   # @author Jason Colyer
+      #   # @since 1.0.0
+      #   # @return [Boolean]
+      #   # @note This is inherited from {SupportOps::GitLab::Base#emails}
+      #   # @see
+      #   #   https://docs.gitlab.com/api/user_email_addresses/#list-all-email-addresses-for-a-user
+      #   #   GitLab API > User Email Addresses > List all email addresses for a user
+      #   # @example
+      #   #   require 'support_ops_gitlab'
+      #   #
+      #   #   SupportOps::GitLab::Configuration.configure do |config|
+      #   #     config.token = ENV.fetch('GL_TOKEN')
+      #   #     config.url = 'https://gitlab.com/api/v4'
+      #   #   end
+      #   #
+      #   #   user = SupportOps::GitLab::Users.get!(123456)
+      #   #   emails = user.emails
+      #   #   pp emails.count
+      #   #   # => 2
+      #   #   pp emails.last.email
+      #   #   # => "email2@example.com"
+      #   def disable_2fa!; end
+      # @!parse
+      #   # Lists SSH keys for a user
+      #   # 
+      #   # @author Jason Colyer
+      #   # @since 1.0.0
+      #   # @return [Boolean]
+      #   # @note This is inherited from {SupportOps::GitLab::Base#ssh_keys}
+      #   # @see
+      #   #   https://docs.gitlab.com/api/user_keys/#list-all-ssh-keys-for-a-user
+      #   #   GitLab API > SSH and GPG Keys > List all SSH keys for a user
+      #   # @see SupportOps::GitLab::Configuration Setting up a client
+      #   # @example
+      #   #   require 'support_ops_gitlab'
+      #   #
+      #   #   SupportOps::GitLab::Configuration.configure do |config|
+      #   #     config.url = 'https://gitlab.example.com/api/v4'
+      #   #     config.token = 'abc123'
+      #   #   end
+      #   #
+      #   #   user = SupportOps::GitLab::Users.get!(123456)
+      #   #   keys = user.ssh_keys
+      #   #   pp keys.count
+      #   #   # => 3
+      #   #   pp keys.last.usage_type
+      #   #   # => "auth"
+      #   def ssh_keys; end
+      # @!parse
+      #   # Lists GPG keys for a user
+      #   # 
+      #   # @author Jason Colyer
+      #   # @since 1.0.0
+      #   # @return [Boolean]
+      #   # @note This is inherited from {SupportOps::GitLab::Base#gpg_keys}
+      #   # @see
+      #   #   https://docs.gitlab.com/api/user_keys/#list-all-gpg-keys-for-a-user
+      #   #   GitLab API > SSH and GPG Keys > List all SSH keys for a user
+      #   # @see SupportOps::GitLab::Configuration Setting up a client
+      #   # @example
+      #   #   require 'support_ops_gitlab'
+      #   #
+      #   #   SupportOps::GitLab::Configuration.configure do |config|
+      #   #     config.url = 'https://gitlab.example.com/api/v4'
+      #   #     config.token = 'abc123'
+      #   #   end
+      #   #
+      #   #   user = SupportOps::GitLab::Users.get!(123456)
+      #   #   keys = user.gpg_keys
+      #   #   pp keys.count
+      #   #   # => 3
+      #   #   pp keys.last.id
+      #   #   # => 789
+      #   def gpg_keys; end
+      # @!parse
+      #   # List projects and groups that a user is a member of
+      #   # 
+      #   # @author Jason Colyer
+      #   # @since 1.0.0
+      #   # @return [Boolean]
+      #   # @note This is inherited from {SupportOps::GitLab::Base#memberships}
+      #   # @see
+      #   #   https://docs.gitlab.com/api/users/#list-projects-and-groups-that-a-user-is-a-member-of
+      #   #   GitLab API > Users > List projects and groups that a user is a member of
+      #   # @see SupportOps::GitLab::Configuration Setting up a client
+      #   # @example
+      #   #   require 'support_ops_gitlab'
+      #   #
+      #   #   SupportOps::GitLab::Configuration.configure do |config|
+      #   #     config.url = 'https://gitlab.example.com/api/v4'
+      #   #     config.token = 'abc123'
+      #   #   end
+      #   #
+      #   #   user = SupportOps::GitLab::Users.get!(123456)
+      #   #   memberships = user.memberships
+      #   #   pp memberships.count
+      #   #   # => 3
+      #   #   pp memberships.last.id
+      #   #   # => 789
+      #   def memberships; end
+      # @!parse
+      #   # List tokens (personal access and impersonation) for a user
+      #   # 
+      #   # @author Jason Colyer
+      #   # @since 1.0.0
+      #   # @return [Boolean]
+      #   # @note This is inherited from {SupportOps::GitLab::Base#tokens}
+      #   # @see
+      #   #   https://docs.gitlab.com/api/personal_access_tokens/#list-all-personal-access-tokens
+      #   #   GitLab API > Personal access tokens > List all personal access tokens
+      #   # @see
+      #   #   https://docs.gitlab.com/api/user_tokens/#list-all-impersonation-tokens-for-a-user
+      #   #   GitLab API > User tokens > List all impersonation tokens for a user
+      #   # @see SupportOps::GitLab::Configuration Setting up a client
+      #   # @example
+      #   #   require 'support_ops_gitlab'
+      #   #
+      #   #   SupportOps::GitLab::Configuration.configure do |config|
+      #   #     config.url = 'https://gitlab.example.com/api/v4'
+      #   #     config.token = 'abc123'
+      #   #   end
+      #   #
+      #   #   user = SupportOps::GitLab::Users.get!(123456)
+      #   #   tokens = user.tokens
+      #   #   pp tokens.count
+      #   #   # => 3
+      #   #   pp tokens.last.id
+      #   #   # => 789
+      #   def tokens; end
+      # @!parse
+      #   # List personal access tokens for a user
+      #   # 
+      #   # @author Jason Colyer
+      #   # @since 1.0.0
+      #   # @return [Boolean]
+      #   # @note This is inherited from {SupportOps::GitLab::Base#pats}
+      #   # @see
+      #   #   https://docs.gitlab.com/api/personal_access_tokens/#list-all-personal-access-tokens
+      #   #   GitLab API > Personal access tokens > List all personal access tokens
+      #   # @see SupportOps::GitLab::Configuration Setting up a client
+      #   # @example
+      #   #   require 'support_ops_gitlab'
+      #   #
+      #   #   SupportOps::GitLab::Configuration.configure do |config|
+      #   #     config.url = 'https://gitlab.example.com/api/v4'
+      #   #     config.token = 'abc123'
+      #   #   end
+      #   #
+      #   #   user = SupportOps::GitLab::Users.get!(123456)
+      #   #   tokens = user.pats
+      #   #   pp tokens.count
+      #   #   # => 2
+      #   #   pp tokens.last.id
+      #   #   # => 456
+      #   def pats; end
+      # @!parse
+      #   # List impersonation tokens for a user
+      #   # 
+      #   # @author Jason Colyer
+      #   # @since 1.0.0
+      #   # @return [Boolean]
+      #   # @note This is inherited from {SupportOps::GitLab::Base#impersonations}
+      #   # @see
+      #   #   https://docs.gitlab.com/api/user_tokens/#list-all-impersonation-tokens-for-a-user
+      #   #   GitLab API > User tokens > List all impersonation tokens for a user
+      #   # @see SupportOps::GitLab::Configuration Setting up a client
+      #   # @example
+      #   #   require 'support_ops_gitlab'
+      #   #
+      #   #   SupportOps::GitLab::Configuration.configure do |config|
+      #   #     config.url = 'https://gitlab.example.com/api/v4'
+      #   #     config.token = 'abc123'
+      #   #   end
+      #   #
+      #   #   user = SupportOps::GitLab::Users.get!(123456)
+      #   #   tokens = user.impersonations
+      #   #   pp tokens.count
+      #   #   # => 1
+      #   #   pp tokens.last.id
+      #   #   # => 789
+      #   def impersonations; end
+      # @!parse
+      #   # List events for a user
+      #   # 
+      #   # @author Jason Colyer
+      #   # @since 1.0.0
+      #   # @return [Boolean]
+      #   # @note This is inherited from {SupportOps::GitLab::Base#events}
+      #   # @see
+      #   #   https://docs.gitlab.com/api/events/#get-contribution-events-for-a-user
+      #   #   GitLab API > Events > Get contribution events for a user
+      #   # @see SupportOps::GitLab::Configuration Setting up a client
+      #   # @example
+      #   #   require 'support_ops_gitlab'
+      #   #
+      #   #   SupportOps::GitLab::Configuration.configure do |config|
+      #   #     config.url = 'https://gitlab.example.com/api/v4'
+      #   #     config.token = 'abc123'
+      #   #   end
+      #   #
+      #   #   user = SupportOps::GitLab::Users.get!(123456)
+      #   #   events = user.events
+      #   #   pp events.count
+      #   #   # => 216
+      #   def events; end
+      define_attributes :avatar_url, :bio, :can_create_group,
+                        :can_create_project, :color_scheme_id, :commit_email,
+                        :confirmed_at, :created_at, :created_by,
+                        :current_sign_in_at, :current_sign_in_ip, :discord,
+                        :email, :email_reset_offered_at, :external,
+                        :extra_shared_runners_minutes_limit, :followers,
+                        :following, :force_random_password, :github,
+                        :group_saml, :id, :identities, :is_admin, :is_auditor,
+                        :job_title, :last_activity_on, :last_sign_in_at,
+                        :last_sign_in_ip, :linkedin, :local_time, :location,
+                        :locked, :name, :namespace_id, :note, :organization,
+                        :password, :plan, :private_profile,
+                        :provisioned_by_group_id, :projects_limit, :pronouns,
+                        :public_email, :reset_password,
+                        :shared_runners_minutes_limit, :scim_identities,
+                        :sign_in_count, :skype, :state, :theme_id, :trial,
+                        :twitter, :two_factor_enabled, :username, :website_url,
+                        :web_url, :work_information
+      readonly_attributes :confirmed_at, :created_at, :created_by,
+                          :current_sign_in_at, :current_sign_in_ip,
+                          :email_reset_offered_at, :followers, :following,
+                          :group_saml, :id, :identities, :last_activity_on,
+                          :last_sign_in_at, :last_sign_in_ip, :local_time,
+                          :namespace_id, :plan, :provisioned_by_group_id,
+                          :scim_identities, :sign_in_count, :web_url
+
+      ##
+      # Lists users in the GitLab system
+      #
+      # @author Jason Colyer
+      # @since 1.0.0
+      # @overload list(key: value)
+      #   @param active [Boolean optional] Filters only active users; default is
+      #     false
+      #   @param admins [Boolean optional] Return only administrators; default
+      #     is false
+      #   @param auditors [Boolean optional] Return only auditor users; default
+      #     is false; if not included, it returns all users
+      #   @param blocked [Boolean optional] Filters only external users; default
+      #     is false
+      #   @param created_at [DateTime optional] Returns users created after
+      #     specified time
+      #   @param created_before [DateTime optional] Returns users created before
+      #     specified time
+      #   @param extern_uid [String optional] Get a single user with a specific
+      #     external authentication provider UID
+      #   @param external [Boolean optional] Filters only external users;
+      #     default is false
+      #   @param exclude_active [Boolean optional] Filters only non active
+      #     users; default is false
+      #   @param exclude_external [Boolean optional] Filters only non external
+      #     users; default is false
+      #   @param exclude_humans [Boolean optional] Filters only bot or internal
+      #     users; default is false
+      #   @param exclude_internal [Boolean optional] Filters only non internal
+      #     users; default is false
+      #   @param humans [Boolean optional] Filters only regular users that are
+      #     not bot or internal users; default is false
+      #   @param order_by [String optional] Return users ordered by id, name,
+      #     username, created_at, or updated_at fields; default is id
+      #   @param provider [String optional] The external provider
+      #   @param saml_provider_id [Integer optional] Return only users created
+      #     by the specified SAML provider ID; if not included, it returns all
+      #     users
+      #   @param search [String optional] Search for users by name, username, or
+      #     public email
+      #   @param skip_ldap [Boolean optional] Skip LDAP users
+      #   @param sort [String optional] Return users sorted in asc or desc
+      #     order; default is desc
+      #   @param two_factor [Boolean optional] Filter users by Two-factor
+      #     authentication; filter values are enabled or disabled; by default it
+      #     returns all users
+      #   @param username [String optional] Get a single user with a specific
+      #     username
+      #   @param without_project_bots [Boolean optional] Filters user without
+      #     project bots; defaults to false
+      #   @param without_projects [Boolean optional] Filter users without
+      #     projects; default is false, which means that all users are returned,
+      #     with and without projects.
+      #   @param limit [Integer optional] The limit to the number of users
+      #     returned. Default to 0 (i.e. no limit)
+      # @return [Array]
+      # @see
+      #   https://docs.gitlab.com/api/users/#list-users
+      #   GitLab API > Users > List users
+      # @see SupportOps::GitLab::Configuration Setting up a client
+      # @example
+      #   require 'support_ops_gitlab'
+      #
+      #   SupportOps::GitLab::Configuration.configure do |config|
+      #     config.url = 'https://gitlab.example.com/api/v4'
+      #     config.token = 'abc123'
+      #   end
+      #
+      #   users = SupportOps::GitLab::Users.list(limit: 250)
+      #   pp users.count
+      #   # => 250
+      #   pp users.last.email
+      #   # => "gabe@example.com"
+      def self.list(**args)
+        args[:active] = nil unless args[:active]
+        args[:admins] = nil unless args[:admins]
+        args[:auditors] = nil unless args[:auditors]
+        args[:blocked] = nil unless args[:blocked]
+        args[:created_at] = nil unless args[:created_at]
+        args[:created_before] = nil unless args[:created_before]
+        args[:exclude_active] = nil unless args[:exclude_active]
+        args[:exclude_external] = nil unless args[:exclude_external]
+        args[:exclude_humans] = nil unless args[:exclude_humans]
+        args[:exclude_internal] = nil unless args[:exclude_internal]
+        args[:external] = nil unless args[:external]
+        args[:extern_uid] = nil unless args[:extern_uid]
+        args[:humans] = nil unless args[:humans]
+        args[:order_by] = nil unless args[:order_by]
+        args[:provider] = nil unless args[:provider]
+        args[:saml_provider_id] = nil unless args[:saml_provider_id]
+        args[:search] = nil unless args[:search]
+        args[:skip_ldap] = nil unless args[:skip_ldap]
+        args[:sort] = nil unless args[:sort]
+        args[:two_factor] = nil unless args[:two_factor]
+        args[:username] = nil unless args[:username]
+        args[:without_project_bots] = nil unless args[:without_project_bots]
+        args[:without_projects] = nil unless args[:without_projects]
+        args[:limit] = 0 unless args[:limit]
+        params = ''
+        params += "active=#{args[:active]}&" unless args[:active].nil?
+        params += "admins=#{args[:admins]}&" unless args[:admins].nil?
+        params += "auditors=#{args[:auditors]}&" unless args[:auditors].nil?
+        params += "blocked=#{args[:blocked]}&" unless args[:blocked].nil?
+        params += "created_at=#{args[:created_at]}&" unless args[:created_at].nil?
+        params += "created_before=#{args[:created_before]}&" unless args[:created_before].nil?
+        params += "exclude_active=#{args[:exclude_active]}&" unless args[:exclude_active].nil?
+        params += "exclude_external=#{args[:exclude_external]}&" unless args[:exclude_external].nil?
+        params += "exclude_humans=#{args[:exclude_humans]}&" unless args[:exclude_humans].nil?
+        params += "exclude_internal=#{args[:exclude_internal]}&" unless args[:exclude_internal].nil?
+        params += "external=#{args[:external]}&" unless args[:external].nil?
+        params += "extern_uid=#{args[:extern_uid]}&" unless args[:extern_uid].nil?
+        params += "humans=#{args[:humans]}&" unless args[:humans].nil?
+        params += "order_by=#{args[:order_by]}&" unless args[:order_by].nil?
+        params += "provider=#{args[:provider]}&" unless args[:provider].nil?
+        params += "saml_provider_id=#{args[:saml_provider_id]}&" unless args[:saml_provider_id].nil?
+        params += "search=#{args[:search]}&" unless args[:search].nil?
+        params += "skip_ldap=#{args[:skip_ldap]}&" unless args[:skip_ldap].nil?
+        params += "sort=#{args[:sort]}&" unless args[:sort].nil?
+        params += "two_factor=#{args[:two_factor]}&" unless args[:two_factor].nil?
+        params += "username=#{args[:username]}&" unless args[:username].nil?
+        params += "without_project_bots=#{args[:without_project_bots]}&" unless args[:without_project_bots].nil?
+        params += "without_projects=#{args[:without_projects]}&" unless args[:without_projects].nil?
+        users = []
+        page = 1
+        loop do
+          response = client.connection.get("users?#{params}&page=#{page}&per_page=100")
+          body = Oj.load(response.body)
+          users += body.map { |u| Users.new(u) }
+          break if args[:limit].to_i.positive? && users.count >= args[:limit].to_i
+          break if body.count < 100
+
+          page += 1
+        end
+        return users if args[:limit].to_i.zero?
+        
+        users.first(args[:limit].to_i)
+      end
+
+      ##
+      # Fetches the current user from the GitLab system
+      #
+      # @author Jason Colyer
+      # @since 1.0.0
+      # @return [Object]
+      # @see
+      #   https://docs.gitlab.com/api/users/#get-the-current-user
+      #   GitLab API > Users > Get the current user
+      # @see SupportOps::GitLab::Configuration Setting up a client
+      # @example
+      #   require 'support_ops_gitlab'
+      #
+      #   SupportOps::GitLab::Configuration.configure do |config|
+      #     config.url = 'https://gitlab.example.com/api/v4'
+      #     config.token = 'abc123'
+      #   end
+      #
+      #   user = SupportOps::GitLab::Users.current
+      #   pp user.email
+      #   # => "gabe@example.com"
+      def self.current
+        response = client.connection.get('user')
+        Users.new(Oj.load(response.body))
+      end
+
+      ##
+      # Locates a specific user in the GitLab system
+      #
+      # @author Jason Colyer
+      # @since 1.0.0
+      # @see
+      #   https://docs.gitlab.com/api/users/#get-a-single-user
+      #   GitLab API > Users > Get a single user
+      # @see SupportOps::GitLab::Configuration Setting up a client
+      # @example
+      #   require 'support_ops_gitlab'
+      #
+      #   SupportOps::GitLab::Configuration.configure do |config|
+      #     config.url = 'https://gitlab.com/api/v4'
+      #     config.token = 'abc123'
+      #   end
+      #
+      #   user = SupportOps::GitLab::Users.get(13983927615772)
+      #   pp user.email
+      #   # => "gabe@example.com"
+      def self.get(object)
+        if object.is_a? Users
+          Users.new(id: id).find
+        else
+          Users.new(id: object).find
+        end
+      end
+
+      ##
+      # Locates a specific user in the GitLab system
+      #
+      # @author Jason Colyer
+      # @since 1.0.0
+      # @see
+      #   https://docs.gitlab.com/api/users/#get-a-single-user
+      #   GitLab API > Users > Get a single user
+      # @see SupportOps::GitLab::Configuration Setting up a client
+      # @example
+      #   require 'support_ops_gitlab'
+      #
+      #   SupportOps::GitLab::Configuration.configure do |config|
+      #     config.url = 'https://gitlab.com/api/v4'
+      #     config.token = 'abc123'
+      #   end
+      #
+      #   user = SupportOps::GitLab::Users.get!(13983927615772)
+      #   pp user.email
+      #   # => "gabe@example.com"
+      def self.get!(object)
+        if object.is_a? Users
+          Users.new(id: id).find!
+        else
+          Users.new(id: object).find!
+        end
+      end
+
+      private
+
+      ##
+      # @private
+      def get_record
+        response = self.client.connection.get("users/#{self.id}")
+        return nil if response.status != 200
+
+        Oj.load(response.body)
+      end
+
+      ##
+      # @private
+      def create_record
+        response = self.client.connection.post('users', attributes_for_save.to_json)
+        body = Oj.load(response.body)
+        raise "Failed to create user => #{body}" if response.status != 201
+        body
+      end
+
+      ##
+      # @private
+      def update_record
+        raise "Failed to update user => You didn't change anything in the object" if attributes_for_save.keys == [:id]
+        response = self.client.connection.put("users/#{self.id}", attributes_for_save.to_json)
+        body = Oj.load(response.body)
+        raise "Failed to update user #{self.id} => #{body}" if response.status != 200
+        body
+      end
+
+      ##
+      # @private
+      def delete_record
+        response = self.client.connection.delete("users/#{self.id}")
+        body = Oj.load(response.body)
+        raise "Failed to delete user => #{body}" if response.status != 200
+        true
+      end
+
+      ##
+      # @private
+      def hard_delete_record
+        response = self.client.connection.delete("users/#{self.id}?hard_delete=true")
+        body = Oj.load(response.body)
+        raise "Failed to delete user => #{body}" if response.status != 200
+        true
+      end
+
+      ##
+      # @private
+      def projects_record
+        array = []
+        page = 1
+        loop do
+          response = self.client.connection.get("users/#{self.id}/projects?per_page=100&page=#{page}?statistics=true")
+          body = Oj.load(response.body)
+          array += body.map { |p| Projects.new(p) }
+          break if body.count < 100
+
+          page += 1
+        end
+        array
+      end
+
+      ##
+      # @private
+      def memberships_record
+        page = 1
+        array = []
+        loop do
+          response = self.client.connection.get("users/#{self.id}/memberships?per_page=100&page=#{page}")
+          body = Oj.load(response.body)
+          raise 'Only admins can query this' if response.status == 403
+          raise "No such user #{user.id}" if response.status == 404
+          array += body.map { |b| UserMemberships.new(b) }
+          break if body.count < 100
+
+          page += 1
+        end
+        array
+      end
+
+      ##
+      # @private
+      def ssh_keys_record
+        SSHKeys.list(user_id: self.id)
+      end
+
+      ##
+      # @private
+      def gpg_keys_record
+        GPGKeys.list(user_id: self.id)
+      end
+
+      ##
+      # @private
+      def tokens_record
+        pats_records + impersonations_record
+      end
+
+      ##
+      # @private
+      def pats_records
+        UserTokens.list_pats(user_id: self.id)
+      end
+
+      ##
+      # @private
+      def impersonations_record
+        UserTokens.list_impersonation(user_id: self.id)
+      end
+
+      ##
+      # @private
+      def block_record
+        response = self.client.connection.post("users/#{self.id}/block")
+        raise "Unable to locate user #{self.id}" if response.status == 404
+        raise "Failed to block user #{self.id} => code #{response.code}" if response.status != 201
+        true
+      end
+
+      ##
+      # @private
+      def unblock_record
+        response = self.client.connection.post("users/#{self.id}/unblock")
+        raise "Unable to locate user #{self.id}" if response.status == 404
+        raise "Failed to block user #{self.id} => code #{response.code}" if response.status != 201
+        true
+      end
+
+      ##
+      # @private
+      def ban_record
+        response = self.client.connection.post("users/#{self.id}/ban")
+        raise "Unable to locate user #{self.id}" if response.status == 404
+        raise "Failed to ban user #{self.id} => code #{response.code}" if response.status != 201
+        true
+      end
+
+      ##
+      # @private
+      def unban_record
+        response = self.client.connection.post("users/#{self.id}/unban")
+        raise "Unable to locate user #{self.id}" if response.status == 404
+        raise "Failed to unban user #{self.id} => code #{response.code}" if response.status != 201
+        true
+      end
+
+      ##
+      # @private
+      def deactivate_record
+        response = self.client.connection.post("users/#{self.id}/deactivate")
+        raise "Unable to locate user #{self.id}" if response.status == 404
+        raise "Failed to deactivate user #{self.id} => code #{response.code}" if response.status != 201
+        true
+      end
+
+      ##
+      # @private
+      def activate_record
+        response = self.client.connection.post("users/#{self.id}/activate")
+        raise "Unable to locate user #{self.id}" if response.status == 404
+        raise "Failed to activate user #{self.id} => code #{response.code}" if response.status != 201
+        true
+      end
+
+      ##
+      # @private
+      def approve_record
+        response = self.client.connection.post("users/#{self.id}/approve")
+        raise "Unable to locate user #{self.id}" if response.status == 404
+        raise "User #{self.id} is deactivated, so you cannot approve them" if response.status == 409
+        raise "Failed to approve user #{self.id} => code #{response.code}" if response.status != 201
+        true
+      end
+
+      ##
+      # @private
+      def reject_record
+        response = self.client.connection.post("users/#{self.id}/reject")
+        raise "Unable to locate user #{self.id}" if response.status == 404
+        raise "User #{self.id} is not pending approval" if response.status == 409
+        raise "Failed to reject user #{self.id} => code #{response.code}" if response.status != 201
+        true
+      end
+
+      ##
+      # @private
+      def emails_record
+        UserEmails.list(user_id: self.id)
+      end
+
+      ##
+      # @private
+      def support_pin_record
+        if Users.current.id == self.id
+          response = client.connection.get("user/support_pin")
+        else
+          response = client.connection.get("users/#{self.id}/support_pin")
+        end
+        body = Oj.load(response.body)
+        raise "This requires an administrator level account" if response.status == 403
+        return Hash.new if response.status == 404
+
+        body
+      end
+
+      ##
+      # @private
+      def create_support_pin_record
+        raise 'You can only do this for your own user' unless Users.current.id == self.id
+
+        response = client.connection.post("user/support_pin")
+        body = Oj.load(response.body)
+        pp response.status
+        raise "Unable to create support pin => #{body}" unless response.status == 201
+        body
+      end
+
+      ##
+      # @private
+      def disable_2fa_record
+        response = self.client.connection.patch("users/#{self.id}/disable_two_factor")
+        raise "Unable to locate user #{self.id}" if response.status == 404
+        raise "User #{self.id} is not pending approval" if response.status == 409
+        raise "Failed to reject user #{self.id} => code #{response.code}" if response.status != 201
+        true
+      end
+
+      ##
+      # @private
+      def events_record
+        Events.list_user(user_id: self.id)
+      end
+    end
+  end
+end