Copyright	(c) Rob Stewart Heriot-Watt University 2021
License	BSD3
Maintainer	robstewart57@gmail.com
Stability	stable
Safe Haskell	None
Language	Haskell2010

GitLab.API.Members

Contents

Projects
Project membership
- Adding project members
- Removing project members
Groups
Group membership
- Adding group members
- Removing group members

Description

Synopsis

data AccessLevel
- = Guest
- | Reporter
- | Developer
- | Maintainer
- | Owner
membersOfProject :: Project -> GitLab [Member]
membersOfProject' :: Int -> GitLab (Either (Response ByteString) [Member])
addMemberToProject :: Project -> AccessLevel -> User -> GitLab (Either (Response ByteString) (Maybe Member))
addMemberToProject' :: Int -> AccessLevel -> Int -> GitLab (Either (Response ByteString) (Maybe Member))
addMembersToProject :: Project -> AccessLevel -> [User] -> GitLab [Either (Response ByteString) (Maybe Member)]
addMembersToProject' :: Int -> AccessLevel -> [Int] -> GitLab [Either (Response ByteString) (Maybe Member)]
removeUserFromProject :: Text -> User -> GitLab (Either (Response ByteString) (Maybe ()))
removeUserFromProject' :: Text -> Int -> GitLab (Either (Response ByteString) (Maybe ()))
membersOfGroup :: Group -> GitLab [Member]
membersOfGroup' :: Int -> GitLab (Either (Response ByteString) [Member])
addAllUsersToGroup :: Text -> AccessLevel -> GitLab [Either (Response ByteString) (Maybe Member)]
addUserToGroup :: Text -> AccessLevel -> User -> GitLab (Either (Response ByteString) (Maybe Member))
addUserToGroup' :: Text -> AccessLevel -> Int -> GitLab (Either (Response ByteString) (Maybe Member))
addUsersToGroup :: Text -> AccessLevel -> [User] -> GitLab [Either (Response ByteString) (Maybe Member)]
addUsersToGroup' :: Text -> AccessLevel -> [Text] -> GitLab [Either (Response ByteString) (Maybe Member)]
removeUserFromGroup :: Text -> User -> GitLab (Either (Response ByteString) (Maybe ()))
removeUserFromGroup' :: Text -> Int -> GitLab (Either (Response ByteString) (Maybe ()))

Documentation

data AccessLevel Source #

the access levels for project members. See https://docs.gitlab.com/ee/user/permissions.html#project-members-permissions

Constructors

Guest
Reporter
Developer
Maintainer
Owner

Instances

Instances details

Show AccessLevel Source #
Instance details Defined in GitLab.API.Members Methods showsPrec :: Int -> AccessLevel -> ShowS # show :: AccessLevel -> String # showList :: [AccessLevel] -> ShowS #

Projects

Project membership

membersOfProject :: Project -> GitLab [Member] Source #

the members of a project.

membersOfProject' :: Int -> GitLab (Either (Response ByteString) [Member]) Source #

the members of a project given its ID.

Adding project members

addMemberToProject Source #

Arguments

:: Project	the project
-> AccessLevel	level of access
-> User	the user
-> GitLab (Either (Response ByteString) (Maybe Member))

adds a user to a project with the given access level. Returns 'Right Member' for each successful action, otherwise it returns 'Left Status'.

addMemberToProject' Source #

Arguments

:: Int	project ID
-> AccessLevel	level of access
-> Int	user ID
-> GitLab (Either (Response ByteString) (Maybe Member))

adds a user to a project with the given access level, given the project's ID and the user's ID. Returns Right Member for each successful action, otherwise it returns Left Status.

addMembersToProject Source #

Arguments

:: Project	the project
-> AccessLevel	level of access
-> [User]	users to add to the project
-> GitLab [Either (Response ByteString) (Maybe Member)]

adds a list of users to a project with the given access level. Returns 'Right Member' for each successful action, otherwise it returns 'Left Status'.

addMembersToProject' Source #

Arguments

:: Int	project ID
-> AccessLevel	level of acces
-> [Int]	IDs of users to add to the project
-> GitLab [Either (Response ByteString) (Maybe Member)]

adds a list of users to a project with the given access level, given the project's ID and the user IDs. Returns Right Member for each successful action, otherwise it returns Left Status.

Removing project members

removeUserFromProject Source #

Arguments

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

Removes a user from a project where the user has been explicitly assigned a role

removeUserFromProject' Source #

Arguments

:: Text	project name
-> Int	user ID
-> GitLab (Either (Response ByteString) (Maybe ()))

Removes a user from a project where the user has been explicitly assigned a role

Groups

Group membership

membersOfGroup :: Group -> GitLab [Member] Source #

the members of a group.

membersOfGroup' :: Int -> GitLab (Either (Response ByteString) [Member]) Source #

the members of a group given its ID.

Adding group members

addAllUsersToGroup Source #

Arguments

:: Text	group name
-> AccessLevel	level of access granted
-> GitLab [Either (Response ByteString) (Maybe Member)]

adds all registered users to a group.

addUserToGroup Source #

Arguments

:: Text	group name
-> AccessLevel	level of access granted
-> User	the user
-> GitLab (Either (Response ByteString) (Maybe Member))

adds a user to a group.

addUserToGroup' Source #

Arguments

:: Text	group name
-> AccessLevel	level of access granted
-> Int	user ID
-> GitLab (Either (Response ByteString) (Maybe Member))

adds a user with a given user ID to a group.

addUsersToGroup Source #

Arguments

:: Text	group name
-> AccessLevel	level of access granted
-> [User]	list of usernames to be added to the group
-> GitLab [Either (Response ByteString) (Maybe Member)]

adds a list of users to a group.

addUsersToGroup' Source #

Arguments

:: Text	group name
-> AccessLevel	level of access granted
-> [Text]	list of usernames to be added to the group
-> GitLab [Either (Response ByteString) (Maybe Member)]

adds a list of users to a group.

Removing group members

removeUserFromGroup Source #

Arguments

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

Removes a user from a group where the user has been explicitly assigned a role

removeUserFromGroup' Source #

Arguments

:: Text	group name
-> Int	user ID
-> GitLab (Either (Response ByteString) (Maybe ()))

Removes a user from a group where the user has been explicitly assigned a role