LogoGitpod API Reference

Users

users

Methods

Get Authenticated User -> { user }
post/gitpod.v1.UserService/GetAuthenticatedUser

Gets information about the currently authenticated user.

Use this method to:

  • Get user profile information
  • Check authentication status
  • Retrieve user settings
  • Verify account details

Examples

  • Get current user:

    Retrieves details about the authenticated user.

    {}
Set Suspended -> unknown
post/gitpod.v1.UserService/SetSuspended

Sets whether a user account is suspended.

Use this method to:

  • Suspend problematic users
  • Reactivate suspended accounts
  • Manage user access

Examples

  • Suspend user:

    Suspends a user account.

    userId: "f53d2330-3795-4c5d-a1f3-453121af9c60"
suspended: true

  • Reactivate user:

    Removes suspension from a user account.

    userId: "f53d2330-3795-4c5d-a1f3-453121af9c60"
suspended: false

Domain types

User = { id, avatarUrl, createdAt, 3 more... }
Users

Dotfiles

users.dotfiles

Methods

Get Dotfiles Configuration -> { dotfilesConfiguration }
post/gitpod.v1.UserService/GetDotfilesConfiguration

Gets the dotfiles for a user.

Use this method to:

  • Retrieve user dotfiles

Examples

  • Get dotfiles:

    Retrieves the dotfiles for the current user.

    {}
Set Dotfiles Configuration -> unknown
post/gitpod.v1.UserService/SetDotfilesConfiguration

Sets the dotfiles configuration for a user.

Use this method to:

  • Configure user dotfiles
  • Update dotfiles settings

Examples

  • Set dotfiles configuration:

    Sets the dotfiles configuration for the current user.

    {
  "repository": "https://github.com/gitpod-io/dotfiles",
}

  • Remove dotfiles:

    Removes the dotfiles for the current user.

    {}

Domain types

DotfilesConfiguration = { repository }
Users

Pats

users.pats

Methods

Delete Personal Access Token -> unknown
post/gitpod.v1.UserService/DeletePersonalAccessToken

Deletes a personal access token.

Use this method to:

  • Revoke token access
  • Remove unused tokens
  • Rotate credentials

Examples

  • Delete token:

    Permanently revokes a token.

    personalAccessTokenId: "d2c94c27-3b76-4a42-b88c-95a85e392c68"
Get Personal Access Token -> { pat }
post/gitpod.v1.UserService/GetPersonalAccessToken

Gets details about a specific personal access token.

Use this method to:

  • View token metadata
  • Check token expiration
  • Monitor token usage

Examples

  • Get token details:

    Retrieves information about a specific token.

    personalAccessTokenId: "d2c94c27-3b76-4a42-b88c-95a85e392c68"
List Personal Access Tokens -> PersonalAccessTokensPage<
PersonalAccessToken
>
post/gitpod.v1.UserService/ListPersonalAccessTokens

Lists personal access tokens with optional filtering.

Use this method to:

  • View all active tokens
  • Audit token usage
  • Manage token lifecycle

Examples

  • List user tokens:

    Shows all tokens for specific users.

    filter:
  userIds: ["f53d2330-3795-4c5d-a1f3-453121af9c60"]
pagination:
  pageSize: 20

Domain types

PersonalAccessToken = { id, createdAt, creator, 4 more... }