Britive API Tokens API

openapi: 3.2.0
info:
  title: Britive Services API Documentation API Tokens API
  version: v1
  description: API documentation for Users, Tags, Identity providers, Applications, Reporting, Audit logs, Tenants, SSO, Profiles, Password policies, MFA, Access Builder Settings, etc.
servers:
- url: https://{tenantURL}
  description: The primary server
  variables:
    tenantURL:
      default: test.britive-app.com
      description: The host of the server
security:
- bearerAuth: []
tags:
- name: API Tokens
  description: Manage API Tokens
paths:
  /api/token:
    post:
      tags:
      - API Tokens
      operationId: apiToken_7
      summary: Create an API token with full administrator privileges.
      description: The API token is returned only once. Copy and keep it in a secure location. If you lose the token you will have to generate a new token again.
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ApiTokenBean'
            example:
              name: admin-token1
              tokenExpirationDays: '60'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiTokenBean'
    get:
      tags:
      - API Tokens
      summary: Get all API tokens in the system
      operationId: apiToken_1
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/ApiTokenBean'
  /api/token/{tokenId}:
    get:
      tags:
      - API Tokens
      summary: Get details of an API token
      operationId: apiToken_6
      parameters:
      - name: tokenId
        description: Token ID
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
    delete:
      tags:
      - API Tokens
      summary: Revoke a token for a specific token id
      description: Use the Get tokens API call to retrieve the id of the token that should be revoked.
      operationId: apiToken_5
      parameters:
      - name: tokenId
        description: Token ID
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
    put:
      tags:
      - API Tokens
      summary: Update an API Token for a specific token ID
      operationId: apiToken_8
      parameters:
      - name: tokenId
        in: path
        description: Token ID
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ApiTokenBean'
            example:
              name: admin-token1
              tokenExpirationDays: '60'
      responses:
        '204':
          description: No content
    patch:
      tags:
      - API Tokens
      summary: Update API token expiration days for a specified token
      operationId: apiToken_9
      parameters:
      - name: tokenId
        description: Token ID
        in: path
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ApiTokenBean'
            example:
              name: admin-token1
              tokenExpirationDays: '60'
      responses:
        '200':
          description: No content
components:
  schemas:
    ApiTokenBean:
      type: object
      properties:
        id:
          type: string
        name:
          type: string
        expiresOn:
          type: string
          format: date-time
        createdOn:
          type: string
          format: date-time
        type:
          type: string
          enum:
          - DEFAULT
          - SCIM
          - ServiceIdentity
        tokenExpirationDays:
          type: integer
          description: Any value between 1 and 90 days.
          format: int32
        status:
          type: string
          enum:
          - Active
          - Inactive
        lastAccessed:
          type: string
          format: date-time
        assignedTo:
          type: string
        token:
          type: string
        createdBy:
          type: string
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
x-api-evangelist:
  assembled_from: https://docs.britive.com/apidocs/ (one OpenAPI fragment per operation page, .md variant)
  assembled_on: '2026-08-08'
  fragments: 372
  note: Britive publishes this contract only as per-operation fragments inside its Document360 API reference. This file is the faithful union of those fragments; the verbatim assembly is in openapi/_original/.