Members

Use this API to manage the members of a group or a project, including inherited memberships, membership approvals, and the billable members of a group.

List all direct members of a group

GET /api/v4/groups/{id}/members

Lists all direct members of a specified group viewable by the authenticated user. Does not return inherited members from ancestor groups or invited groups.

Parameters

Name	Type	Description
`id` Path, required	String	The group ID
`query` Query	String	A query string to search for members
`user_ids` Query	Array of integers	Array of user ids to look up for membership
`skip_users` Query	Array of integers	Array of user ids to be skipped for membership
`show_seat_info` Query	Boolean	Show seat information for members
`page` Query	Integer	Current page number Default: `1` Example: `1`
`per_page` Query	Integer	Number of items per page Default: `20` Example: `20`

Responses

Code	Description	Schema
`200`	OK	APIEntitiesMember
`400`	Bad Request	—
`404`	Not Found	—

Add a member to a group

POST /api/v4/groups/{id}/members

Adds a member to a specified group.

Parameters

Name	Type	Description
`id` Path, required	String	The group ID

Request body (application/json)

Property	Type	Description
`access_level` Required	Integer	A valid access level
`expires_at`	String (date-time)	Date string in the format YEAR-MONTH-DAY
`invite_source`	String	Source that triggered the member creation process Default: `members-api`
`user_id`	Integer or string	The user ID of the new member or multiple IDs separated by commas. Mutually exclusive with `username`
`username`	String	The username of the new member or multiple usernames separated by commas. Mutually exclusive with `user_id`

Responses

Code	Description	Schema
`201`	Created	APIEntitiesMember
`400`	Bad Request	—
`404`	Not Found	—

List all members of a group

GET /api/v4/groups/{id}/members/all

Lists all members of a specified group viewable by the authenticated user. Also returns inherited members from ancestor groups or invited groups. If a user is a member of this group and one or more ancestor groups, only returns the highest access_level. Members from an invited group are returned if the invited group is public, the requester is a member of an invited group, or the requester is a member of the shared group or project.

Parameters

Name	Type	Description
`id` Path, required	String	The group ID
`query` Query	String	A query string to search for members
`user_ids` Query	Array of integers	Array of user ids to look up for membership
`show_seat_info` Query	Boolean	Show seat information for members
`page` Query	Integer	Current page number Default: `1` Example: `1`
`per_page` Query	Integer	Number of items per page Default: `20` Example: `20`

Responses

Code	Description	Schema
`200`	OK	APIEntitiesMember
`400`	Bad Request	—
`404`	Not Found	—

Retrieve a group member

GET /api/v4/groups/{id}/members/all/{user_id}

Retrieves a specified member of a group. Returns direct members and members inherited or invited through ancestor groups.

Parameters

Name	Type	Description
`id` Path, required	String	The group ID
`user_id` Path, required	Integer	The user ID of the member

Responses

Code	Description	Schema
`200`	OK	APIEntitiesMember
`400`	Bad Request	—
`404`	Not Found	—

Retrieve a direct group member

GET /api/v4/groups/{id}/members/{user_id}

Retrieves a specified member of a group. Returns only direct members and not inherited members through ancestor groups.

Parameters

Name	Type	Description
`id` Path, required	String	The group ID
`user_id` Path, required	Integer	The user ID of the member

Responses

Code	Description	Schema
`200`	OK	APIEntitiesMember
`400`	Bad Request	—
`404`	Not Found	—

Update a group member

PUT /api/v4/groups/{id}/members/{user_id}

Updates a specified member of a group.

Parameters

Name	Type	Description
`id` Path, required	String	The group ID
`user_id` Path, required	Integer	The user ID of the new member

Request body (application/json)

Property	Type	Description
`access_level` Required	Integer	A valid access level
`expires_at`	String (date-time)	Date string in the format YEAR-MONTH-DAY

Responses

Code	Description	Schema
`200`	OK	APIEntitiesMember
`400`	Bad Request	—
`404`	Not Found	—

Remove a member from a group

DELETE /api/v4/groups/{id}/members/{user_id}

Removes a specified user from a group. The user must be a direct member.

Parameters

Name	Type	Description
`id` Path, required	String	The group ID
`user_id` Path, required	Integer	The user ID of the member
`skip_subresources` Query	Boolean	If `true`, the member retains any direct memberships in subgroups or projects Default: `false`
`unassign_issuables` Query	Boolean	If `true`, unassigns the member from any issues or merge requests in the group Default: `false`

Responses

Code	Description	Schema
`204`	Resource deleted	—
`400`	Bad Request	—
`404`	Not Found	—

List all direct members of a project

GET /api/v4/projects/{id}/members

Lists all direct members of a specified project viewable by the authenticated user. Does not return inherited members from ancestor groups or invited groups.

Parameters

Name	Type	Description
`id` Path, required	String	The project ID
`query` Query	String	A query string to search for members
`user_ids` Query	Array of integers	Array of user ids to look up for membership
`skip_users` Query	Array of integers	Array of user ids to be skipped for membership
`show_seat_info` Query	Boolean	Show seat information for members
`page` Query	Integer	Current page number Default: `1` Example: `1`
`per_page` Query	Integer	Number of items per page Default: `20` Example: `20`

Responses

Code	Description	Schema
`200`	OK	APIEntitiesMember
`400`	Bad Request	—
`404`	Not Found	—

Add a member to a project

POST /api/v4/projects/{id}/members

Adds a member to a specified project.

Parameters

Name	Type	Description
`id` Path, required	String	The project ID

Request body (application/json)

