openapi: 3.0.3
info:
  title: Face
  description: >-
    Login using facial recognition, allowing users to authenticate with their
    face. This provides a secure, passwordless login method with strong
    biometric verification.
  version: ''
servers:
  - url: https://api.sbx.transmitsecurity.io/cis
    description: Sandbox environment
  - url: https://api.transmitsecurity.io/cis
    description: Production environment (US)
  - url: https://api.eu.transmitsecurity.io/cis
    description: Production environment (EU)
  - url: https://api.ca.transmitsecurity.io/cis
    description: Production environment (CA)
  - url: https://api.au.transmitsecurity.io/cis
    description: Production environment (AU)
security: []
paths:
  /v1/users/me/face/revoke:
    post:
      operationId: revokeFace
      summary: Revoke my Face Authentication
      description: Unregisters the face authenticator of the currently logged-in user
      parameters: []
      responses:
        '204':
          description: Revoked
      security:
        - UserAccessToken: []
  /v1/users/face/revoke:
    post:
      operationId: revokeFaceManagement
      summary: Revoke Face Authentication
      description: >-
        Unregisters a user's face authenticator. <br><br>**Required
        permissions**: `apps:delete`, `[appId]:delete`, `authenticators:delete`.
      parameters: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ApiFaceRevokeInputDto'
      responses:
        '204':
          description: Revoked
      security:
        - ClientAccessToken: []
components:
  schemas:
    ApiFaceRevokeInputDto:
      type: object
      properties:
        user_id:
          type: string
          description: ID of the user
      required:
        - user_id
  securitySchemes:
    bearer:
      scheme: bearer
      bearerFormat: JWT
      type: http
    UserAccessToken:
      type: http
      description: >-
        A token returned upon end-user authentication, which provides access to
        resources and data for the user and app for which it was generated
      scheme: bearer
      bearerFormat: JWT
    AdminAccessToken:
      type: oauth2
      flows:
        clientCredentials:
          tokenUrl: /oidc/token
          scopes: {}
      description: >-
        A token generated by a management application using the [token
        endpoint](/openapi/token.openapi/other/getaccesstoken). It provides
        access to all resources for the tenant and its apps
    ClientAccessToken:
      type: oauth2
      flows:
        clientCredentials:
          tokenUrl: /oidc/token
          scopes: {}
      description: >-
        A token generated by an end-user application using the [token
        endpoint](/openapi/token.openapi/other/getaccesstoken). It provides
        access to resources and data on the tenant level or associated with the
        specific application (but not other apps in the tenant)
    OrgAdminAccessToken:
      type: oauth2
      flows:
        clientCredentials:
          tokenUrl: /oidc/token
          scopes: {}
      description: >-
        A token returned upon B2B authentication for a user that has the
        organizationAdmin or organizationCreator role.
