---
title: "GET /api/v1/auth"
method: GET
path: "/api/v1/auth"
tags: ["Auth"]
---

# GET /api/v1/auth

`GET /api/v1/auth`

## Request

- Base URL: `https://api.immy.bot` (the document declares no server; this is the origin it was published from)
- URL: `https://api.immy.bot/api/v1/auth`
- Auth: none declared

## Response `200`

OK

- GetAuthResponse
  - `impersonating` boolean
  - `userId` integer
  - `tenantId` integer
  - `personId` integer, nullable
  - `displayName` string, nullable
  - `firstName` string, nullable
  - `lastName` string, nullable
  - `email` string, nullable
  - `tenantName` string, nullable
  - `isAdmin` boolean
  - `isMSP` boolean
  - `isImmense` boolean
  - `isSupportTechnician` boolean
  - `isImmySupportAccessEnabled` boolean
  - `devInstanceDetails` DevInstanceDetails
    - `backendVersion` string, nullable, required
    - `isHangfireServerRunning` boolean
    - `postRoutes` object, nullable
  - `localSoftwareEndpoint` string, nullable
  - `globalSoftwareEndpoint` string, nullable
  - `localPublicMediaContainerName` string, nullable
  - `globalPublicMediaContainerName` string, nullable
  - `backendRegAppId` string, nullable
  - `userLevelAuthSelected` boolean
  - `status` 'InTrial' | 'Active' | 'Inactive': The string or integer value may be used. InTrial = 0, Active = 1, Inactive = 2
  - `planId` string, nullable
  - `planPrice` integer, nullable
  - `planQuantity` integer, nullable
  - `addons` SubscriptionAddonDto[], nullable
    - `addonId` string, nullable
    - `quantity` integer, nullable
    - `price` integer, nullable
    - `trialEndUtc` string, date-time, nullable
  - `trialStartUtc` string, date-time, nullable
  - `trialEndUtc` string, date-time, nullable
  - `updateAvailable` boolean
  - `currentReleaseVersion` SemanticVersion
    - `major` integer
    - `minor` integer
    - `patch` integer
    - `releaseLabels` string[], nullable
    - `release` string, nullable
    - `isPrerelease` boolean
    - `hasMetadata` boolean
    - `metadata` string, nullable
  - `currentReleaseReleaseChannel` 'Developer' | 'Alpha' | 'Beta' | 'General': The string or integer value may be used. Developer = 1, Alpha = 2, Beta = 3, General = 4
  - `isInstanceUpdating` boolean
  - `isInstanceRestarting` boolean
  - `instanceUpdateHasFailed` boolean
  - `instanceUpdateSource` string, nullable
  - `maxRunningSessionCount` integer
  - `openAccessRequestCount` integer
  - `maximumTrackableComputers` integer, nullable
  - `canManageCrossTenantDeployments` boolean
  - `immyProduct` string, nullable
  - `features` Feature[], nullable
    - `enabled` boolean, required
    - `name` string, nullable, required
  - `instanceReleaseChannel` 'Developer' | 'Alpha' | 'Beta' | 'General': The string or integer value may be used. Developer = 1, Alpha = 2, Beta = 3, General = 4
  - `daysLeftInTrial` integer, nullable
  - `claims` ClaimResponse[], nullable
    - `type` string, nullable: The type of the claim
    - `value` string, nullable: The value of the claim

---

[API](https://skmtc.dev/immy/apis/immy-bot-api.md) · [All operations](https://skmtc.dev/immy/apis/immy-bot-api/llms.txt) · [OpenAPI document](https://skmtc.dev/immy/apis/immy-bot-api/revisions/559d0e4b39d3?raw)