Users

Use this API to interact with user accounts on GitLab. These endpoints can help manage your account, manage accounts for other users, moderate user accounts, perform follower actions, and interact with email addresses for user accounts.

Retrieve current user details

GET /api/v4/user

Retrieves details about your user account.

Responses

Code	Description	Schema
`200`	OK	APIEntitiesUserPublic
`401`	Unauthorized	—
`403`	Forbidden	—

List all activity for a user

GET /api/v4/user/activities

Lists all activity for a specified user.

Parameters

Name	Type	Description
`from` Query	String (date-time)	Date string in the format YEAR-MONTH-DAY Default: `2024-08-14T17:26:19.883Z` Example: `2024-08-14T17:26:19.883Z`
`page` Query	Integer	Page number of results to retrieve Default: `1` Example: `1`
`per_page` Query	Integer	Number of items to list per page Default: `20` Example: `20`

Responses

Code	Description	Schema
`200`	OK	Array of APIEntitiesUserActivity
`400`	Bad Request	—

List all email addresses for a user

GET /api/v4/user/emails

Lists all email addresses for the currently authenticated user.

Parameters

Name	Type	Description
`page` Query	Integer	Page number of results to retrieve Default: `1` Example: `1`
`per_page` Query	Integer	Number of items to list per page Default: `20` Example: `20`

Responses

Code	Description	Schema
`200`	OK	Array of APIEntitiesEmail
`400`	Bad Request	—

Add an email address

POST /api/v4/user/emails

Adds an email address for the currently authenticated user.

Request body (application/json)

Property	Type	Description
`email` Required	String	Email address to add to the account

Responses

Code	Description	Schema
`201`	Created	APIEntitiesEmail
`400`	Bad Request	—

Retrieve details on an email address

GET /api/v4/user/emails/{email_id}

Retrieves details on a specified email address for the currently authenticated user.

Parameters

Name	Type	Description
`email_id` Path, required	Integer	ID of the email

Responses

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

Delete an email address

DELETE /api/v4/user/emails/{email_id}

Deletes the specified email address. You cannot delete a primary email address. Any future emails sent to the deleted email address are sent to the primary email address instead.

Parameters

Name	Type	Description
`email_id` Path, required	Integer	ID of the email

Responses

Code	Description	Schema
`204`	No Content	—
`400`	Bad Request	—
`404`	Not Found	—

Retrieve your user preferences

GET /api/v4/user/preferences

Retrieves your user preferences.

Responses

Code	Description	Schema
`200`	OK	APIEntitiesUserPreferences
`401`	Unauthorized	—
`403`	Forbidden	—

Update your user preferences

PUT /api/v4/user/preferences

Updates your user preferences.

Request body (application/json)

Property	Type	Description
`pass_user_identities_to_ci_jwt`	Boolean	If `true`, passes the user’s external identities to CI jobs as part of a JSON web token. This attribute is internal to GitLab and must not be passed to third-party services. For more information, see Token Payload. At least one of `view_diffs_file_by_file`, `show_whitespace_in_diffs`, `pass_user_identities_to_ci_jwt`, `policy_advanced_editor` must be provided
`policy_advanced_editor`	Boolean	If `true`, enables the advanced editor. At least one of `view_diffs_file_by_file`, `show_whitespace_in_diffs`, `pass_user_identities_to_ci_jwt`, `policy_advanced_editor` must be provided
`show_whitespace_in_diffs`	Boolean	If `true`, the user sees whitespace changes in diffs. At least one of `view_diffs_file_by_file`, `show_whitespace_in_diffs`, `pass_user_identities_to_ci_jwt`, `policy_advanced_editor` must be provided
`view_diffs_file_by_file`	Boolean	If `true`, the user sees only one file diff per page. At least one of `view_diffs_file_by_file`, `show_whitespace_in_diffs`, `pass_user_identities_to_ci_jwt`, `policy_advanced_editor` must be provided

Responses

Code	Description	Schema
`200`	OK	APIEntitiesUserPreferences
`400`	Bad Request	—

