Get current user

Get the user associated with this service token

Authorization

A OAuth token must have at least one of the following scopes in order to use this API endpoint:

OAuth Scopes

Resource	Scopes
User	read_user

GET /user

Get current user

cURL

curl --request GET \
  --url https://api.planetscale.com/v1/user \
  --header 'Authorization: Bearer <token>'

200

{
  "id": "<string>",
  "display_name": "<string>",
  "name": "<string>",
  "email": "<string>",
  "avatar_url": "<string>",
  "created_at": "<string>",
  "updated_at": "<string>",
  "two_factor_auth_configured": true,
  "default_organization": {
    "id": "<string>",
    "name": "<string>",
    "created_at": "<string>",
    "updated_at": "<string>",
    "deleted_at": "<string>"
  },
  "sso": true,
  "managed": true,
  "directory_managed": true,
  "email_verified": true
}

Authorizations

Authorization · string · header · required

The access token received from the authorization server in the OAuth 2.0 flow.

Response

200

application/json

Returns the user associated with this service token

id · string · required

The ID of the user

display_name · string · required

The display name of the user

name · string · required

The name of the user

email · string · required

The email of the user

avatar_url · string · required

The URL source of the user's avatar

created_at · string · required

When the user was created

updated_at · string · required

When the user was last updated

two_factor_auth_configured · boolean · required

Whether or not the user has configured two factor authentication

default_organization · object · required

Show child attributes

sso · boolean · required

Whether or not the user is managed by SSO

managed · boolean · required

Whether or not the user is managed by an authentication provider

directory_managed · boolean · required

Whether or not the user is managed by a SSO directory

email_verified · boolean · required

Whether or not the user is verified by email