Property	Type	Description
`access_level` Required	Integer	A valid access level
`expires_at`	String (date-time)	Date string in the format YEAR-MONTH-DAY
`invite_source`	String	Source that triggered the member creation process Default: `members-api`
`user_id`	Integer or string	The user ID of the new member or multiple IDs separated by commas. Mutually exclusive with `username`
`username`	String	The username of the new member or multiple usernames separated by commas. Mutually exclusive with `user_id`

Responses

Code	Description	Schema
`201`	Created	APIEntitiesMember
`400`	Bad Request	—
`404`	Not Found	—

List all members of a project

GET /api/v4/projects/{id}/members/all

Lists all members of a specified project viewable by the authenticated user. Also returns inherited members from ancestor groups or invited groups. If a user is a member of this project and one or more ancestor groups, only returns the highest access_level. Members from an invited group are returned if the invited group is public, the requester is a member of an invited group, or the requester is a member of the shared group or project.

Parameters

Name	Type	Description
`id` Path, required	String	The project ID
`query` Query	String	A query string to search for members
`user_ids` Query	Array of integers	Array of user ids to look up for membership
`show_seat_info` Query	Boolean	Show seat information for members
`page` Query	Integer	Current page number Default: `1` Example: `1`
`per_page` Query	Integer	Number of items per page Default: `20` Example: `20`

Responses

Code	Description	Schema
`200`	OK	APIEntitiesMember
`400`	Bad Request	—
`404`	Not Found	—

Retrieve a project member

GET /api/v4/projects/{id}/members/all/{user_id}

Retrieves a specified member of a project. Returns direct members and members inherited or invited through ancestor groups.

Parameters

Name	Type	Description
`id` Path, required	String	The project ID
`user_id` Path, required	Integer	The user ID of the member

Responses

Code	Description	Schema
`200`	OK	APIEntitiesMember
`400`	Bad Request	—
`404`	Not Found	—

Retrieve a direct project member

GET /api/v4/projects/{id}/members/{user_id}

Retrieves a specified member of a project. Returns only direct members and not inherited members through ancestor groups.

Parameters

Name	Type	Description
`id` Path, required	String	The project ID
`user_id` Path, required	Integer	The user ID of the member

Responses

Code	Description	Schema
`200`	OK	APIEntitiesMember
`400`	Bad Request	—
`404`	Not Found	—

Update a project member

PUT /api/v4/projects/{id}/members/{user_id}

Updates a specified member of a project.

Parameters

Name	Type	Description
`id` Path, required	String	The project ID
`user_id` Path, required	Integer	The user ID of the new member

Request body (application/json)

Property	Type	Description
`access_level` Required	Integer	A valid access level
`expires_at`	String (date-time)	Date string in the format YEAR-MONTH-DAY

Responses

Code	Description	Schema
`200`	OK	APIEntitiesMember
`400`	Bad Request	—
`404`	Not Found	—

Remove a member from a project

DELETE /api/v4/projects/{id}/members/{user_id}

Removes a specified user from a project. The user must be a direct member.

Parameters

Name	Type	Description
`id` Path, required	String	The project ID
`user_id` Path, required	Integer	The user ID of the member
`skip_subresources` Query	Boolean	If `true`, the member retains any direct memberships in subgroups or projects Default: `false`
`unassign_issuables` Query	Boolean	If `true`, unassigns the member from any issues or merge requests in the project Default: `false`

Responses

Code	Description	Schema
`204`	Resource deleted	—
`400`	Bad Request	—
`404`	Not Found	—

Schemas

Objects returned by the operations above and objects nested in their request bodies.

APIEntitiesCustomAttribute

Property	Type	Description
`key`	String	Example: `foo`
`value`	String	Example: `bar`

APIEntitiesMember

Property	Type	Description
`access_level`	String	—
`avatar_path`	String	Example: `/user/avatar/28/The-Big-Lebowski-400-400.png`
`avatar_url`	String	Example: `https://gravatar.com/avatar/1`
`created_at`	String	—
`created_by`	APIEntitiesUserBasic	—
`custom_attributes`	Array of APIEntitiesCustomAttribute	—
`expires_at`	String	—
`id`	Integer (int64)	Example: `1`
`locked`	Boolean	—
`name`	String	Example: `Administrator`
`public_email`	String	Example: `john@example.com`
`state`	String	Example: `active`
`two_factor_enabled`	Boolean	—
`username`	String	Example: `admin`
`web_url`	String	Example: `https://gitlab.example.com/root`

APIEntitiesUserBasic

Property	Type	Description
`avatar_path`	String	Example: `/user/avatar/28/The-Big-Lebowski-400-400.png`
`avatar_url`	String	Example: `https://gravatar.com/avatar/1`
`custom_attributes`	Array of APIEntitiesCustomAttribute	—
`id`	Integer (int64)	Example: `1`
`locked`	Boolean	—
`name`	String	Example: `Administrator`
`public_email`	String	Example: `john@example.com`
`state`	String	Example: `active`
`username`	String	Example: `admin`
`web_url`	String	Example: `https://gitlab.example.com/root`

List all direct members of a group

Add a member to a group

List all members of a group

Retrieve a group member

Retrieve a direct group member

Update a group member

Remove a member from a group

List all direct members of a project

Add a member to a project

List all members of a project

Retrieve a project member

Retrieve a direct project member

Update a project member

Remove a member from a project

Schemas

APIEntitiesCustomAttribute

APIEntitiesMember

APIEntitiesUserBasic

Request trial access

Thank you

Error

Request callback

Thank you

Something went wrong

Book your sessions

Thank you

Error

Request demo

Thank you

Error

Get the PCI SSC Compliance Report

Thank you

Error