Create a runner owned by currently authenticated user

POST /api/v4/user/runners

Create a new runner

Request body (application/json)

Property	Type	Description
`access_level`	String	Access level of the runner Allowed values: `not_protected`, `ref_protected`
`description`	String	Description of the runner
`group_id` Required	Integer	ID of the group to create the runner in. Required if `runner_type` is `group_type` Example: `1`
`locked`	Boolean	Specifies if the runner should be locked for the current project Default: `false`
`maintenance_note`	String	Free-form maintenance notes for the runner. Limited to 1024 characters
`maximum_timeout`	Integer	Maximum time, in seconds, that runners can spend running a job
`paused`	Boolean	If `true`, the runner ignores new jobs
`project_id` Required	Integer	ID of the project to create the runner in. Required if `runner_type` is `project_type` Example: `1`
`run_untagged`	Boolean	Specifies if the runner should handle untagged jobs Default: `true`
`runner_type` Required	String	Scope of the runner Allowed values: `instance_type`, `group_type`, `project_type` Minimum length: `1`
`tag_list`	Array of strings	Comma-separated list of runner tags

Responses

Code	Description	Schema
`201`	Created	APIEntitiesCiRunnerRegistrationDetails
`400`	Bad Request	—
`403`	Forbidden	—

Retrieve your user status

GET /api/v4/user/status

Retrieves your user status.

Responses

Code	Description	Schema
`200`	OK	APIEntitiesUserStatus
`401`	Unauthorized	—
`403`	Forbidden	—

Set a user status

PUT /api/v4/user/status

Sets the status of the currently authenticated user. Any parameters that are not passed are nullified. This operation is similar but distinct from the Update a user status operation.

Request body (application/json)

Property	Type	Description
`availability`	String	Availability of the user. Possible values are `busy` and `not_set`
`clear_status_after`	String	Time after which the status is cleared automatically Allowed values: `30_minutes`, `3_hours`, `8_hours`, `1_day`, `3_days`, `7_days`, `30_days`
`emoji`	String	Name of the emoji to use as a status. If omitted, `speech_balloon` is used. Must be one of the names in the Gemojione index
`message`	String	Message to set as a status. Can contain emoji codes. Maximum of 100 characters

Responses

Code	Description	Schema
`200`	OK	APIEntitiesUserStatus
`400`	Bad Request	—

Update a user status

PATCH /api/v4/user/status

Sets the status of the currently authenticated user. Any parameters that are not passed are ignored. This operation is similar but distinct from the Set a user status operation.

Request body (application/json)

Property	Type	Description
`availability`	String	Availability of the user. Possible values are `busy` and `not_set`
`clear_status_after`	String	Time after which the status is cleared automatically Allowed values: `30_minutes`, `3_hours`, `8_hours`, `1_day`, `3_days`, `7_days`, `30_days`
`emoji`	String	Name of the emoji to use as a status. If omitted, `speech_balloon` is used. Must be one of the names in the Gemojione index
`message`	String	Message to set as a status. Can contain emoji codes. Maximum of 100 characters

Responses

Code	Description	Schema
`200`	OK	APIEntitiesUserStatus
`400`	Bad Request	—

Retrieve Support PIN

GET /api/v4/user/support_pin

Retrieves a Support PIN for the currently authenticated user. GitLab Support may ask for this PIN to validate your identity.

Responses

Code	Description	Schema
`200`	OK	APIEntitiesUserSupportPin
`401`	Unauthorized	—
`403`	Forbidden	—
`404`	Not Found	—

Create a Support PIN

POST /api/v4/user/support_pin

Creates a Support PIN. The PIN expires seven days after creation. GitLab Support may ask for this PIN to validate your identity.

Responses

Code	Description	Schema
`201`	Created	APIEntitiesUserSupportPin
`400`	Bad Request	—

Update a user’s credit_card_validation (deprecated)

PUT /api/v4/user/{user_id}/credit_card_validation

Deprecated in 17.7

Parameters

