Authentik

Authentik Lifecycle API

Identity lifecycle operations, including scheduled user offboarding with session and token revocation and a cancellable pending state.

GitHub OpenAPI
Business capability
Identity & Access Management BC-620.20

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

POST /lifecycle/iterations/ Start an access review iteration · Lifecycle iterations create #
Ask an LLM
“How do I kick off a new access review cycle for an object type?”
“Does starting a lifecycle review iteration need an enterprise license?”
Tell an agent
Start a new review iteration for content type {content_type}.
Open an access review round covering {content_type} objects.
GET /lifecycle/iterations/latest/{content_type}/{object_id}/ Get the latest review iteration for an object · Lifecycle iterations list latest #
Ask an LLM
“What is the most recent access review for a specific group or application?”
“Can I see the latest review of one object only where I am a reviewer?”
Tell an agent
Show the latest review iteration for {content_type} object {object_id}.
Get the newest review of {content_type} {object_id} where I am a reviewer: {user_is_reviewer}.
GET /lifecycle/iterations/open/ List open access review iterations · Lifecycle iterations list open #
Ask an LLM
“Which access reviews are still open and waiting on reviewers?”
“Can I see just the open reviews assigned to me?”
Tell an agent
List all open review iterations.
Show open reviews where I am a reviewer: {user_is_reviewer}.
POST /lifecycle/reviews/ Submit a review for an iteration · Lifecycle reviews create #
Ask an LLM
“How do I sign off on an access review I was assigned?”
“Can I leave a note when I complete a lifecycle review?”
Tell an agent
Submit my review for iteration {iteration}.
Approve review iteration {iteration} with the note {note}.
GET /lifecycle/rules/ List lifecycle review rules · Lifecycle rules list #
Ask an LLM
“What recurring access review rules are configured?”
“Can I filter review rules by the kind of object they cover?”
Tell an agent
List all lifecycle rules.
Show lifecycle rules that apply to the {content_type__model} model.
POST /lifecycle/rules/ Create a lifecycle review rule · Lifecycle rules create #
Ask an LLM
“How do I schedule periodic access reviews for groups or applications?”
“Can I require a minimum number of reviewers and a grace period on a review rule?”
Tell an agent
Create a lifecycle rule {name} for {content_type} reviewed by {reviewers}.
Add review rule {name} on {content_type} every {interval} with grace period {grace_period}, reviewers {reviewers}.
GET /lifecycle/rules/{id}/ Get a lifecycle review rule · Lifecycle rules retrieve #
Ask an LLM
“How often does a given access review rule run and who reviews it?”
“What grace period is set on one lifecycle rule?”
Tell an agent
Show lifecycle rule {id}.
Get the interval and reviewers of review rule {id}.
PUT /lifecycle/rules/{id}/ Replace a lifecycle review rule · Lifecycle rules update #
Ask an LLM
“How do I redefine an entire access review rule in one request?”
“Which fields must I resend when fully replacing a lifecycle rule?”
Tell an agent
Replace lifecycle rule {id} with name {name}, content type {content_type} and reviewers {reviewers}.
Overwrite rule {id}: {name} on {content_type}, reviewer groups {reviewer_groups}, reviewers {reviewers}.
PATCH /lifecycle/rules/{id}/ Adjust a lifecycle review rule · Lifecycle rules partial update #
Ask an LLM
“Can I change only the review interval on an existing rule?”
“How do I raise the minimum reviewer count on a rule without touching anything else?”
Tell an agent
Change the interval of lifecycle rule {id} to {interval}.
Set minimum reviewers on rule {id} to {min_reviewers}, per group: {min_reviewers_is_per_group}.
DELETE /lifecycle/rules/{id}/ Delete a lifecycle review rule · Lifecycle rules destroy #
Ask an LLM
“How do I stop a recurring access review by removing its rule?”
“Can I delete a lifecycle rule I no longer need?”
Tell an agent destructive · confirm first
Delete lifecycle rule {id}.
Remove the access review rule {id}.
GET /lifecycle/user_offboarding/ List scheduled user offboardings · Lifecycle user offboarding list #
Ask an LLM
“Which users are scheduled to be offboarded?”
“Can I filter offboardings by status or by a particular user?”
Tell an agent
List all user offboardings.
Show offboardings with status {status}.
POST /lifecycle/user_offboarding/ Schedule a user offboarding · Lifecycle user offboarding create #
Ask an LLM
“How do I schedule a departing employee to be offboarded on their last day?”
“Can offboarding also revoke the user's sessions and tokens?”
Tell an agent
Schedule offboarding of user {user} at {scheduled_at}.
Offboard {user} at {scheduled_at} with action {action}, revoking sessions {revoke_sessions} and tokens {revoke_tokens}.
GET /lifecycle/user_offboarding/{id}/ Get a user offboarding · Lifecycle user offboarding retrieve #
Ask an LLM
“When is a specific offboarding scheduled to run and what will it do?”
“What is the current status of one user offboarding?”
Tell an agent
Show offboarding {id}.
Check the status of user offboarding {id}.
DELETE /lifecycle/user_offboarding/{id}/ Cancel a pending user offboarding · Lifecycle user offboarding destroy #
Ask an LLM
“How do I call off an offboarding that has not run yet?”
“Does canceling an offboarding keep it in the audit history?”
Tell an agent destructive · confirm first
Cancel pending offboarding {id}.
Stop the scheduled offboarding {id} before it executes.

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-lifecycle-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-lifecycle-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-lifecycle-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-lifecycle-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: authentik Lifecycle 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: Lifecycle
paths:
  /lifecycle/iterations/:
    post:
      operationId: lifecycle_iterations_create
      description: 'Mixin to validate that a valid enterprise license

        exists before allowing to save the object'
      tags:
      - Lifecycle
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/LifecycleIterationRequest'
        required: true
      security:
      - authentik: []
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LifecycleIteration'
          description: ''
        '400':
          $ref: '#/components/responses/ValidationErrorResponse'
        '403':
          $ref: '#/components/responses/GenericErrorResponse'
      summary: Lifecycle iterations create
      x-summary-source: derived
  /lifecycle/iterations/latest/{content_type}/{object_id}/:
    get:
      operationId: lifecycle_iterations_list_latest
      description: 'Mixin to validate that a valid enterprise license

        exists before allowing to save the object'
      parameters:
      - in: path
        name: content_type
        schema:
          type: string
          pattern: ^[^/]+$
        required: true
      - in: path
        name: object_id
        schema:
          type: string
          pattern: ^[^/]+$
        required: true
      - $ref: '#/components/parameters/QueryPaginationOrdering'
      - $ref: '#/components/parameters/QuerySearch'
      - in: query
        name: user_is_reviewer
        schema:
          type: boolean
      tags:
      - Lifecycle
      security:
      - authentik: []
      responses:
        '200':
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/LifecycleIteration'
          description: ''
        '400':
          $ref: '#/components/responses/ValidationErrorResponse'
        '403':
          $ref: '#/components/responses/GenericErrorResponse'
      summary: Lifecycle iterations list latest
      x-summary-source: derived
  /lifecycle/iterations/open/:
    get:
      operationId: lifecycle_iterations_list_open
      description: 'Mixin to validate that a valid enterprise license

        exists before allowing to save the object'
      parameters:
      - $ref: '#/components/parameters/QueryPaginationOrdering'
      - $ref: '#/components/parameters/QueryPaginationPage'
      - $ref: '#/components/parameters/QueryPaginationPageSize'
      - $ref: '#/components/parameters/QuerySearch'
      - in: query
        name: user_is_reviewer
        schema:
          type: boolean
      tags:
      - Lifecycle
      security:
      - authentik: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaginatedLifecycleIterationList'
          description: ''
        '400':
          $ref: '#/components/responses/ValidationErrorResponse'
        '403':
          $ref: '#/components/responses/GenericErrorResponse'
      summary: Lifecycle iterations list open
      x-summary-source: derived
  /lifecycle/reviews/:
    post:
      operationId: lifecycle_reviews_create
      description: 'Mixin to validate that a valid enterprise license

        exists before allowing to save the object'
      tags:
      - Lifecycle
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ReviewRequest'
        required: true
      security:
      - authentik: []
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Review'
          description: ''
        '400':
          $ref: '#/components/responses/ValidationErrorResponse'
        '403':
          $ref: '#/components/responses/GenericErrorResponse'
      summary: Lifecycle reviews create
      x-summary-source: derived
  /lifecycle/rules/:
    get:
      operationId: lifecycle_rules_list
      parameters:
      - in: query
        name: content_type__model
        schema:
          type: string
      - $ref: '#/components/parameters/QueryPaginationOrdering'
      - $ref: '#/components/parameters/QueryPaginationPage'
      - $ref: '#/components/parameters/QueryPaginationPageSize'
      - $ref: '#/components/parameters/QuerySearch'
      tags:
      - Lifecycle
      security:
      - authentik: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaginatedLifecycleRuleList'
          description: ''
        '400':
          $ref: '#/components/responses/ValidationErrorResponse'
        '403':
          $ref: '#/components/responses/GenericErrorResponse'
      summary: Lifecycle rules list
      x-summary-source: derived
    post:
      operationId: lifecycle_rules_create
      tags:
      - Lifecycle
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/LifecycleRuleRequest'
        required: true
      security:
      - authentik: []
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LifecycleRule'
          description: ''
        '400':
          $ref: '#/components/responses/ValidationErrorResponse'
        '403':
          $ref: '#/components/responses/GenericErrorResponse'
      summary: Lifecycle rules create
      x-summary-source: derived
  /lifecycle/rules/{id}/:
    get:
      operationId: lifecycle_rules_retrieve
      parameters:
      - in: path
        name: id
        schema:
          type: string
          format: uuid
        description: A UUID string identifying this lifecycle rule.
        required: true
      tags:
      - Lifecycle
      security:
      - authentik: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LifecycleRule'
          description: ''
        '400':
          $ref: '#/components/responses/ValidationErrorResponse'
        '403':
          $ref: '#/components/responses/GenericErrorResponse'
      summary: Lifecycle rules retrieve
      x-summary-source: derived
    put:
      operationId: lifecycle_rules_update
      parameters:
      - in: path
        name: id
        schema:
          type: string
          format: uuid
        description: A UUID string identifying this lifecycle rule.
        required: true
      tags:
      - Lifecycle
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/LifecycleRuleRequest'
        required: true
      security:
      - authentik: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LifecycleRule'
          description: ''
        '400':
          $ref: '#/components/responses/ValidationErrorResponse'
        '403':
          $ref: '#/components/responses/GenericErrorResponse'
      summary: Lifecycle rules update
      x-summary-source: derived
    patch:
      operationId: lifecycle_rules_partial_update
      parameters:
      - in: path
        name: id
        schema:
          type: string
          format: uuid
        description: A UUID string identifying this lifecycle rule.
        required: true
      tags:
      - Lifecycle
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PatchedLifecycleRuleRequest'
      security:
      - authentik: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LifecycleRule'
          description: ''
        '400':
          $ref: '#/components/responses/ValidationErrorResponse'
        '403':
          $ref: '#/components/responses/GenericErrorResponse'
      summary: Lifecycle rules partial update
      x-summary-source: derived
    delete:
      operationId: lifecycle_rules_destroy
      parameters:
      - in: path
        name: id
        schema:
          type: string
          format: uuid
        description: A UUID string identifying this lifecycle rule.
        required: true
      tags:
      - Lifecycle
      security:
      - authentik: []
      responses:
        '204':
          description: No response body
        '400':
          $ref: '#/components/responses/ValidationErrorResponse'
        '403':
          $ref: '#/components/responses/GenericErrorResponse'
      summary: Lifecycle rules destroy
      x-summary-source: derived
  /lifecycle/user_offboarding/:
    get:
      operationId: lifecycle_user_offboarding_list
      parameters:
      - in: query
        name: action
        schema:
          $ref: '#/components/schemas/OffboardingActionEnum'
      - $ref: '#/components/parameters/QueryPaginationOrdering'
      - $ref: '#/components/parameters/QueryPaginationPage'
      - $ref: '#/components/parameters/QueryPaginationPageSize'
      - $ref: '#/components/parameters/QuerySearch'
      - in: query
        name: status
        schema:
          $ref: '#/components/schemas/OffboardingStatusEnum'
      - in: query
        name: user__uuid
        schema:
          type: string
          format: uuid
      tags:
      - Lifecycle
      security:
      - authentik: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaginatedUserOffboardingList'
          description: ''
        '400':
          $ref: '#/components/responses/ValidationErrorResponse'
        '403':
          $ref: '#/components/responses/GenericErrorResponse'
      summary: Lifecycle user offboarding list
      x-summary-source: derived
    post:
      operationId: lifecycle_user_offboarding_create
      tags:
      - Lifecycle
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UserOffboardingRequest'
        required: true
      security:
      - authentik: []
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UserOffboarding'
          description: ''
        '400':
          $ref: '#/components/responses/ValidationErrorResponse'
        '403':
          $ref: '#/components/responses/GenericErrorResponse'
      summary: Lifecycle user offboarding create
      x-summary-source: derived
  /lifecycle/user_offboarding/{id}/:
    get:
      operationId: lifecycle_user_offboarding_retrieve
      parameters:
      - in: path
        name: id
        schema:
          type: string
          format: uuid
        description: A UUID string identifying this User Offboarding.
        required: true
      tags:
      - Lifecycle
      security:
      - authentik: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UserOffboarding'
          description: ''
        '400':
          $ref: '#/components/responses/ValidationErrorResponse'
        '403':
          $ref: '#/components/responses/GenericErrorResponse'
      summary: Lifecycle user offboarding retrieve
      x-summary-source: derived
    delete:
      operationId: lifecycle_user_offboarding_destroy
      description: 'Cancel a pending offboarding instead of deleting the record.


        The row is retained (as `CANCELED`) so the offboarding stays visible in

        the audit history; deletion would erase who scheduled and cancelled it.

        You cannot cancel an offboarding that targets you.'
      parameters:
      - in: path
        name: id
        schema:
          type: string
          format: uuid
        description: A UUID string identifying this User Offboarding.
        required: true
      tags:
      - Lifecycle
      security:
      - authentik: []
      responses:
        '204':
          description: No response body
        '400':
          $ref: '#/components/responses/ValidationErrorResponse'
        '403':
          $ref: '#/components/responses/GenericErrorResponse'
      summary: Lifecycle user offboarding destroy
      x-summary-source: derived
