---
title: "Current Identity"
method: GET
path: "/v1/identity"
tags: ["v1"]
---

# Current Identity

`GET /v1/identity`

## Request

- Base URL: `https://api.ellipsis.dev`
- URL: `https://api.ellipsis.dev/v1/identity`
- Auth: HTTP bearer

Return the identity behind the caller's credential.

Any valid credential may call this; no permission grant is needed.

## Headers

- `user-agent` string, nullable

## Response `200`

Successful Response

- Identity: The identity behind the caller's credential.
  - `api_key_id` string, nullable, required: The API key id, when the credential is an API key.
  - `customer_id` string, required: The caller's account id.
  - `customer_login` string, required: The caller's account login (a GitHub org or user login).
  - `gh_user` GithubUser, required: This is a full user account. It's the most amount of info we need to represent a GitHub user. Represents both a public and private user.
    - `avatar_url` string, required
    - `bio` string, nullable
    - `blog` string, nullable
    - `business_plus` boolean, nullable
    - `collaborators` integer, nullable
    - `company` string, nullable
    - `created_at` string, date-time, nullable
    - `disk_usage` integer, nullable
    - `email` string, nullable
    - `events_url` string, required
    - `followers` integer, nullable
    - `followers_url` string, required
    - `following` integer, nullable
    - `following_url` string, required
    - `gists_url` string, required
    - `gravatar_id` string, nullable
    - `hireable` boolean, nullable
    - `html_url` string, required
    - `id` integer, required
    - `ldap_dn` string, nullable
    - `location` string, nullable
    - `login` string, required
    - `name` string, nullable
    - `node_id` string, required
    - `notification_email` string, nullable
    - `organizations_url` string, required
    - `owned_private_repos` integer, nullable
    - `plan` UserPlan
      - `collaborators` integer, required
      - `name` string, required
      - `private_repos` integer, required
      - `space` integer, required
    - `private_gists` integer, nullable
    - `public_gists` integer, nullable
    - `public_repos` integer, nullable
    - `received_events_url` string, required
    - `repos_url` string, required
    - `site_admin` boolean, required
    - `starred_url` string, required
    - `subscriptions_url` string, required
    - `total_private_repos` integer, nullable
    - `twitter_username` string, nullable
    - `two_factor_authentication` boolean, nullable
    - `type` 'User' | 'Organization' | 'Bot' | 'Mannequin'
    - `updated_at` string, date-time, nullable
    - `url` string, required
    - `user_view_type` string, nullable
  - `session_id` string, nullable, required: The session id, when the credential is a session token.
  - `user_id` string, nullable, required: The GitHub user id behind the credential, when it has one.

## Other responses

- `401`: The bearer token is missing, invalid, or revoked.
- `403`: The credential may not perform this action, or the account is blocked.
- `422`: Validation Error

---

[API](https://skmtc.dev/ellipsis/apis/ellipsis-rest-api.md) - [All operations](https://skmtc.dev/ellipsis/apis/ellipsis-rest-api/llms.txt) - [OpenAPI document](https://skmtc.dev/ellipsis/apis/ellipsis-rest-api/revisions/344b16df9a1a?raw)