Name	Type	Description
`user_id` Path, required	String	ID or username of the user

Request body (application/json)

Property	Type	Description
`credit_card_expiration_month` Required	Integer	Month the credit card expires
`credit_card_expiration_year` Required	Integer	Year the credit card expires
`credit_card_holder_name` Required	String	Name of the credit card holder
`credit_card_mask_number` Required	String	Last 4 digits of the credit card number
`credit_card_type` Required	String	Name of the credit card network
`credit_card_validated_at` Required	String (date-time)	Time when the user’s credit card was validated
`stripe_card_fingerprint`	String	Stripe credit card fingerprint
`stripe_payment_method_xid`	String	ID of the Stripe payment method
`stripe_setup_intent_xid`	String	ID of the Stripe setup intent
`zuora_payment_method_xid`	String	ID of the Zuora payment method

Responses

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

Return the user specific counts

GET /api/v4/user_counts

Assigned open issues, assigned MRs and pending todos count

Responses

Code	Description	Schema
`200`	OK	APIEntitiesUserCounts
`401`	Unauthorized	—

List all users

GET /api/v4/users

Lists all users on the instance. This endpoint supports keyset pagination. In GitLab 17.0 and later, keyset pagination is used by default.

Parameters

Name	Type	Description
`username` Query	String	Return a single user with the specified username
`extern_uid` Query	String	Return a single user with the specified external authentication provider UID. Use with `provider`. Administrators only. All or none of `extern_uid`, `provider` must be provided
`public_email` Query	String	Return a single user with the specified public email
`provider` Query	String	Name of the external authentication provider. All or none of `extern_uid`, `provider` must be provided
`search` Query	String	Search for users by name, username, or public email
`active` Query	Boolean	If `true`, returns only active users Default: `false`
`humans` Query	Boolean	If `true`, returns only regular users that are not bot or internal users Default: `false`
`external` Query	Boolean	If `true`, returns only external users Default: `false`
`blocked` Query	Boolean	If `true`, returns only blocked users Default: `false`
`created_after` Query	String (date-time)	Return users created on or after the specified time
`created_before` Query	String (date-time)	Return users created on or before the specified time
`without_projects` Query	Boolean	If `true`, returns only users that do not have any projects Default: `false`
`without_project_bots` Query	Boolean	If `true`, excludes project bot users from the results Default: `false`
`admins` Query	Boolean	If `true`, returns only administrators Default: `false`
`two_factor` Query	String	Filter users by Two-factor authentication
`exclude_active` Query	Boolean	If `true`, returns only users that are not active Default: `false`
`exclude_external` Query	Boolean	If `true`, returns only users that are not external Default: `false`
`exclude_humans` Query	Boolean	If `true`, returns only bot or internal users Default: `false`
`exclude_internal` Query	Boolean	If `true`, returns only users that are not internal Default: `false`
`order_by` Query	String	Sort results by the specified field Allowed values: `id`, `name`, `username`, `created_at`, `updated_at`
`sort` Query	String	Sort results in ascending or descending order Allowed values: `asc`, `desc`
`page` Query	Integer	Page number of results to retrieve Default: `1` Example: `1`
`per_page` Query	Integer	Number of items to list per page Default: `20` Example: `20`
`with_custom_attributes` Query	Boolean	If `true`, includes custom attributes in the response. Administrators only Default: `false`
`custom_attributes` Query	Object	Filter by custom attributes that match all of the specified key and value pairs. Administrators only

Responses

Code	Description	Schema
`200`	OK	Array of APIEntitiesUserBasic
`400`	Bad Request	—

Create a user

POST /api/v4/users

Creates a user. Administrators only.

Request body (multipart/form-data)

