---
title: "Return the current identity"
method: GET
path: "/current-identity"
tags: ["Current Identity"]
---

# Return the current identity

`GET /current-identity`

## Request

- Base URL: `https://demo.ziti.dev/edge/client/v1`
- URL: `https://demo.ziti.dev/edge/client/v1/current-identity`
- Auth: one of:
  - API key in header `zt-session`
  - OAuth 2
    - Authorization code: `/oidc/authorize`
    - Token URL: `/oidc/token` scopes: `openid`
- TypeScript: <https://skmtc.dev/openziti/apis/ziti-edge-client/docs/current-identity/get.ts> (a function with typed inputs; its response is checked against the schema)

Returns the identity associated with the API sessions used to issue the current request

## Response `200`

The identity associated with the API Session used to issue the request

- CurrentIdentityDetailEnvelope
  - `data` IdentityDetail, required: Detail of a specific identity
    - `_links` object, required: A map of named links
    - `createdAt` string, date-time, required
    - `id` string, required
    - `tags` Tags
    - `updatedAt` string, date-time, required
    - `appData` Tags
    - `authPolicy` EntityRef, required: A reference to another resource and links to interact with it
      - `_links` object: A map of named links
      - `entity` string
      - `id` string
      - `name` string
    - `authPolicyId` string, required
    - `authenticators` IdentityAuthenticators, required
      - `cert` IdentityAuthenticatorsCert
        - `fingerprint` string
        - `id` string
      - `updb` IdentityAuthenticatorsUpdb
        - `id` string
        - `username` string
    - `defaultHostingCost` integer, required
    - `defaultHostingPrecedence` 'default' | 'required' | 'failed'
    - `disabled` boolean, required
    - `disabledAt` string, date-time, nullable
    - `disabledUntil` string, date-time, nullable
    - `edgeRouterConnectionStatus` 'online' | 'offline' | 'unknown', required
    - `enrollment` IdentityEnrollments, required
      - `ott` IdentityEnrollmentsOtt
        - `expiresAt` string, date-time
        - `id` string
        - `jwt` string
        - `token` string
      - `ottca` IdentityEnrollmentsOttca
        - `ca` EntityRef: A reference to another resource and links to interact with it
          - `_links` object: A map of named links
          - `entity` string
          - `id` string
          - `name` string
        - `caId` string
        - `expiresAt` string, date-time
        - `id` string
        - `jwt` string
        - `token` string
      - `updb` IdentityEnrollmentsOtt
        - `expiresAt` string, date-time
        - `id` string
        - `jwt` string
        - `token` string
    - `envInfo` EnvInfo, required: Environment information an authenticating client may provide
      - `arch` string
      - `domain` string
      - `hostname` string
      - `os` string
      - `osRelease` string
      - `osVersion` string
    - `externalId` string, nullable, required
    - `hasApiSession` boolean, required
    - `hasEdgeRouterConnection` boolean, required
    - `interfaces` Interface[]
      - `addresses` string[]
      - `hardwareAddress` string, required
      - `index` integer, required
      - `isBroadcast` boolean, required
      - `isLoopback` boolean, required
      - `isMulticast` boolean, required
      - `isRunning` boolean, required
      - `isUp` boolean, required
      - `mtu` integer, required
      - `name` string, required
    - `isAdmin` boolean, required
    - `isDefaultAdmin` boolean, required
    - `isMfaEnabled` boolean, required
    - `name` string, required
    - `permissions` string[], nullable, required: A set of strings used to define which types of resources this resource can acccess
    - `roleAttributes` string[], nullable, required: A set of strings used to loosely couple this resource to policies
    - `sdkInfo` SdkInfo, required: SDK information an authenticating client may provide
      - `appId` string
      - `appVersion` string
      - `branch` string
      - `revision` string
      - `type` string
      - `version` string
    - `serviceHostingCosts` TerminatorCostMap, required
    - `serviceHostingPrecedences` TerminatorPrecedenceMap, required
    - `type` EntityRef, required: A reference to another resource and links to interact with it
      - `_links` object: A map of named links
      - `entity` string
      - `id` string
      - `name` string
    - `typeId` string, required
  - `meta` Meta, required
    - `apiEnrollmentVersion` string
    - `apiVersion` string
    - `filterableFields` string[]
    - `pagination` Pagination
      - `limit` number, required
      - `offset` number, required
      - `totalCount` number, required

## Other responses

- `401`: The supplied session does not have the correct access rights to request this resource

## Changes

- **2026-10-14** `f7b51eaafbbb`: 2 breaking
  - the response property `data/allOf[#/components/schemas/baseEntity]/tags` became nullable for the status `200`
  - the response property `data/allOf[subschema #2]/appData` became nullable for the status `200`
- **2026-02-17** `18b6876f3a73`: 1 info
  - added the required property `data/allOf[subschema #2]/permissions` to the response with the `200` status
- **2025-11-04** `e8b8c6cc7e72`: 1 info
  - added the optional property `data/allOf[subschema #2]/interfaces` to the response with the `200` status
- **2025-01-24** `19dfd92f02a2`: 1 info
  - added the required property `data/allOf[subschema #2]/edgeRouterConnectionStatus` to the response with the `200` status
- **2024-05-29** `cce2800c1357`: 2 breaking, 3 warning
  - removed the required property `data/allOf[subschema #2]/edgeRouterConnectionStatus` from the response with the `200` status
  - removed the required property `data/allOf[subschema #2]/permissions` from the response with the `200` status
  - the optional response header `WWW-Authenticate` removed for the status `200`
  - the optional response header `WWW-Authenticate` removed for the status `401`
  - …1 more

[Operation history](https://skmtc.dev/openziti/apis/ziti-edge-client/changes/current-identity/get.md)

---

[API](https://skmtc.dev/openziti/apis/ziti-edge-client.md) - [All operations](https://skmtc.dev/openziti/apis/ziti-edge-client/llms.txt) - [OpenAPI document](https://skmtc.dev/openziti/apis/ziti-edge-client/revisions/f7b51eaafbbb?raw)