Authentik

Authentik Tenants API

Multi-tenant administration for deployments running more than one authentik tenant.

GitHub OpenAPI
Business capability
Tenant Provisioning & Lifecycle BC-4230.10

Operations 14

Each operation below carries the questions people ask an LLM about it and the instructions they give an agent to run it. Generated by API Evangelist overlay

GET /tenants/domains/ List tenant domains · Tenants domains list #
Ask an LLM
“Which domains are mapped to tenants in my authentik install?”
“Can I search tenant domains by name?”
Tell an agent
List all tenant domains.
Search tenant domains for {search}.
POST /tenants/domains/ Add a domain to a tenant · Tenants domains create #
Ask an LLM
“How do I point a new domain at one of my tenants?”
“Can I mark a newly added domain as the tenant's primary one?”
Tell an agent
Add domain {domain} to tenant {tenant}.
Add {domain} as the primary domain for tenant {tenant}, primary = {is_primary}.
GET /tenants/domains/{id}/ Get a tenant domain · Tenants domains retrieve #
Ask an LLM
“Which tenant does a given domain record belong to?”
“Is a particular tenant domain set as primary?”
Tell an agent
Get tenant domain {id}.
Show the details of domain record {id}.
PUT /tenants/domains/{id}/ Replace a tenant domain · Tenants domains update #
Ask an LLM
“Can I fully rewrite an existing tenant domain record?”
“How do I move a domain record to another tenant by replacing it?”
Tell an agent
Replace domain record {id} with domain {domain} on tenant {tenant}.
Overwrite domain {id} so it is {domain} for tenant {tenant}.
PATCH /tenants/domains/{id}/ Edit fields on a tenant domain · Tenants domains partial update #
Ask an LLM
“Can I just flip which tenant domain is primary without resending everything?”
“Is it possible to rename only the hostname of a tenant domain?”
Tell an agent
Set is-primary to {is_primary} on tenant domain {id}.
Change only the hostname of domain record {id} to {domain}.
DELETE /tenants/domains/{id}/ Remove a tenant domain · Tenants domains destroy #
Ask an LLM
“Can I detach a domain from its tenant?”
“What removes a tenant domain record permanently?”
Tell an agent destructive · confirm first
Delete tenant domain {id}.
Remove domain record {id} from its tenant.
GET /tenants/tenants/ List tenants · Tenants tenants list #
Ask an LLM
“What tenants exist on my multi-tenant authentik deployment?”
“Can I search tenants by name?”
Tell an agent
List all tenants.
Find tenants matching {search}.
POST /tenants/tenants/ Create a tenant · Tenants tenants create #
Ask an LLM
“How do I spin up a new tenant with its own database schema?”
“What schema name and display name does a new tenant need?”
Tell an agent
Create tenant {name} with schema {schema_name}.
Provision a new tenant called {name} using schema name {schema_name}.
GET /tenants/tenants/{tenant_uuid}/ Get a tenant · Tenants tenants retrieve #
Ask an LLM
“Is a specific tenant ready to use yet?”
“Which schema does a given tenant run on?”
Tell an agent
Get tenant {tenant_uuid}.
Show whether tenant {tenant_uuid} is ready.
PUT /tenants/tenants/{tenant_uuid}/ Replace a tenant · Tenants tenants update #
Ask an LLM
“Can I overwrite a tenant's full definition, schema name included?”
“How do I resend every field of an existing tenant?”
Tell an agent
Replace tenant {tenant_uuid} with name {name} and schema {schema_name}.
Overwrite all fields of tenant {tenant_uuid}, naming it {name} on schema {schema_name}.
PATCH /tenants/tenants/{tenant_uuid}/ Rename or edit a tenant · Tenants tenants partial update #
Ask an LLM
“Can I rename a tenant without changing its schema?”
“Is there a way to mark just the ready flag on a tenant?”
Tell an agent
Rename tenant {tenant_uuid} to {name}.
Set ready to {ready} on tenant {tenant_uuid}.
DELETE /tenants/tenants/{tenant_uuid}/ Delete a tenant · Tenants tenants destroy #
Ask an LLM
“Can I permanently remove a tenant from the deployment?”
“What deletes a tenant I no longer need?”
Tell an agent destructive · confirm first
Delete tenant {tenant_uuid}.
Remove tenant {tenant_uuid} permanently.
POST /tenants/tenants/{tenant_uuid}/create_admin_group/ Create a tenant admin group with a user · Tenants tenants create admin group create #
Ask an LLM
“How do I give someone admin rights inside a new tenant?”
“Can I bootstrap a tenant's admin group and add a user to it in one step?”
Tell an agent
Create the admin group in tenant {tenant_uuid} and add user {user}.
Make {user} an administrator of tenant {tenant_uuid}.
POST /tenants/tenants/{tenant_uuid}/create_recovery_key/ Create a recovery key for a tenant user · Tenants tenants create recovery key create #
Ask an LLM
“Can I generate a recovery key so a user can get back into a tenant?”
“How long can a tenant recovery key stay valid?”
Tell an agent
Create a recovery key for {user} in tenant {tenant_uuid} valid for {duration_days} days.
Issue a {duration_days}-day tenant recovery key for user {user} on tenant {tenant_uuid}.