Property	Type	Description
`admin`	Boolean	Flag indicating the user is an administrator
`avatar`	String (binary)	Avatar image for user
`bio`	String	The biography of the user
`can_create_group`	Boolean	Flag indicating the user can create groups
`color_scheme_id`	Integer	The color scheme for the file viewer
`commit_email`	String	The commit email, _private for private commit email
`discord`	String	The Discord user ID
`email` Required	String	Email address to add to the user account
`extern_uid`	String	The external authentication provider UID. All or none of `extern_uid`, `provider` must be provided
`external`	Boolean	Flag indicating the user is an external user
`force_random_password`	Boolean	Flag indicating a random password will be set. At least one of `password`, `reset_password`, `force_random_password` must be provided
`github`	String	The GitHub username
`linkedin`	String	The LinkedIn username
`location`	String	The location of the user
`name` Required	String	The name of the user
`note`	String	Admin note for this user
`organization`	String	The organization of the user. Empty string or nil clears the field
`password`	String	The password of the new user. At least one of `password`, `reset_password`, `force_random_password` must be provided
`policy_advanced_editor`	Boolean	Flag indicating that advanced editor is enabled
`private_profile`	Boolean	Flag indicating the user has a private profile
`projects_limit`	Integer	The number of projects a user can create
`pronouns`	String	The pronouns of the user
`provider`	String	Name of the external authentication provider. All or none of `extern_uid`, `provider` must be provided
`public_email`	String	The public email of the user
`reset_password`	Boolean	Flag indicating the user will be sent a password reset token. At least one of `password`, `reset_password`, `force_random_password` must be provided
`skip_confirmation`	Boolean	Flag indicating the account is confirmed
`theme_id`	Integer	The GitLab theme for the user
`twitter`	String	The Twitter username
`username` Required	String	The username of the user
`view_diffs_file_by_file`	Boolean	If `true`, the user sees only one file diff per page
`website_url`	String	The website of the user

Responses

Code	Description	Schema
`201`	Created	APIEntitiesUserWithAdmin
`400`	Bad Request	—

Retrieve a user as a regular user

GET /api/v4/users/{id}

Retrieves a specified user as a regular user.

Parameters

Name	Type	Description
`id` Path, required	Integer	ID of the user
`with_custom_attributes` Query	Boolean	If `true`, includes custom attributes in the response. Administrators only Default: `false`
`custom_attributes` Query	Object	Filter by custom attributes that match all of the specified key and value pairs. Administrators only

Responses

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

Update a user

PUT /api/v4/users/{id}

Updates the details of a specified user.

Parameters

Name	Type	Description
`id` Path, required	Integer	ID of the user

Request body (multipart/form-data)

Property	Type	Description
`admin`	Boolean	Flag indicating the user is an administrator
`avatar`	String (binary)	Avatar image for user
`bio`	String	The biography of the user
`can_create_group`	Boolean	Flag indicating the user can create groups
`color_scheme_id`	Integer	The color scheme for the file viewer
`commit_email`	String	The commit email, _private for private commit email
`discord`	String	The Discord user ID
`email`	String	Email address to add to the user account
`extern_uid`	String	The external authentication provider UID. All or none of `extern_uid`, `provider` must be provided
`external`	Boolean	Flag indicating the user is an external user
`github`	String	The GitHub username
`linkedin`	String	The LinkedIn username
`location`	String	The location of the user
`name`	String	The name of the user
`note`	String	Admin note for this user
`organization`	String	The organization of the user. Empty string or nil clears the field
`password`	String	The password of the new user
`policy_advanced_editor`	Boolean	Flag indicating that advanced editor is enabled
`private_profile`	Boolean	Flag indicating the user has a private profile
`projects_limit`	Integer	The number of projects a user can create
`pronouns`	String	The pronouns of the user
`provider`	String	Name of the external authentication provider. All or none of `extern_uid`, `provider` must be provided
`public_email`	String	The public email of the user
`skip_reconfirmation`	Boolean	Flag indicating the account skips the confirmation by email
`theme_id`	Integer	The GitLab theme for the user
`twitter`	String	The Twitter username
`username`	String	The username of the user
`view_diffs_file_by_file`	Boolean	If `true`, the user sees only one file diff per page
`website_url`	String	The website of the user

Responses

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

Delete a user

DELETE /api/v4/users/{id}

Deletes a user. Administrators only.