components:
  schemas:
    ContentTypeEnum:
      enum:
      - authentik_core.application
      - authentik_core.group
      - authentik_rbac.role
      type: string
    UserOffboarding:
      type: object
      description: 'Mixin to validate that a valid enterprise license

        exists before allowing to save the object'
      properties:
        id:
          type: string
          format: uuid
          readOnly: true
        user:
          type: integer
        user_obj:
          allOf:
          - $ref: '#/components/schemas/PartialUser'
          readOnly: true
        scheduled_at:
          type: string
          format: date-time
          description: Absolute time at which the offboarding action is executed.
        action:
          $ref: '#/components/schemas/OffboardingActionEnum'
        revoke_sessions:
          type: boolean
          description: Revoke all of the user's sessions when offboarding.
        revoke_tokens:
          type: boolean
          description: Revoke all of the user's tokens when offboarding.
        status:
          allOf:
          - $ref: '#/components/schemas/OffboardingStatusEnum'
          readOnly: true
        created_by_obj:
          allOf:
          - $ref: '#/components/schemas/PartialUser'
          readOnly: true
        created_at:
          type: string
          format: date-time
          readOnly: true
        executed_at:
          type:
          - string
          - 'null'
          format: date-time
          readOnly: true
      required:
      - created_at
      - created_by_obj
      - executed_at
      - id
      - scheduled_at
      - status
      - user
      - user_obj
    RelatedRule:
      type: object
      description: 'Mixin to validate that a valid enterprise license

        exists before allowing to save the object'
      properties:
        id:
          type: string
          format: uuid
        name:
          type: string
        reviewer_groups:
          type: array
          items:
            $ref: '#/components/schemas/PartialGroup'
          readOnly: true
        min_reviewers:
          type: integer
          readOnly: true
        reviewers:
          type: array
          items:
            $ref: '#/components/schemas/PartialUser'
          readOnly: true
      required:
      - min_reviewers
      - name
      - reviewer_groups
      - reviewers
    ReviewRequest:
      type: object
      description: 'Mixin to validate that a valid enterprise license

        exists before allowing to save the object'
      properties:
        iteration:
          type: string
          format: uuid
        note:
          type:
          - string
          - 'null'
          minLength: 1
      required:
      - iteration
    LifecycleIteration:
      type: object
      description: 'Mixin to validate that a valid enterprise license

        exists before allowing to save the object'
      properties:
        id:
          type: string
          format: uuid
          readOnly: true
        content_type:
          $ref: '#/components/schemas/ContentTypeEnum'
        object_id:
          type: string
          readOnly: true
        object_verbose:
          type: string
          readOnly: true
        object_admin_url:
          type: string
          readOnly: true
        state:
          allOf:
          - $ref: '#/components/schemas/LifecycleIterationStateEnum'
          readOnly: true
        opened_on:
          type: string
          format: date-time
          readOnly: true
        grace_period_end:
          type: string
          format: date-time
          readOnly: true
        next_review_date:
          type: string
          format: date-time
          readOnly: true
        reviews:
          type: array
          items:
            $ref: '#/components/schemas/Review'
          readOnly: true
        rule:
          allOf:
          - $ref: '#/components/schemas/RelatedRule'
          readOnly: true
        user_can_review:
          type: boolean
          readOnly: true
      required:
      - content_type
      - grace_period_end
      - id
      - next_review_date
      - object_admin_url
      - object_id
      - object_verbose
      - opened_on
      - reviews
      - rule
      - state
      - user_can_review
    PatchedLifecycleRuleRequest:
      type: object
      description: 'Mixin to validate that a valid enterprise license

        exists before allowing to save the object'
      properties:
        name:
          type: string
          minLength: 1
        content_type:
          $ref: '#/components/schemas/ContentTypeEnum'
        object_id:
          type:
          - string
          - 'null'
          minLength: 1
        interval:
          type: string
          minLength: 1
        grace_period:
          type: string
          minLength: 1
        reviewer_groups:
          type: array
          items:
            type: string
            format: uuid
        min_reviewers:
          type: integer
          maximum: 32767
          minimum: 0
        min_reviewers_is_per_group:
          type: boolean
        reviewers:
          type: array
          items:
            type: string
            format: uuid
        notification_transports:
          type: array
          items:
            type: string
            format: uuid
          description: Select which transports should be used to notify the reviewers. If none are selected, the notification will only be shown in the authentik UI.
    ValidationError:
      type: object
      description: Validation Error
      properties:
        non_field_errors:
          type: array
          items:
            type: string
        code:
          type: string
      additionalProperties: {}
    PartialGroup:
      type: object
      description: Partial Group Serializer, does not include child relations.
      properties:
        pk:
          type: string
          format: uuid
          readOnly: true
          title: Group uuid
        num_pk:
          type: integer
          description: Get a numerical, int32 ID for the group
          readOnly: true
        name:
          type: string
        is_superuser:
          type: boolean
          description: Users added to this group will be superusers.
        attributes:
          type: object
          additionalProperties: {}
      required:
      - name
      - num_pk
      - pk
    PaginatedLifecycleIterationList:
      type: object
      properties:
        pagination:
          $ref: '#/components/schemas/Pagination'
        results:
          type: array
          items:
            $ref: '#/components/schemas/LifecycleIteration'
        autocomplete:
          $ref: '#/components/schemas/Autocomplete'
      required:
      - autocomplete
      - pagination
      - results
    LifecycleRuleRequest:
      type: object
      description: 'Mixin to validate that a valid enterprise license

        exists before allowing to save the object'
      properties:
        name:
          type: string
          minLength: 1
        content_type:
          $ref: '#/components/schemas/ContentTypeEnum'
        object_id:
          type:
          - string
          - 'null'
          minLength: 1
        interval:
          type: string
          minLength: 1
        grace_period:
          type: string
          minLength: 1
        reviewer_groups:
          type: array
          items:
            type: string
            format: uuid
        min_reviewers:
          type: integer
          maximum: 32767
          minimum: 0
        min_reviewers_is_per_group:
          type: boolean
        reviewers:
          type: array
          items:
            type: string
            format: uuid
        notification_transports:
          type: array
          items:
            type: string
            format: uuid
          description: Select which transports should be used to notify the reviewers. If none are selected, the notification will only be shown in the authentik UI.
      required:
      - content_type
      - name
      - reviewers
    Autocomplete:
      type: object
      additionalProperties: {}
    GenericError:
      type: object
      description: Generic API Error
      properties:
        detail:
          type: string
        code:
          type: string
      required:
      - detail
    UserOffboardingRequest:
      type: object
      description: 'Mixin to validate that a valid enterprise license

        exists before allowing to save the object'
      properties:
        user:
          type: integer
        scheduled_at:
          type: string
          format: date-time
          description: Absolute time at which the offboarding action is executed.
        action:
          $ref: '#/components/schemas/OffboardingActionEnum'
        revoke_sessions:
          type: boolean
          description: Revoke all of the user's sessions when offboarding.
        revoke_tokens:
          type: boolean
          description: Revoke all of the user's tokens when offboarding.
      required:
      - scheduled_at
      - user
    PartialUser:
      type: object
      description: Partial User Serializer, does not include child relations.
      properties:
        pk:
          type: integer
          readOnly: true
          title: ID
        username:
          type: string
          description: Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only.
          pattern: ^[\w.@+-]+$
          maxLength: 150
        name:
          type: string
          description: User's display name.
        is_active:
          type: boolean
          title: Active
          description: Designates whether this user should be treated as active. Unselect this instead of deleting accounts.
        last_login:
          type:
          - string
          - 'null'
          format: date-time
        email:
          type: string
          format: email
          title: Email address
          maxLength: 254
        attributes:
          type: object
          additionalProperties: {}
        uid:
          type: string
          readOnly: true
      required:
      - name
      - pk
      - uid
      - username
    OffboardingActionEnum:
      enum:
      - deactivate
      - delete
      type: string
    LifecycleIterationRequest:
      type: object
      description: 'Mixin to validate that a valid enterprise license

        exists before allowing to save the object'
      properties:
        content_type:
          $ref: '#/components/schemas/ContentTypeEnum'
      required:
      - content_type
    PaginatedUserOffboardingList:
      type: object
      properties:
        pagination:
          $ref: '#/components/schemas/Pagination'
        results:
          type: array
          items:
            $ref: '#/components/schemas/UserOffboarding'
        autocomplete:
          $ref: '#/components/schemas/Autocomplete'
      required:
      - autocomplete
      - pagination
      - results
    LifecycleIterationStateEnum:
      enum:
      - REVIEWED
      - PENDING
      - OVERDUE
      - CANCELED
      type: string
    LifecycleRule:
      type: object
      description: 'Mixin to validate that a valid enterprise license

        exists before allowing to save the object'
      properties:
        id:
          type: string
          format: uuid
          readOnly: true
        name:
          type: string
        content_type:
          $ref: '#/components/schemas/ContentTypeEnum'
        object_id:
          type:
          - string
          - 'null'
        interval:
          type: string
        grace_period:
          type: string
        reviewer_groups:
          type: array
          items:
            type: string
            format: uuid
        reviewer_groups_obj:
          type: array
          items:
            $ref: '#/components/schemas/PartialGroup'
          readOnly: true
        min_reviewers:
          type: integer
          maximum: 32767
          minimum: 0
        min_reviewers_is_per_group:
          type: boolean
        reviewers:
          type: array
          items:
            type: string
            format: uuid
        reviewers_obj:
          type: array
          items:
            $ref: '#/components/schemas/PartialUser'
          readOnly: true
        notification_transports:
          type: array
          items:
            type: string
            format: uuid
          description: Select which transports should be used to notify the reviewers. If none are selected, the notification will only be shown in the authentik UI.
        target_verbose:
          type: string
          readOnly: true
      required:
      - content_type
      - id
      - name
      - reviewer_groups_obj
      - reviewers
      - reviewers_obj
      - target_verbose
    Review:
      type: object
      description: 'Mixin to validate that a valid enterprise license

        exists before allowing to save the object'
      properties:
        id:
          type: string
          format: uuid
          readOnly: true
        iteration:
          type: string
          format: uuid
        reviewer:
          allOf:
          - $ref: '#/components/schemas/PartialUser'
          readOnly: true
        timestamp:
          type: string
          format: date-time
          readOnly: true
        note:
          type:
          - string
          - 'null'
      required:
      - id
      - iteration
      - reviewer
      - timestamp
    PaginatedLifecycleRuleList:
      type: object
      properties:
        pagination:
          $ref: '#/components/schemas/Pagination'
        results:
          type: array
          items:
            $ref: '#/components/schemas/LifecycleRule'
        autocomplete:
          $ref: '#/components/schemas/Autocomplete'
      required:
      - autocomplete
      - pagination
      - results
    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
    OffboardingStatusEnum:
      enum:
      - pending
      - completed
      - failed
      - canceled
      type: string
  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