Skip to main content

user

Overview

Nameuser
TypeResource
Idvercel.user.user

Fields

NameDatatypeDescription
idstringThe User's unique identifier.
namestringName associated with the User account, or null if none has been provided.
AuthUserLimited_avatarstringSHA1 hash of the avatar for the User account. Can be used in conjuction with the ... endpoint to retrieve the avatar image.
AuthUserLimited_emailstringEmail address associated with the User account.
AuthUserLimited_idstringThe User's unique identifier.
AuthUserLimited_namestringName associated with the User account, or null if none has been provided.
AuthUserLimited_usernamestringUnique username associated with the User account.
AuthUserLimited_versionstringThe user's version. Will either be unset or northstar.
activeDashboardViewsarrayset of dashboard view preferences (cards or list) per scopeId
avatarstringSHA1 hash of the avatar for the User account. Can be used in conjuction with the ... endpoint to retrieve the avatar image.
billingobjectAn object containing billing infomation associated with the User account.
createdAtnumberUNIX timestamp (in milliseconds) when the User account was created.
dataCacheobjectdata cache settings
defaultTeamIdstringThe user's default team. Only applies if the user's version is 'northstar'.
dismissedToastsarrayA record of when, under a certain scopeId, a toast was dismissed
emailstringEmail address associated with the User account.
favoriteProjectsAndSpacesarrayA list of projects and spaces across teams that a user has marked as a favorite.
featureBlocksobjectFeature blocks for the user
hasTrialAvailablebooleanWhether the user has a trial available for a paid plan subscription.
importFlowGitNamespace``
importFlowGitNamespaceId``
importFlowGitProviderstring
limitedbooleanProperty indicating that this User data contains only limited information, due to the authentication token missing privileges to read the full User data. Re-login with email, GitHub, GitLab or Bitbucket in order to upgrade the authentication token with the necessary privileges.
preferredScopesAndGitNamespacesarray
remoteCachingobjectremote caching settings
resourceConfigobjectAn object containing infomation related to the amount of platform resources may be allocated to the User account.
softBlockobjectWhen the User account has been "soft blocked", this property will contain the date when the restriction was enacted, and the identifier for why.
stagingPrefixstringPrefix that will be used in the URL of "Preview" deployments created by the User account.
usernamestringUnique username associated with the User account.
versionstringThe user's version. Will either be unset or northstar.

Methods

NameAccessible byRequired ParamsDescription
get_auth_userSELECTRetrieves information related to the currently authenticated User.
request_deleteDELETEInitiates the deletion process for the currently authenticated User, by sending a deletion confirmation email. The email contains a link that the user needs to visit in order to proceed with the deletion process.
_get_auth_userEXECRetrieves information related to the currently authenticated User.