Parameters

Name	Type	Description
`id` Path, required	Integer	ID of the user
`hard_delete` Query	Boolean	If `true`, contributions that would usually be moved to a ghost user are deleted instead, along with groups owned solely by this user

Responses

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

Reactivate a user

POST /api/v4/users/{id}/activate

Reactivates a specified user account that was previously deactivated. Administrators only.

Parameters

Name	Type	Description
`id` Path, required	Integer	ID of the user

Responses

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

Approve access to a user

POST /api/v4/users/{id}/approve

Approves access to a specified user account that is pending approval. Administrators only.

Parameters

Name	Type	Description
`id` Path, required	Integer	ID of the user

Responses

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

Retrieve association counts for a user

GET /api/v4/users/{id}/associations_count

Retrieves the number of groups, projects, issues, and merge requests associated with a specified user.

Parameters

Name	Type	Description
`id` Path, required	Integer	ID of the user

Responses

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

Ban a user

POST /api/v4/users/{id}/ban

Bans a specified user account. Administrators only.

Parameters

Name	Type	Description
`id` Path, required	Integer	ID of the user

Responses

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

Block access to a user

POST /api/v4/users/{id}/block

Blocks a specified user account. Administrators only.

Parameters

Name	Type	Description
`id` Path, required	Integer	ID of the user

Responses

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

Deactivate a user

POST /api/v4/users/{id}/deactivate

Deactivates a specified user account. Administrators only.

Parameters

Name	Type	Description
`id` Path, required	Integer	ID of the user

Responses

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

Disable two-factor authentication for a user

PATCH /api/v4/users/{id}/disable_two_factor

Disables two-factor authentication for a specified user account. Administrators only.

Parameters

Name	Type	Description
`id` Path, required	Integer	ID of the user

Responses

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

List all email addresses for a user

GET /api/v4/users/{id}/emails

Lists all email addresses for a specified user account. Administrators only.

Parameters

Name	Type	Description
`id` Path, required	Integer	ID of the user
`page` Query	Integer	Page number of results to retrieve Default: `1` Example: `1`
`per_page` Query	Integer	Number of items to list per page Default: `20` Example: `20`

Responses

Code	Description	Schema
`200`	OK	Array of APIEntitiesEmail
`400`	Bad Request	—
`404`	Not Found	—

Add an email address for a user

POST /api/v4/users/{id}/emails

Adds an email address for a specified user account. Administrators only.

Parameters

Name	Type	Description
`id` Path, required	Integer	ID of the user

Request body (application/json)

Property	Type	Description
`email` Required	String	Email address to add to the user account
`skip_confirmation`	Boolean	If `true`, skips email confirmation and assumes the email is verified

Responses

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

Delete an email address for a user

DELETE /api/v4/users/{id}/emails/{email_id}

Deletes a specified email address for a user account. You cannot delete a primary email address. Administrators only.

Parameters

Name	Type	Description
`id` Path, required	Integer	ID of the user
`email_id` Path, required	Integer	ID of the email

Responses

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

Follow a user

POST /api/v4/users/{id}/follow

Follows a specified user account.

Parameters

Name	Type	Description
`id` Path, required	Integer	ID of the user

Responses

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

List all accounts that follow a user

GET /api/v4/users/{id}/followers

Lists all user accounts that follow a specified user.

Parameters

Name	Type	Description
`id` Path, required	Integer	ID of the user
`page` Query	Integer	Page number of results to retrieve Default: `1` Example: `1`
`per_page` Query	Integer	Number of items to list per page Default: `20` Example: `20`

Responses

Code	Description	Schema
`200`	OK	Array of APIEntitiesUserBasic
`400`	Bad Request	—
`404`	Not Found	—

List all accounts followed by a user

GET /api/v4/users/{id}/following

Lists all user accounts being followed by a specified user.

Parameters

Name	Type	Description
`id` Path, required	Integer	ID of the user
`page` Query	Integer	Page number of results to retrieve Default: `1` Example: `1`
`per_page` Query	Integer	Number of items to list per page Default: `20` Example: `20`

