GitLab.API.Groups

List groups

groups :: ListGroupsAttrs -> GitLab [Group]

Get a list of visible groups for the authenticated user.

List a group’s subgroups

subGroups :: Group -> ListGroupsAttrs -> GitLab [Group]

Get a list of visible direct subgroups in this group.

List a group’s descendant groups

descendantGroups :: Group -> ListGroupsAttrs -> GitLab [Group]

Get a list of visible descendant groups of this group.

List a group’s projects

groupProjects :: Group -> GroupProjectAttrs -> GitLab [Project]

Get a list of projects in this group.

List a group’s shared projects

groupSharedProjects :: Group -> GroupProjectAttrs -> GitLab [Project]

Get a list of projects in this group.

Details of a group

group

Arguments

:: Int

group ID

-> GitLab (Either (Response ByteString) (Maybe Group))

Get all details of a group.

New group

newGroup

Arguments

:: Text

group name

-> Text

group path

-> GroupAttrs

group attributes

-> GitLab (Either (Response ByteString) (Maybe Group))

Creates a new project group (TODO include attributes).

New Subgroup

newSubGroup

Arguments

:: Text

group name

-> Text

group path

-> Int

parent group ID

-> GroupAttrs

group attributes

-> GitLab (Either (Response ByteString) (Maybe Group))

Creates a new project group.

Update group

updateGroup

Arguments

:: Int

The ID of the group.

-> GroupAttrs

Group attributes

-> GitLab (Either (Response ByteString) (Maybe Group))

Updates the project group. Only available to group owners and administrators.

Remove group

removeGroup

Arguments

:: Int

The ID of the group.

-> GitLab (Either (Response ByteString) (Maybe ()))

Only available to group owners and administrators.

Search for group

searchGroup

Arguments

:: Text

String or path to search for.

-> GitLab [Group]

Get all groups that match your string in their name or path.

Group attributes

data ListGroupsAttrs

Attributes related to listing groups

Constructors

ListGroupsAttrs

Fields

• listGroupsFilter_skip_groups :: Maybe [Int]
• listGroupsFilter_all_available :: Maybe Bool
• listGroupsFilter_search :: Maybe Text
• listGroupsFilter_order_by :: Maybe GroupOrderBy
• listGroupsFilter_sort :: Maybe SortBy
• listGroupsFilter_owned :: Maybe Bool
• listGroupsFilter_min_access_level :: Maybe AccessLevel
• listGroupsFilter_top_level_only :: Maybe Bool

data GroupOrderBy

The order of groups in search results.

Constructors

GroupOrderName

GroupOrderPath

GroupOrderId

GroupOrderSimilarity

Instances

Show GroupOrderBy

Defined in GitLab.API.Groups

Methods

showsPrec :: Int -> GroupOrderBy -> ShowS

show :: GroupOrderBy -> String

showList :: [GroupOrderBy] -> ShowS

data GroupProjectAttrs

Attributes related to a group

Constructors

GroupProjectAttrs

Fields

• groupProjectFilter_id :: Maybe Int
• groupProjectFilter_archived :: Maybe Bool
• groupProjectFilter_visibility :: Maybe Visibility
• groupProjectFilter_order_by :: Maybe GroupProjectOrderBy
• groupProjectFilter_sort :: Maybe SortBy
• groupProjectFilter_search :: Maybe Text
• groupProjectFilter_simple :: Maybe Bool
• groupProjectFilter_owned :: Maybe Bool
• groupProjectFilter_starred :: Maybe Bool
• groupProjectFilter_with_issues_enabled :: Maybe Bool
• groupProjectFilter_with_merge_requests_enabled :: Maybe Bool
• groupProjectFilter_with_shared :: Maybe Bool
• groupProjectFilter_include_subgroups :: Maybe Bool
• groupProjectFilter_min_access_level :: Maybe AccessLevel
• groupProjectFilter_with_custom_attributes :: Maybe Bool
• groupProjectFilter_with_security_reports :: Maybe Bool

data GroupProjectOrderBy

The order of group projects in search results.

Constructors

GroupProjectOrderId

GroupProjectOrderName

GroupProjectOrderPath

GroupProjectOrderCreatedAt

GroupProjectOrderUpdatedAt

GroupProjectOrderSimilarity

GroupProjectOrderLastActivityAt

Instances

Show GroupProjectOrderBy

Defined in GitLab.API.Groups

Methods

showsPrec :: Int -> GroupProjectOrderBy -> ShowS

show :: GroupProjectOrderBy -> String

showList :: [GroupProjectOrderBy] -> ShowS

data GroupAttrs

Attributes related to a group

Constructors

GroupAttrs

Fields

• groupFilter_name :: Maybe Text

  The name of the group.

• groupFilter_path :: Maybe Text

  The path of the group.

• groupFilter_auto_devops_enabled :: Maybe Bool

  Default to Auto DevOps pipeline for all projects within this group.

• groupFilter_default_branch_protection :: Maybe BranchProtection

  Default to the global level default branch protection setting.

• groupFilter_description :: Maybe Text

  The group’s description.

• groupFilter_emails_disabled :: Maybe Bool

  Disable email notifications.

• groupFilter_lfs_enabled :: Maybe Bool

  Enable/disable Large File Storage (LFS) for the projects in this group.

• groupFilter_mentions_disabled :: Maybe Bool

  Disable the capability of a group from getting mentioned.

• groupFilter_parent_id :: Maybe Int

  The parent group ID for creating nested group.

• groupFilter_project_creation_level :: Maybe AccessLevel

  Determine if developers can create projects in the group. Can be noone (No one), maintainer (users with the Maintainer role), or developer (users with the Developer or Maintainer role).

• groupFilter_request_access_enabled :: Maybe Bool

  Allow users to request member access.

• groupFilter_require_two_factor_authentication :: Maybe Bool

  Require all users in this group to setup Two-factor authentication.

• groupFilter_share_with_group_lock :: Maybe Bool

  Prevent sharing a project with another group within this group.

• groupFilter_subgroup_creation_level :: Maybe AccessLevel

  Allowed to create subgroups. Can be owner (Owners), or maintainer (users with the Maintainer role).

• groupFilter_two_factor_grace_period :: Maybe Int

  Time before Two-factor authentication is enforced (in hours).

• groupFilter_visibility :: Maybe Visibility

  The group’s visibility. Can be private, internal, or public.

data BranchProtection

A group level branch protection setting.

Constructors

NoProtection

Users with the Developer or Maintainer role can: push new commits, force push changes, delete the branch

PartialProtection

Users with the Developer or Maintainer role can: push new commits

FullProtection

Only users with the Maintainer role can: push new commits

ProtectAgainstPushes

Users with the Maintainer role can: push new commits, force push changes, accept merge requests; Users with the Developer role can: accept merge requests

Instances

Show BranchProtection

Defined in GitLab.API.Groups

Methods

showsPrec :: Int -> BranchProtection -> ShowS

show :: BranchProtection -> String

showList :: [BranchProtection] -> ShowS

defaultGroupFilters :: GroupAttrs

No group filters applied.

defaultListGroupsFilters :: ListGroupsAttrs

No group filters applied, thereby returning all groups.