Copyright	(c) Rob Stewart Heriot-Watt University 2019
License	BSD3
Maintainer	[email protected]
Stability	stable
Safe Haskell	None
Language	Haskell2010

GitLab.API.Users

Contents

List users
Single user
User creation
User modification
Delete authentication identity from user
User deletion
List current user
User status
Get the status of a user
Get user preferences
Follow and unfollow users
User counts
List SSH keys
List SSH keys for user
Add SSH key
Add SSH key for user
Delete SSH key for current user
Delete SSH key for given user
List emails
List emails for user
Block or unblock user
Activate or deactivate user
Ban or unban user
Approve or reject user
Users attributes

Description

Synopsis

users :: GitLab [User]
user :: Int -> GitLab (Either (Response ByteString) (Maybe User))
searchUser :: Text -> GitLab (Maybe User)
createUser :: Text -> Text -> Text -> UserAttrs -> GitLab (Either (Response ByteString) (Maybe User))
userAttributes :: User -> Bool -> UserAttrs
modifyUser :: Int -> UserAttrs -> GitLab (Either (Response ByteString) (Maybe User))
deleteAuthIdentity :: User -> Text -> GitLab (Either (Response ByteString) (Maybe ()))
deleteUser :: User -> GitLab (Either (Response ByteString) (Maybe ()))
currentUser :: GitLab User
currentUserStatus :: GitLab UserStatus
userStatus :: User -> GitLab UserStatus
userPreferences :: GitLab UserPrefs
followUser :: User -> GitLab (Either (Response ByteString) (Maybe User))
unfollowUser :: User -> GitLab (Either (Response ByteString) (Maybe User))
currentUserCounts :: GitLab UserCount
currentUserSshKeys :: GitLab Key
userSshKeys :: User -> GitLab Key
addSshKeyCurrentUser :: Text -> Text -> GitLab (Either (Response ByteString) (Maybe Key))
addSshKeyUser :: User -> Text -> Text -> GitLab (Either (Response ByteString) (Maybe Key))
deleteSshKeyCurrentUser :: Int -> GitLab (Either (Response ByteString) (Maybe ()))
deleteSshKeyUser :: User -> Int -> GitLab (Either (Response ByteString) (Maybe ()))
emails :: GitLab [Email]
emailsCurrentUser :: User -> GitLab [Email]
blockUser :: User -> GitLab (Maybe User)
unblockUser :: User -> GitLab (Maybe User)
activateUser :: User -> GitLab (Maybe User)
deactivateUser :: User -> GitLab (Maybe User)
banUser :: User -> GitLab (Maybe User)
unbanUser :: User -> GitLab (Maybe User)
approveUser :: User -> GitLab (Maybe User)
rejectUser :: User -> GitLab (Maybe User)
defaultUserFilters :: UserAttrs
data UserAttrs = UserAttrs {
- userFilter_admin :: Maybe Bool
- userFilter_bio :: Maybe Text
- userFilter_can_create_group :: Maybe Bool
- userFilter_email :: Maybe Text
- userFilter_extern_uid :: Maybe Int
- userFilter_external :: Maybe Bool
- userFilter_force_random_password :: Maybe Bool
- userFilter_group_id_for_saml :: Maybe Int
- userFilter_linkedin :: Maybe Text
- userFilter_location :: Maybe Text
- userFilter_name :: Maybe Text
- userFilter_note :: Maybe Text
- userFilter_organization :: Maybe Text
- userFilter_password :: Maybe Text
- userFilter_private_profile :: Maybe Bool
- userFilter_projects_limit :: Maybe Int
- userFilter_providor :: Maybe Text
- userFilter_reset_password :: Maybe Bool
- userFilter_skip_confirmation :: Maybe Bool
- userFilter_skype :: Maybe Text
- userFilter_theme_id :: Maybe Int
- userFilter_twitter :: Maybe Text
- userFilter_username :: Maybe Text
- userFilter_view_diffs_file_by_file :: Maybe Bool
- userFilter_website :: Maybe Text
- userFilter_pronouns :: Maybe Text
}

List users

users :: GitLab [User] Source #

all registered users.

Single user

user Source #

Arguments

:: Int	ID of users
-> GitLab (Either (Response ByteString) (Maybe User))

Get a single user.

searchUser Source #

Arguments

:: Text	username to search for
-> GitLab (Maybe User)

searches for a user given a username.

User creation

createUser Source #

Arguments

:: Text	email address
-> Text	user's name
-> Text	user's username
-> UserAttrs	optional attributes
-> GitLab (Either (Response ByteString) (Maybe User))

Creates a new user. Note only administrators can create new users. Either password, reset_password, or force_random_password must be specified. If reset_password and force_random_password are both false, then password is required. force_random_password and reset_password take priority over password. In addition, reset_password and force_random_password can be used together.

User modification

userAttributes Source #

Arguments

:: User	the user
-> Bool	is the user a GitLab server administrator
-> UserAttrs	the extracted user attributes

Extracts the user attributes for a user. Useful for modifying attrbibutes with modifyUser.

modifyUser Source #

Arguments

:: Int	user ID
-> UserAttrs	optional attributes
-> GitLab (Either (Response ByteString) (Maybe User))

Modifies an existing user. Only administrators can change attributes of a user.

Delete authentication identity from user

deleteAuthIdentity Source #

Arguments

:: User	user
-> Text	external providor name
-> GitLab (Either (Response ByteString) (Maybe ()))