Responses

Code	Description	Schema
`200`	OK	Array of APIEntitiesUserBasic
`400`	Bad Request	—
`404`	Not Found	—

Delete authentication identity from a user

DELETE /api/v4/users/{id}/identities/{provider}

Deletes a user authentication identity using the provider name associated with that identity. Administrators only.

Parameters

Name	Type	Description
`id` Path, required	Integer	ID of the user
`provider` Path, required	String	Name of the external authentication provider

Responses

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

Reject access to a user

POST /api/v4/users/{id}/reject

Rejects access to a specified user account that is pending approval. Administrators only.

Parameters

Name	Type	Description
`id` Path, required	Integer	ID of the user

Responses

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

Retrieve a Support PIN for a user

GET /api/v4/users/{id}/support_pin

Retrieves a Support PIN for a specified user. GitLab Support may ask for this PIN to validate your identity. Administrators only.

Parameters

Name	Type	Description
`id` Path, required	Integer	ID of the user

Responses

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

Revoke a Support PIN for a user

POST /api/v4/users/{id}/support_pin/revoke

Revokes a Support PIN for a specified user. This immediately expires and removes the PIN. Administrators only.

Parameters

Name	Type	Description
`id` Path, required	Integer	ID of the user

Responses

Code	Description	Schema
`204`	No Content	—
`400`	Bad Request	—
`404`	Not Found	—

Unban a user

POST /api/v4/users/{id}/unban

Unbans a specified user account that was previously banned. Administrators only.

Parameters

Name	Type	Description
`id` Path, required	Integer	ID of the user

Responses

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

Unblock access to a user

POST /api/v4/users/{id}/unblock

Unblocks a specified user account that was previously blocked. Administrators only.

Parameters

Name	Type	Description
`id` Path, required	Integer	ID of the user

Responses

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

Unfollow a user

POST /api/v4/users/{id}/unfollow

Unfollows a specified user account.

Parameters

Name	Type	Description
`id` Path, required	Integer	ID of the user

Responses

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

List all project and group memberships for a user

GET /api/v4/users/{user_id}/memberships

Lists all project and group memberships for a specified user. Administrators only.

Parameters

Name	Type	Description
`user_id` Path, required	Integer	ID of the user
`type` Query	String	Filter memberships by type Allowed values: `Project`, `Namespace`
`page` Query	Integer	Page number of results to retrieve Default: `1` Example: `1`
`per_page` Query	Integer	Number of items to list per page Default: `20` Example: `20`

Responses

Code	Description	Schema
`200`	OK	Array of APIEntitiesMembership
`400`	Bad Request	—
`404`	Not Found	—

Retrieve the status of a user

GET /api/v4/users/{user_id}/status

Retrieves the status of a user. You can access this endpoint without authentication.

Parameters

Name	Type	Description
`user_id` Path, required	String	ID or username of the user

Responses

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

Schemas

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

APIEntitiesCiRunnerRegistrationDetails

Property	Type	Description
`id`	String	—
`token`	String	—
`token_expires_at`	String	—

APIEntitiesCustomAttribute

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

APIEntitiesEmail

Property	Type	Description
`confirmed_at`	String	—
`email`	String	—
`id`	String	—

APIEntitiesIdentity

Property	Type	Description
`extern_uid`	String	—
`provider`	String	—

APIEntitiesMembership

Property	Type	Description
`access_level`	String	—
`source_id`	String	—
`source_name`	String	—
`source_type`	String	—

APIEntitiesUser

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`
`bio`	String	—
`bot`	Boolean	—
`created_at`	String	—
`custom_attributes`	Array of APIEntitiesCustomAttribute	—
`discord`	String	—
`followers`	String	—
`following`	String	—
`github`	String	—
`id`	Integer (int64)	Example: `1`
`is_followed`	String	—
`job_title`	String	—
`linkedin`	String	—
`local_time`	String	—
`location`	String	—
`locked`	Boolean	—
`name`	String	Example: `Administrator`
`organization`	String	—
`pronouns`	String	—
`public_email`	String	Example: `john@example.com`
`state`	String	Example: `active`
`twitter`	String	—
`username`	String	Example: `admin`
`web_url`	String	Example: `https://gitlab.example.com/root`
`website_url`	String	—
`work_information`	String	—