Documentation

📖
Documentation
https://docs.goauthentik.io
📖
APIReference
https://api.goauthentik.io/

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/authentik/refs/heads/main/openapi/authentik-tenants-api-openapi.yml

SDKs

📦
GitHubRepository
https://github.com/goauthentik/authentik

Other Resources

🔗
Overlay
https://raw.githubusercontent.com/api-evangelist/authentik/refs/heads/main/overlays/authentik-tenants-api-overlay.yaml
🔗
SDKs
https://www.npmjs.com/package/@goauthentik/api
🔗
SDKs
https://pypi.org/project/authentik-client/

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/authentik:authentik-tenants-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

authentik-tenants-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: authentik Tenants API
  version: 2026.11.0-rc1
  description: Making authentication simple.
  contact:
    email: hello@goauthentik.io
  license:
    name: MIT
    url: https://github.com/goauthentik/authentik/blob/main/LICENSE
  x-source-url: https://api.goauthentik.io/schema.yml
  x-last-validated: '2026-09-04'
servers:
- url: /api/v3
tags:
- name: Tenants
paths:
  /tenants/domains/:
    get:
      operationId: tenants_domains_list
      description: Domain ViewSet
      parameters:
      - $ref: '#/components/parameters/QueryPaginationOrdering'
      - $ref: '#/components/parameters/QueryPaginationPage'
      - $ref: '#/components/parameters/QueryPaginationPageSize'
      - $ref: '#/components/parameters/QuerySearch'
      tags:
      - Tenants
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaginatedDomainList'
          description: ''
        '400':
          $ref: '#/components/responses/ValidationErrorResponse'
        '403':
          $ref: '#/components/responses/GenericErrorResponse'
      summary: Tenants domains list
      x-summary-source: derived
    post:
      operationId: tenants_domains_create
      description: Domain ViewSet
      tags:
      - Tenants
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DomainRequest'
        required: true
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Domain'
          description: ''
        '400':
          $ref: '#/components/responses/ValidationErrorResponse'
        '403':
          $ref: '#/components/responses/GenericErrorResponse'
      summary: Tenants domains create
      x-summary-source: derived
  /tenants/domains/{id}/:
    get:
      operationId: tenants_domains_retrieve
      description: Domain ViewSet
      parameters:
      - in: path
        name: id
        schema:
          type: integer
        description: A unique integer value identifying this Domain.
        required: true
      tags:
      - Tenants
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Domain'
          description: ''
        '400':
          $ref: '#/components/responses/ValidationErrorResponse'
        '403':
          $ref: '#/components/responses/GenericErrorResponse'
      summary: Tenants domains retrieve
      x-summary-source: derived
    put:
      operationId: tenants_domains_update
      description: Domain ViewSet
      parameters:
      - in: path
        name: id
        schema:
          type: integer
        description: A unique integer value identifying this Domain.
        required: true
      tags:
      - Tenants
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DomainRequest'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Domain'
          description: ''
        '400':
          $ref: '#/components/responses/ValidationErrorResponse'
        '403':
          $ref: '#/components/responses/GenericErrorResponse'
      summary: Tenants domains update
      x-summary-source: derived
    patch:
      operationId: tenants_domains_partial_update
      description: Domain ViewSet
      parameters:
      - in: path
        name: id
        schema:
          type: integer
        description: A unique integer value identifying this Domain.
        required: true
      tags:
      - Tenants
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PatchedDomainRequest'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Domain'
          description: ''
        '400':
          $ref: '#/components/responses/ValidationErrorResponse'
        '403':
          $ref: '#/components/responses/GenericErrorResponse'
      summary: Tenants domains partial update
      x-summary-source: derived
    delete:
      operationId: tenants_domains_destroy
      description: Domain ViewSet
      parameters:
      - in: path
        name: id
        schema:
          type: integer
        description: A unique integer value identifying this Domain.
        required: true
      tags:
      - Tenants
      responses:
        '204':
          description: No response body
        '400':
          $ref: '#/components/responses/ValidationErrorResponse'
        '403':
          $ref: '#/components/responses/GenericErrorResponse'
      summary: Tenants domains destroy
      x-summary-source: derived
  /tenants/tenants/:
    get:
      operationId: tenants_tenants_list
      description: Tenant Viewset
      parameters:
      - $ref: '#/components/parameters/QueryPaginationOrdering'
      - $ref: '#/components/parameters/QueryPaginationPage'
      - $ref: '#/components/parameters/QueryPaginationPageSize'
      - $ref: '#/components/parameters/QuerySearch'
      tags:
      - Tenants
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaginatedTenantList'
          description: ''
        '400':
          $ref: '#/components/responses/ValidationErrorResponse'
        '403':
          $ref: '#/components/responses/GenericErrorResponse'
      summary: Tenants tenants list
      x-summary-source: derived
    post:
      operationId: tenants_tenants_create
      description: Tenant Viewset
      tags:
      - Tenants
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/TenantRequest'
        required: true
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Tenant'
          description: ''
        '400':
          $ref: '#/components/responses/ValidationErrorResponse'
        '403':
          $ref: '#/components/responses/GenericErrorResponse'
      summary: Tenants tenants create
      x-summary-source: derived
  /tenants/tenants/{tenant_uuid}/:
    get:
      operationId: tenants_tenants_retrieve
      description: Tenant Viewset
      parameters:
      - in: path
        name: tenant_uuid
        schema:
          type: string
          format: uuid
        description: A UUID string identifying this Tenant.
        required: true
      tags:
      - Tenants
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Tenant'
          description: ''
        '400':
          $ref: '#/components/responses/ValidationErrorResponse'
        '403':
          $ref: '#/components/responses/GenericErrorResponse'
      summary: Tenants tenants retrieve
      x-summary-source: derived
    put:
      operationId: tenants_tenants_update
      description: Tenant Viewset
      parameters:
      - in: path
        name: tenant_uuid
        schema:
          type: string
          format: uuid
        description: A UUID string identifying this Tenant.
        required: true
      tags:
      - Tenants
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/TenantRequest'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Tenant'
          description: ''
        '400':
          $ref: '#/components/responses/ValidationErrorResponse'
        '403':
          $ref: '#/components/responses/GenericErrorResponse'
      summary: Tenants tenants update
      x-summary-source: derived
    patch:
      operationId: tenants_tenants_partial_update
      description: Tenant Viewset
      parameters:
      - in: path
        name: tenant_uuid
        schema:
          type: string
          format: uuid
        description: A UUID string identifying this Tenant.
        required: true
      tags:
      - Tenants
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PatchedTenantRequest'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Tenant'
          description: ''
        '400':
          $ref: '#/components/responses/ValidationErrorResponse'
        '403':
          $ref: '#/components/responses/GenericErrorResponse'
      summary: Tenants tenants partial update
      x-summary-source: derived
    delete:
      operationId: tenants_tenants_destroy
      description: Tenant Viewset
      parameters:
      - in: path
        name: tenant_uuid
        schema:
          type: string
          format: uuid
        description: A UUID string identifying this Tenant.
        required: true
      tags:
      - Tenants
      responses:
        '204':
          description: No response body
        '400':
          $ref: '#/components/responses/ValidationErrorResponse'
        '403':
          $ref: '#/components/responses/GenericErrorResponse'
      summary: Tenants tenants destroy
      x-summary-source: derived
  /tenants/tenants/{tenant_uuid}/create_admin_group/:
    post:
      operationId: tenants_tenants_create_admin_group_create
      description: Create admin group and add user to it.
      parameters:
      - in: path
        name: tenant_uuid
        schema:
          type: string
          format: uuid
        description: A UUID string identifying this Tenant.
        required: true
      tags:
      - Tenants
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/TenantAdminGroupRequestRequest'
        required: true
      responses:
        '204':
          description: Group created successfully.
        '400':
          description: Bad request
        '404':
          description: User not found
        '403':
          $ref: '#/components/responses/GenericErrorResponse'
      summary: Tenants tenants create admin group create
      x-summary-source: derived
  /tenants/tenants/{tenant_uuid}/create_recovery_key/:
    post:
      operationId: tenants_tenants_create_recovery_key_create
      description: Create recovery key for user.
      parameters:
      - in: path
        name: tenant_uuid
        schema:
          type: string
          format: uuid
        description: A UUID string identifying this Tenant.
        required: true
      tags:
      - Tenants
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/TenantRecoveryKeyRequestRequest'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TenantRecoveryKeyResponse'
          description: ''
        '400':
          description: Bad request
        '404':
          description: User not found
        '403':
          $ref: '#/components/responses/GenericErrorResponse'
      summary: Tenants tenants create recovery key create
      x-summary-source: derived
