Action domain

user

Every action this domain exposes through gitlab_execute_action, from the gitlab://tools manifest. Each entry folds out to its full upstream description and required parameters.

76 · actions14 · destructive37 · read-only

Counted with a Free-tier token against gitlab.com, which is the only host this endpoint talks to: to use it against a self-managed instance, run the server yourself — its documentation covers that. The catalog is scoped to the token that asks, so the count moves with both its tier and its permissions: higher tiers expose more actions, and administration domains only appear to tokens allowed to use them. That is why the figures differ elsewhere: the upstream project catalogues 1,006 actions across 162 domains, and 851 on the Free/CE surface, while this deployment publishes 747 because it is OAuth-only and acts with your token, so the administration domains a non-admin account cannot call never appear. All three describe the same catalog, counted from three vantage points.

Back to the server card

  1. user.activate

    Activate User

    Activate a deactivated user. Returns: confirmation with the user ID and action. See also: user.deactivate, user.unblock, user.get.

    Required parameters: user_id (integer)

  2. user.activities

    Get User Activitiesread-only

    List user activities (admin). Returns: username and last-activity date per user. See also: user.list, user.contribution_events, user.memberships.

    Required parameters: No required parameters

  3. user.add_email

    Add Email

    Add an email address to the authenticated user's account. Returns: the created email's ID, address, and confirmation timestamp. See also: user.get_email, user.delete_email, user.add_email_for_user.

    Required parameters: email (string)

  4. user.add_email_for_user

    Add Email For User

    Add an email address to a specific user's account (admin only). Returns: the created email's ID, address, and confirmation timestamp. See also: user.emails_for_user, user.delete_email_for_user, user.add_email.

    Required parameters: email (string), user_id (integer)

  5. user.add_gpg_key

    Add GPG Key

    Add a GPG key to the authenticated user's account. Returns: the created key's ID, armored public key, and creation timestamp. See also: user.gpg_keys, user.get_gpg_key, user.delete_gpg_key, user.add_gpg_key_for_user.

    Required parameters: key (string)

  6. user.add_gpg_key_for_user

    Add GPG Key For User

    Add a GPG key to a specific user's account (admin only). Returns: the created key's ID, armored public key, and creation timestamp. See also: user.gpg_keys_for_user, user.get_gpg_key_for_user, user.delete_gpg_key_for_user, user.add_gpg_key.

    Required parameters: key (string), user_id (integer)

  7. user.add_ssh_key

    Add SSH Key

    Add an SSH key to the current user. Returns: created key ID, title, usage type, and expiry. See also: user.ssh_keys, user.get_ssh_key, user.delete_ssh_key.

    Required parameters: key (string), title (string)

  8. user.add_ssh_key_for_user

    Add SSH Key For User

    Add an SSH key to a specific user. Returns: created key ID, title, usage type, and expiry. Requires admin token. See also: user.ssh_keys_for_user, user.get_ssh_key_for_user, user.delete_ssh_key_for_user.

    Required parameters: key (string), title (string), user_id (integer)

  9. user.approve

    Approve User

    Approve a pending user sign-up. Returns: confirmation with the user ID and action. See also: user.reject, user.get, user.list.

    Required parameters: user_id (integer)

  10. user.associations_count

    Get User Associations Countread-only

    Get a user's association counts. Returns: groups, projects, issues, and merge-requests counts. See also: user.get, user.memberships, user.delete.

    Required parameters: user_id (integer)

  11. user.avatar_get

    Get Avatarread-only

    Get the avatar URL for an email address. Returns: the resolved avatar URL for that email address. See also: user.me, user.get_status.

    Required parameters: email (string)

  12. user.ban

    Ban Userdestructive

    Ban a user. Returns: confirmation with the user ID and action. Reversible via gitlab_unban_user. See also: user.unban, user.block, user.get.

    Required parameters: user_id (integer)

  13. user.block

    Block Userdestructive

    Block a user from signing in. Returns: confirmation with the user ID and action. Reversible via gitlab_unblock_user. See also: user.unblock, user.ban, user.get.

    Required parameters: user_id (integer)

  14. user.contribution_events

    List User Contribution Eventsread-only

    List a user's contribution events. Returns: event entries with action, target type/title, project, and timestamp. See also: user.get, user.activities, user.associations_count.

    Required parameters: user_id (integer)

  15. user.create

    Create User

    Create a user account. Returns: created user identity and profile summary fields. See also: user.get, user.modify, user.block.

    Required parameters: email (string), name (string), username (string)

  16. user.create_current_user_pat

    Create Current User Pat

    Create a personal access token for the current user. Returns: token ID, the secret token, scopes, and expiry. See also: user.me, user.create_runner.

    Required parameters: name (string), scopes (array)

  17. user.create_impersonation_token

    Create Impersonation Token

    Create an impersonation token for a user with the given scopes and optional expiry. Returns: the new token's id, name, active flag, scopes, revoked flag, created_at, expires_at, and the secret token value (shown once). See also: user.list_impersonation_tokens, user.revoke_impersonation_token, user.create_personal_access_token.

    Required parameters: name (string), scopes (array), user_id (integer)

  18. user.create_personal_access_token

    Create Personal Access Token

    Create a personal access token for a user with the given scopes, optional description, and optional expiry. Returns: the new token's id, name, active flag, scopes, revoked flag, description, user_id, created_at, expires_at, and the secret token value (shown once). See also: user.create_impersonation_token, user.list_impersonation_tokens.

    Required parameters: name (string), scopes (array), user_id (integer)

  19. user.create_runner

    Create User Runner

    Create a runner linked to the current user. Returns: runner ID, authentication token, and token expiry. See also: user.me, user.create_current_user_pat.

    Required parameters: runner_type (string)

  20. user.create_service_account

    Create Service Account

    Create an instance-level service account. Returns: the created service account with ID, username, name, and email. Requires admin token. See also: user.list_service_accounts, user.update_service_account.

    Required parameters: No required parameters

  21. user.current

    User Currentread-only

    Get the current authenticated user. Returns: account ID, username, name, state, avatar URL, and profile metadata. See also: user.list, user.current_user_status, user.emails.

    Required parameters: No required parameters

  22. user.current_user_status

    Current User Statusread-only

    Get the current user's status. Returns: emoji, message, availability, and clear-status time. See also: user.set_status, user.get_status, user.me.

    Required parameters: No required parameters

  23. user.deactivate

    Deactivate Userdestructive

    Deactivate an active user. Returns: confirmation with the user ID and action. Reversible via gitlab_activate_user. See also: user.activate, user.block, user.get.

    Required parameters: user_id (integer)

  24. user.delete

    Delete Userdestructive

    Delete a user account. Returns: confirmation with the deleted user ID. Requires admin token. See also: user.get, user.block, user.associations_count.

    Required parameters: user_id (integer)

  25. user.delete_email

    Delete Emaildestructive

    Delete an email address from the authenticated user's account. Returns: a confirmation naming the deleted email ID. See also: user.get_email, user.add_email, user.delete_email_for_user.

    Required parameters: email_id (integer)

  26. user.delete_email_for_user

    Delete Email For Userdestructive

    Delete an email address from a specific user's account (admin only). Returns: a confirmation naming the deleted email ID. See also: user.emails_for_user, user.add_email_for_user, user.delete_email.

    Required parameters: email_id (integer), user_id (integer)

  27. user.delete_gpg_key

    Delete GPG Keydestructive

    Delete a GPG key from the authenticated user's account. Returns: a confirmation naming the deleted key ID. See also: user.gpg_keys, user.get_gpg_key, user.add_gpg_key, user.delete_gpg_key_for_user.

    Required parameters: key_id (integer)

  28. user.delete_gpg_key_for_user

    Delete GPG Key For Userdestructive

    Delete a GPG key from a specific user's account (admin only). Returns: a confirmation naming the deleted key ID. See also: user.gpg_keys_for_user, user.get_gpg_key_for_user, user.add_gpg_key_for_user, user.delete_gpg_key.

    Required parameters: key_id (integer), user_id (integer)

  29. user.delete_identity

    Delete User Identitydestructive

    Delete a user's external identity. Returns: confirmation with user ID and provider. Requires admin token. See also: user.get, user.modify.

    Required parameters: provider (string), user_id (integer)

  30. user.delete_ssh_key

    Delete SSH Keydestructive

    Delete one of the current user's SSH keys. Returns: confirmation with the deleted key ID. See also: user.ssh_keys, user.get_ssh_key, user.add_ssh_key.

    Required parameters: key_id (integer)

  31. user.delete_ssh_key_for_user

    Delete SSH Key For Userdestructive

    Delete a specific user's SSH key. Returns: confirmation with the deleted key ID. Requires admin token. See also: user.ssh_keys_for_user, user.get_ssh_key_for_user, user.add_ssh_key_for_user.

    Required parameters: key_id (integer), user_id (integer)

  32. user.disable_two_factor

    Disable Two Factordestructive

    Disable 2FA for a user. Returns: confirmation with the user ID and action. See also: user.get, user.modify.

    Required parameters: user_id (integer)

  33. user.emails

    List Emailsread-only

    List the current user's email addresses. Returns: email entries with ID, address, and confirmation time. See also: user.me, user.modify.

    Required parameters: No required parameters

  34. user.emails_for_user

    List Emails For Userread-only

    List all email addresses registered to a specific user account. Returns: each email's ID, address, and confirmation timestamp, with offset/keyset pagination support. See also: user.get_email, user.add_email_for_user, user.delete_email_for_user, user.get.

    Required parameters: No required parameters

  35. user.event_list_contributions

    User Contribution Event Listread-only

    List the current user's contribution events. Returns: each event with action_name, target type and IID, push_data, embedded note, author object, created timestamp, and pagination metadata. See also: user.event_list_project, user.get.

    Required parameters: No required parameters

  36. user.event_list_project

    Project Event Listread-only

    List a project's visible activity events. Returns: each event with action_name, target type and IID, push_data, embedded note with author, data (ref, commits, repository), author object, created timestamp, and pagination metadata. See also: user.event_list_contributions, project.get.

    Required parameters: project_id (string)

  37. user.get

    Get Userread-only

    Get one user by ID. Returns: detailed account profile metadata and status fields. See also: user.list, user.modify, user.delete.

    Required parameters: user_id (integer)

  38. user.get_email

    Get Emailread-only

    Get one email address from the authenticated user's account by ID. Returns: the email's ID, address, and confirmation timestamp. See also: user.add_email, user.delete_email, user.emails_for_user.

    Required parameters: No required parameters

  39. user.get_gpg_key

    Get GPG Keyread-only

    Get one GPG key from the authenticated user's account by ID. Returns: the key's ID, armored public key, and creation timestamp. See also: user.gpg_keys, user.add_gpg_key, user.delete_gpg_key.

    Required parameters: key_id (integer)

  40. user.get_gpg_key_for_user

    Get GPG Key For Userread-only

    Get one GPG key from a specific user's account by ID. Returns: the key's ID, armored public key, and creation timestamp. See also: user.gpg_keys_for_user, user.add_gpg_key_for_user, user.delete_gpg_key_for_user, user.get.

    Required parameters: key_id (integer), user_id (integer)

  41. user.get_impersonation_token

    Get Impersonation Tokenread-only

    Get a single impersonation token for a user by token id. Returns: the token's id, name, active flag, scopes, revoked flag, created_at, expires_at, and last_used_at. See also: user.list_impersonation_tokens, user.revoke_impersonation_token.

    Required parameters: token_id (integer), user_id (integer)

  42. user.get_ssh_key

    Get SSH Keyread-only

    Get one of the current user's SSH keys by ID. Returns: key ID, title, public key, usage type, and expiry. See also: user.ssh_keys, user.add_ssh_key, user.delete_ssh_key.

    Required parameters: key_id (integer)

  43. user.get_ssh_key_for_user

    Get SSH Key For Userread-only

    Get a specific user's SSH key by ID. Returns: key ID, title, public key, usage type, and expiry. See also: user.ssh_keys_for_user, user.add_ssh_key_for_user, user.delete_ssh_key_for_user.

    Required parameters: key_id (integer), user_id (integer)

  44. user.get_status

    Get User Statusread-only

    Get a user's status by ID. Returns: emoji, message, availability, and clear-status time. See also: user.current_user_status, user.set_status, user.get.

    Required parameters: user_id (integer)

  45. user.gpg_keys

    List GPG Keysread-only

    List the authenticated user's GPG keys. Returns: each key's ID, armored public key, and creation timestamp. See also: user.get_gpg_key, user.add_gpg_key, user.delete_gpg_key, user.gpg_keys_for_user.

    Required parameters: No required parameters

  46. user.gpg_keys_for_user

    List GPG Keys For Userread-only

    List a specific user's GPG keys. Returns: each key's ID, armored public key, and creation timestamp. See also: user.get_gpg_key_for_user, user.add_gpg_key_for_user, user.delete_gpg_key_for_user, user.get.

    Required parameters: user_id (integer)

  47. user.key_get_by_fingerprint

    Get Key By Fingerprintread-only

    Look up an SSH key or deploy key by fingerprint and return the owning user. Returns: the key ID, title, public key, creation time, and the owning user (ID, username, name). See also: user.get_ssh_key, user.ssh_keys, user.ssh_keys_for_user.

    Required parameters: fingerprint (string)

  48. user.key_get_with_user

    Get Key With Userread-only

    Look up an SSH key by its global ID and return the owning user. Returns: the key ID, title, public key, creation time, and the owning user (ID, username, name). See also: user.get_ssh_key, user.ssh_keys, user.ssh_keys_for_user.

    Required parameters: key_id (integer)

  49. user.list

    List Usersread-only

    List users with filtering and pagination support. Returns: user summaries including ID, username, name, state, and profile URLs. See also: user.get, user.me, user.create.

    Required parameters: No required parameters

  50. user.list_impersonation_tokens

    List Impersonation Tokensread-only

    List all impersonation tokens for a user. Returns: each token's id, name, active flag, scopes, revoked flag, created_at, expires_at, and last_used_at. See also: user.get_impersonation_token, user.create_impersonation_token, user.revoke_impersonation_token.

    Required parameters: user_id (integer)

  51. user.list_service_accounts

    List Service Accountsread-only

    List instance-level service accounts. Returns: service account summaries with ID, username, name, and email. Requires admin token. See also: user.create_service_account, user.update_service_account.

    Required parameters: No required parameters

  52. user.me

    User Currentalias of user.currentread-only

    Get the current authenticated user. Returns: account ID, username, name, state, avatar URL, and profile metadata. See also: user.list, user.current_user_status, user.emails.

    Required parameters: No required parameters

  53. user.memberships

    Get User Membershipsread-only

    List a user's memberships. Returns: source ID, name, type, and access level per membership. See also: user.get, user.associations_count, user.activities.

    Required parameters: user_id (integer)

  54. user.modify

    Modify User

    Modify an existing user. Returns: the updated user profile metadata. See also: user.get, user.create, user.delete.

    Required parameters: user_id (integer)

  55. user.namespace_exists

    Namespace Existsread-only

    Check whether a namespace path is taken. Returns: an exists flag and suggested alternative paths when the path is unavailable. See also: user.namespace_get, user.namespace_search.

    Required parameters: id (string)

  56. user.namespace_get

    Namespace Getread-only

    Get a single namespace by ID or path. Returns: the namespace with id, name, path, kind, full path, parent id, plan, trial state, and seat usage. See also: user.namespace_list, user.namespace_search.

    Required parameters: id (string)

  57. user.namespace_list

    Namespace Listread-only

    List namespaces visible to the authenticated user. Returns: matching namespaces with id, name, path, kind, plan, seat usage, and pagination metadata. See also: user.namespace_get, user.namespace_search, group.list.

    Required parameters: No required parameters

  58. user.notification_global_get

    Notification Global Getread-only

    Get the authenticated user's global notification settings. Returns: the global notification level, notification email, and the per-event flags (issue, merge request, pipeline, note, and epic events) when the level is custom. See also: user.notification_global_update, user.notification_project_get, user.notification_group_get.

    Required parameters: No required parameters

  59. user.notification_global_update

    Notification Global Update

    Update the authenticated user's global notification settings. Returns: the updated global notification level, notification email, and per-event flags. See also: user.notification_global_get, user.notification_project_update, user.notification_group_update.

    Required parameters: No required parameters

  60. user.notification_group_get

    Notification Group Getread-only

    Get the authenticated user's notification settings for a group. Returns: the group notification level, notification email, and per-event flags when the level is custom. See also: user.notification_group_update, user.notification_global_get, user.notification_project_get.

    Required parameters: group_id (string)

  61. user.notification_group_update

    Notification Group Update

    Update the authenticated user's notification settings for a group. Returns: the updated group notification level, notification email, and per-event flags. See also: user.notification_group_get, user.notification_global_update, user.notification_project_update.

    Required parameters: group_id (string)

  62. user.notification_project_get

    Notification Project Getread-only

    Get the authenticated user's notification settings for a project. Returns: the project notification level, notification email, and per-event flags when the level is custom. See also: user.notification_project_update, user.notification_global_get, user.notification_group_get.

    Required parameters: project_id (string)

  63. user.notification_project_update

    Notification Project Update

    Update the authenticated user's notification settings for a project. Returns: the updated project notification level, notification email, and per-event flags. See also: user.notification_project_get, user.notification_global_update, user.notification_group_update.

    Required parameters: project_id (string)

  64. user.reject

    Reject Userdestructive

    Reject a pending user sign-up. Returns: confirmation with the user ID and action. Permanently deletes the pending user. See also: user.approve, user.get, user.list.

    Required parameters: user_id (integer)

  65. user.revoke_impersonation_token

    Revoke Impersonation Tokendestructive

    Revoke an impersonation token for a user by token id. Returns: a confirmation naming the user_id and token_id with the revoked flag set. See also: user.list_impersonation_tokens, user.get_impersonation_token.

    Required parameters: token_id (integer), user_id (integer)

  66. user.set_status

    Set User Status

    Set the current user's status. Returns: the updated emoji, message, availability, and clear-status time. See also: user.current_user_status, user.get_status.

    Required parameters: No required parameters

  67. user.ssh_keys

    List SSH Keysread-only

    List the current user's SSH keys. Returns: key summaries with ID, title, fingerprint, usage type, and expiry. See also: user.get_ssh_key, user.add_ssh_key, user.delete_ssh_key.

    Required parameters: No required parameters

  68. user.ssh_keys_for_user

    List SSH Keys For Userread-only

    List a specific user's SSH keys. Returns: key summaries with ID, title, fingerprint, usage type, and expiry. See also: user.get_ssh_key_for_user, user.add_ssh_key_for_user, user.delete_ssh_key_for_user.

    Required parameters: user_id (integer)

  69. user.todo_list

    Todo Listread-only

    List the authenticated user's to-do items with optional filtering and pagination. Returns: to-do items with action, target object, project, author, state, and pagination metadata. See also: user.todo_mark_done, user.todo_mark_all_done.

    Required parameters: No required parameters

  70. user.todo_mark_all_done

    Todo Mark All Done

    Mark all pending to-do items as done. Returns: a confirmation that all items were cleared. See also: user.todo_list, user.todo_mark_done.

    Required parameters: No required parameters

  71. user.todo_mark_done

    Todo Mark Done

    Mark a single to-do item as done. Returns: a confirmation naming the to-do item ID. See also: user.todo_list, user.todo_mark_all_done.

    Required parameters: id (integer)

  72. user.unban

    Unban User

    Unban a previously banned user. Returns: confirmation with the user ID and action. See also: user.ban, user.unblock, user.get.

    Required parameters: user_id (integer)

  73. user.unblock

    Unblock User

    Unblock a previously blocked user. Returns: confirmation with the user ID and action. See also: user.block, user.activate, user.get.

    Required parameters: user_id (integer)

  74. user.update_service_account

    Update Instance Service Account

    Update an instance-level service account. Returns: updated service account object including email and unconfirmed_email. Requires admin token. See also: user.create_service_account, user.list_service_accounts.

    Required parameters: service_account_id (integer)

  75. user.upload_avatar

    Upload User Avatar

    Upload the current user's avatar. Returns: the updated user profile including the new avatar URL. GitLab 19 responds with only avatar_url, so other profile fields (including id) may be empty. Use gitlab_user_current for the full profile. Provide filename and exactly one of file_path or content_base64. See also: user.me, user.modify.

    Required parameters: filename (string)