APIEntitiesUserActivity

Property	Type	Description
`last_activity_at`	String	—
`last_activity_on`	String	—
`username`	String	—

APIEntitiesUserAssociationsCount

Property	Type	Description
`groups_count`	String	—
`issues_count`	String	—
`merge_requests_count`	String	—
`projects_count`	String	—

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`

APIEntitiesUserCounts

Property	Type	Description
`assigned_issues`	Integer	Example: `10`
`assigned_merge_requests`	Integer	Example: `10`
`merge_requests`	Integer	Example: `10`
`review_requested_merge_requests`	Integer	Example: `10`
`todos`	Integer	Example: `10`

APIEntitiesUserCreditCardValidations

Property	Type	Description
`credit_card_validated_at`	String	—
`user_id`	String	—

APIEntitiesUserPreferences

Property	Type	Description
`id`	String	—
`pass_user_identities_to_ci_jwt`	String	—
`policy_advanced_editor`	String	—
`show_whitespace_in_diffs`	String	—
`user_id`	String	—
`view_diffs_file_by_file`	String	—

APIEntitiesUserProfile

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`
`bio`	String	—
`bio_html`	String	Example: `My <em>bio</em>.`
`bot`	Boolean	—
`created_at`	String	—
`custom_attributes`	Array of APIEntitiesCustomAttribute	—
`discord`	String	—
`followers`	String	—
`following`	String	—
`github`	String	—
`id`	Integer (int64)	Example: `1`
`is_followed`	String	—
`job_title`	String	—
`linkedin`	String	—
`local_time`	String	—
`location`	String	—
`locked`	Boolean	—
`name`	String	Example: `Administrator`
`organization`	String	—
`pronouns`	String	—
`public_email`	String	Example: `john@example.com`
`state`	String	Example: `active`
`twitter`	String	—
`username`	String	Example: `admin`
`web_url`	String	Example: `https://gitlab.example.com/root`
`website_url`	String	—
`work_information`	String	—

APIEntitiesUserPublic

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`
`bio`	String	—
`bot`	Boolean	—
`can_create_group`	Boolean	Example: `true`
`can_create_project`	Boolean	Example: `true`
`color_scheme_id`	Integer	Example: `1`
`commit_email`	String	—
`confirmed_at`	String (date-time)	Example: `2015-09-03T07:24:01.670Z`
`created_at`	String	—
`current_sign_in_at`	String (date-time)	Example: `2015-09-03T07:24:01.670Z`
`custom_attributes`	Array of APIEntitiesCustomAttribute	—
`discord`	String	—
`email`	String	Example: `john@example.com`
`external`	Boolean	—
`followers`	String	—
`following`	String	—
`github`	String	—
`id`	Integer (int64)	Example: `1`
`identities`	APIEntitiesIdentity	—
`is_followed`	String	—
`job_title`	String	—
`last_activity_on`	String (date-time)	Example: `2015-09-03T07:24:01.670Z`
`last_sign_in_at`	String (date-time)	Example: `2015-09-03T07:24:01.670Z`
`linkedin`	String	—
`local_time`	String	—
`location`	String	—
`locked`	Boolean	—
`name`	String	Example: `Administrator`
`organization`	String	—
`preferred_language`	String	Example: `en`
`private_profile`	Boolean	Example: `false`
`projects_limit`	Integer	Example: `10`
`pronouns`	String	—
`public_email`	String	Example: `john@example.com`
`state`	String	Example: `active`
`theme_id`	Integer	Example: `2`
`twitter`	String	—
`two_factor_enabled`	Boolean	Example: `true`
`username`	String	Example: `admin`
`web_url`	String	Example: `https://gitlab.example.com/root`
`website_url`	String	—
`work_information`	String	—