components:
  schemas:
    TenantAdminGroupRequestRequest:
      type: object
      description: Tenant admin group creation request serializer
      properties:
        user:
          type: string
          minLength: 1
      required:
      - user
    Domain:
      type: object
      description: Domain Serializer
      properties:
        id:
          type: integer
          readOnly: true
        domain:
          type: string
          maxLength: 253
        is_primary:
          type: boolean
        tenant:
          type: string
          format: uuid
      required:
      - domain
      - id
      - tenant
    PatchedDomainRequest:
      type: object
      description: Domain Serializer
      properties:
        domain:
          type: string
          minLength: 1
          maxLength: 253
        is_primary:
          type: boolean
        tenant:
          type: string
          format: uuid
    ValidationError:
      type: object
      description: Validation Error
      properties:
        non_field_errors:
          type: array
          items:
            type: string
        code:
          type: string
      additionalProperties: {}
    PaginatedDomainList:
      type: object
      properties:
        pagination:
          $ref: '#/components/schemas/Pagination'
        results:
          type: array
          items:
            $ref: '#/components/schemas/Domain'
        autocomplete:
          $ref: '#/components/schemas/Autocomplete'
      required:
      - autocomplete
      - pagination
      - results
    Autocomplete:
      type: object
      additionalProperties: {}
    Tenant:
      type: object
      description: Tenant Serializer
      properties:
        tenant_uuid:
          type: string
          format: uuid
          readOnly: true
        schema_name:
          type: string
          maxLength: 63
        name:
          type: string
        ready:
          type: boolean
      required:
      - name
      - schema_name
      - tenant_uuid
    GenericError:
      type: object
      description: Generic API Error
      properties:
        detail:
          type: string
        code:
          type: string
      required:
      - detail
    PaginatedTenantList:
      type: object
      properties:
        pagination:
          $ref: '#/components/schemas/Pagination'
        results:
          type: array
          items:
            $ref: '#/components/schemas/Tenant'
        autocomplete:
          $ref: '#/components/schemas/Autocomplete'
      required:
      - autocomplete
      - pagination
      - results
    DomainRequest:
      type: object
      description: Domain Serializer
      properties:
        domain:
          type: string
          minLength: 1
          maxLength: 253
        is_primary:
          type: boolean
        tenant:
          type: string
          format: uuid
      required:
      - domain
      - tenant
    TenantRecoveryKeyResponse:
      type: object
      description: Tenant recovery key creation response serializer
      properties:
        expiry:
          type: string
          format: date-time
        url:
          type: string
      required:
      - expiry
      - url
    TenantRequest:
      type: object
      description: Tenant Serializer
      properties:
        schema_name:
          type: string
          minLength: 1
          maxLength: 63
        name:
          type: string
          minLength: 1
        ready:
          type: boolean
      required:
      - name
      - schema_name
    TenantRecoveryKeyRequestRequest:
      type: object
      description: Tenant recovery key creation request serializer
      properties:
        user:
          type: string
          minLength: 1
        duration_days:
          type: integer
      required:
      - duration_days
      - user
    Pagination:
      type: object
      properties:
        next:
          type: number
        previous:
          type: number
        count:
          type: number
        current:
          type: number
        total_pages:
          type: number
        start_index:
          type: number
        end_index:
          type: number
      required:
      - count
      - current
      - end_index
      - next
      - previous
      - start_index
      - total_pages
    PatchedTenantRequest:
      type: object
      description: Tenant Serializer
      properties:
        schema_name:
          type: string
          minLength: 1
          maxLength: 63
        name:
          type: string
          minLength: 1
        ready:
          type: boolean
  responses:
    GenericErrorResponse:
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/GenericError'
      description: ''
    ValidationErrorResponse:
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ValidationError'
      description: ''
  parameters:
    QueryPaginationOrdering:
      in: query
      name: ordering
      schema:
        type: string
      description: Which field to use when ordering the results.
    QueryPaginationPageSize:
      in: query
      name: page_size
      schema:
        type: integer
      description: Number of results to return per page.
    QueryPaginationPage:
      in: query
      name: page
      schema:
        type: integer
      description: A page number within the paginated result set.
    QuerySearch:
      in: query
      name: search
      schema:
        type: string
      description: A search term.
  securitySchemes:
    authentik:
      type: http
      scheme: bearer
    authentik_device_auth:
      type: http
      scheme: bearer+agent
    authentik_device_enroll:
      type: http
      scheme: bearer
    authentik_device_federation:
      type: http
      scheme: bearer