Deletes a user’s authentication identity using the provider name associated with that identity. Available only for administrators.

User deletion

deleteUser Source #

Arguments

:: User	user
-> GitLab (Either (Response ByteString) (Maybe ()))

Deletes a user. Available only for administrators.

List current user

currentUser :: GitLab User Source #

Get current user.

User status

currentUserStatus :: GitLab UserStatus Source #

Get current user status.

Get the status of a user

userStatus Source #

Arguments

:: User	user
-> GitLab UserStatus

Get the status of a user.

Get user preferences

userPreferences :: GitLab UserPrefs Source #

Get the status of the current user.

Follow and unfollow users

followUser Source #

Arguments

:: User	user
-> GitLab (Either (Response ByteString) (Maybe User))

Follow a user.

unfollowUser Source #

Arguments

:: User	user
-> GitLab (Either (Response ByteString) (Maybe User))

Unfollow a user.

User counts

currentUserCounts :: GitLab UserCount Source #

Get the counts of the currently signed in user.

List SSH keys

currentUserSshKeys :: GitLab Key Source #

Get a list of currently authenticated user’s SSH keys.

List SSH keys for user

userSshKeys Source #

Arguments

:: User	user
-> GitLab Key

Get a list of a specified user’s SSH keys.

Add SSH key

addSshKeyCurrentUser Source #

Arguments

:: Text	key
-> Text	title
-> GitLab (Either (Response ByteString) (Maybe Key))

Creates a new key owned by the currently authenticated user.

Add SSH key for user

addSshKeyUser Source #

Arguments

:: User	User
-> Text	key
-> Text	title
-> GitLab (Either (Response ByteString) (Maybe Key))

Create new key owned by specified user. Available only for administrator.

Delete SSH key for current user

deleteSshKeyCurrentUser Source #

Arguments

:: Int	key ID
-> GitLab (Either (Response ByteString) (Maybe ()))

Deletes key owned by currently authenticated user.

Delete SSH key for given user

deleteSshKeyUser Source #

Arguments

:: User	user
-> Int	key ID
-> GitLab (Either (Response ByteString) (Maybe ()))

Deletes key owned by a specified user. Available only for administrator.

List emails

emails :: GitLab [Email] Source #

Get a list of currently authenticated user’s emails.

List emails for user

emailsCurrentUser Source #

Arguments

:: User	user
-> GitLab [Email]

Get a list of currently authenticated user’s emails.

Block or unblock user

blockUser Source #

Arguments

:: User	user
-> GitLab (Maybe User)

Blocks the specified user. Available only for administrator.

unblockUser Source #

Arguments

:: User	user
-> GitLab (Maybe User)

Unblocks the specified user. Available only for administrator.

Activate or deactivate user

activateUser Source #

Arguments

:: User	user
-> GitLab (Maybe User)

Activates the specified user. Available only for administrator.

deactivateUser Source #

Arguments

:: User	user
-> GitLab (Maybe User)

Deactivates the specified user. Available only for administrator.

Ban or unban user

banUser Source #

Arguments

:: User	user
-> GitLab (Maybe User)

Bans the specified user. Available only for administrator.

unbanUser Source #

Arguments

:: User	user
-> GitLab (Maybe User)

Unbans the specified user. Available only for administrator.

Approve or reject user

approveUser Source #

Arguments

:: User	user
-> GitLab (Maybe User)

Approves the specified user. Available only for administrator.

rejectUser Source #

Arguments

:: User	user
-> GitLab (Maybe User)

Rejects specified user that is pending approval. Available only for administrator.

Users attributes

defaultUserFilters :: UserAttrs Source #

No group filters applied, thereby returning all groups.

data UserAttrs Source #

Attributes related to a group

Constructors

UserAttrs

Fields

userFilter_admin :: Maybe Bool
User is an administrator - default is false
userFilter_bio :: Maybe Text
User’s biography
userFilter_can_create_group :: Maybe Bool
User can create groups
userFilter_email :: Maybe Text
email address
userFilter_extern_uid :: Maybe Int
External UID
userFilter_external :: Maybe Bool
Flag the user as external - default is fale
userFilter_force_random_password :: Maybe Bool
Set user password to a random value - default is false
userFilter_group_id_for_saml :: Maybe Int
ID of group where SAML has been configured
userFilter_linkedin :: Maybe Text
User's LinkedIn account
userFilter_location :: Maybe Text
User's location
userFilter_name :: Maybe Text
User's name
userFilter_note :: Maybe Text
Administrator notes for this user
userFilter_organization :: Maybe Text
Organization name
userFilter_password :: Maybe Text
User's password
userFilter_private_profile :: Maybe Bool
User’s profile is private - default is false
userFilter_projects_limit :: Maybe Int
Number of projects user can create
userFilter_providor :: Maybe Text
External provider name
userFilter_reset_password :: Maybe Bool
Send user password reset link - default is false
userFilter_skip_confirmation :: Maybe Bool
Skip confirmation - default is false
userFilter_skype :: Maybe Text
User's Skype ID
userFilter_theme_id :: Maybe Int
User's theme ID - GitLab theme for the user
userFilter_twitter :: Maybe Text
User's Twitter account
userFilter_username :: Maybe Text
User's username
userFilter_view_diffs_file_by_file :: Maybe Bool
Flag indicating the user sees only one file diff per page
userFilter_website :: Maybe Text
User's website URL
userFilter_pronouns :: Maybe Text
User's pronouns