APIEntitiesUserStatus

Property	Type	Description
`availability`	String	—
`clear_status_at`	String	—
`emoji`	String	—
`message`	String	—
`message_html`	String	—

APIEntitiesUserSupportPin

Property	Type	Description
`expires_at`	String (date-time)	The expiration time of the PIN
`pin`	String	The security PIN

APIEntitiesUserWithAdmin

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`
`bio`	String	—
`bot`	Boolean	—
`can_create_group`	Boolean	Example: `true`
`can_create_project`	Boolean	Example: `true`
`color_scheme_id`	Integer	Example: `1`
`commit_email`	String	—
`confirmed_at`	String (date-time)	Example: `2015-09-03T07:24:01.670Z`
`created_at`	String	—
`created_by`	APIEntitiesUserBasic	—
`current_sign_in_at`	String (date-time)	Example: `2015-09-03T07:24:01.670Z`
`custom_attributes`	Array of APIEntitiesCustomAttribute	—
`discord`	String	—
`email`	String	Example: `john@example.com`
`external`	Boolean	—
`followers`	String	—
`following`	String	—
`github`	String	—
`id`	Integer (int64)	Example: `1`
`identities`	APIEntitiesIdentity	—
`is_admin`	String	—
`is_followed`	String	—
`job_title`	String	—
`last_activity_on`	String (date-time)	Example: `2015-09-03T07:24:01.670Z`
`last_sign_in_at`	String (date-time)	Example: `2015-09-03T07:24:01.670Z`
`linkedin`	String	—
`local_time`	String	—
`location`	String	—
`locked`	Boolean	—
`name`	String	Example: `Administrator`
`namespace_id`	String	—
`note`	String	—
`organization`	String	—
`preferred_language`	String	Example: `en`
`private_profile`	Boolean	Example: `false`
`projects_limit`	Integer	Example: `10`
`pronouns`	String	—
`provisioned_by_project_id`	String	—
`public_email`	String	Example: `john@example.com`
`state`	String	Example: `active`
`theme_id`	Integer	Example: `2`
`twitter`	String	—
`two_factor_enabled`	Boolean	Example: `true`
`username`	String	Example: `admin`
`web_url`	String	Example: `https://gitlab.example.com/root`
`website_url`	String	—
`work_information`	String	—

Retrieve current user details

List all activity for a user

List all email addresses for a user

Add an email address

Retrieve details on an email address

Delete an email address

Retrieve your user preferences

Update your user preferences

Create a runner owned by currently authenticated user

Retrieve your user status

Set a user status

Update a user status

Retrieve Support PIN

Create a Support PIN

Update a user’s credit_card_validation (deprecated)

Return the user specific counts

List all users

Create a user

Retrieve a user as a regular user

Update a user

Delete a user

Reactivate a user

Approve access to a user

Retrieve association counts for a user

Ban a user

Block access to a user

Deactivate a user

Disable two-factor authentication for a user

List all email addresses for a user

Add an email address for a user

Delete an email address for a user

Follow a user

List all accounts that follow a user

List all accounts followed by a user

Delete authentication identity from a user

Reject access to a user

Retrieve a Support PIN for a user

Revoke a Support PIN for a user

Unban a user

Unblock access to a user

Unfollow a user

List all project and group memberships for a user

Retrieve the status of a user

Schemas

APIEntitiesCiRunnerRegistrationDetails

APIEntitiesCustomAttribute

APIEntitiesEmail

APIEntitiesIdentity

APIEntitiesMembership

APIEntitiesUser

APIEntitiesUserActivity

APIEntitiesUserAssociationsCount

APIEntitiesUserBasic

APIEntitiesUserCounts

APIEntitiesUserCreditCardValidations

APIEntitiesUserPreferences

APIEntitiesUserProfile

APIEntitiesUserPublic

APIEntitiesUserStatus

APIEntitiesUserSupportPin

APIEntitiesUserWithAdmin

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

Request partner program details

Request received

Error