---
title: "Get tenant information"
method: GET
path: "/v1/tenants/{tenantId}"
tags: ["Tenants"]
---

# Get tenant information

`GET /v1/tenants/{tenantId}`

## Request

- Base URL: `https://api.tetrascience.com`
- URL: `https://api.tetrascience.com/v1/tenants/{tenantId}`
- Auth: API key in header `ts-auth-token` and API key in header `x-org-slug`

Get tenant by ID, needs to be org or system admin.

## Path parameters

- `tenantId` Id, required (unresolved $ref)

## Response `200`

Successful

- object: Tenant response for service-to-service callers and connector editors. Identical to `tenant` but also exposes the CloudFormation-managed networking security groups, which the id-based read and update return to internal callers (e.g. the instance-manager) and to users who may deploy connectors or data apps (ts-admin, or orgAdmin, tenantAdmin, developer, dataOwner or analyst in the scoped org — data-acquisition reads them with the deploying user's JWT), but strip for everyone else. Cognito credentials are never included here — only `createTenantResponse` returns those.
  - `id` Id (unresolved $ref)
  - `name` string
  - `subdomain` string
  - `disclaimer` string
  - `features` object
  - `settings` object
    - `ssoEnabled` boolean
    - `defaultIdp` string
    - `ssoDomain` string
    - `ssoRedirectUri` string
    - `authTokenExpiration` string: Value in a minute. Default=240. min=1, max=720
    - `refreshTokenExpiration` string: Value in a minute. Default=720. min=1, max=720
    - `idleTimeout` string: Value in a minute. Default=60. min=1, max=720
    - `resetPassword` string
    - `passwordComplexity` string
    - `passwordExpiryDays` integer
    - `passwordExpiry` boolean
    - `accountLock` boolean
    - `maxFailedLogins` integer
    - `noPasswordReuse` boolean
    - `idpConfigs` union[]
      - union
        - object
          - `ssoMetadataUrl` string, required
          - `ssoMetadataXml` string
          - `ssoProvider` string, required
          - `ssoEmailFieldMapping` string, required
          - `ssoFirstNameFieldMapping` string, required
          - `ssoLastNameFieldMapping` string, required
          - `ssoGroupsFieldMapping` string, required
        - object
          - `ssoMetadataUrl` string
          - `ssoMetadataXml` string, required
          - `ssoProvider` string, required
          - `ssoEmailFieldMapping` string, required
          - `ssoFirstNameFieldMapping` string, required
          - `ssoLastNameFieldMapping` string, required
          - `ssoGroupsFieldMapping` string, required
    - `outboundNetworkingSecurityGroup` string
    - `secondaryNetworkingSecurityGroup` string

## Other responses

- `401`: Invalid token
- `403`: Caller is not authorized to perform this action

---

[API](https://skmtc.dev/tetrascience/apis/administration.md) - [All operations](https://skmtc.dev/tetrascience/apis/administration/llms.txt) - [OpenAPI document](https://skmtc.dev/tetrascience/apis/administration/revisions/c1c829febcc5?raw)