LogicGate Access Audit API

openapi: 3.2.0
info:
  title: Risk Cloud Access Audit API
  description: 'Welcome to the Risk Cloud API v2! This is a collection of new API-first and RESTful API endpoints to streamline the creation of custom integrations with the Risk Cloud.


    For the API documentation of our legacy API v1 endpoints, reference [Risk Cloud API v1](https://docs.logicgate.com/v1/index.html).'
  contact:
    name: developer-relations@logicgate.com
    email: developer-relations@logicgate.com
  version: v2026.7.0
servers:
- url: https://{env}.logicgate.com
  description: The LogicGate API application.
  variables:
    env:
      default: qa
security:
- API Token: []
- basic: []
tags:
- name: Access Audit
  description: An Access Audit captures information about access related events such as logins and logouts associated with a user.
paths:
  /api/v2/audits/access:
    get:
      tags:
      - Access Audit
      summary: Retrieve access audits
      description: '**Permissions:** [Productivity Entitlement](https://help.logicgate.com/hc/en-us/articles/4402683139348-Module-Entitlements-for-Roles)


        Retrieve a page of all access audits.'
      operationId: readAllAccessAudits
      parameters:
      - name: user-id
        in: query
        description: Filter by user ID associated with the access audit entry.
        required: false
        schema:
          type: string
        example: a1b2c3d4
      - name: user-email
        in: query
        description: Filter by email address associated with the access audit entry.
        required: false
        schema:
          type: string
        example: jane.doe@logicgate.com
      - name: type
        in: query
        description: Filter by type of access event (LOGIN, LOGOUT, LOGIN_FAILED, CREDENTIALS_ROLLED, TOKEN_ROLLED).
        required: false
        schema:
          type: string
          enum:
          - LOGIN
          - LOGOUT
          - LOGIN_FAILED
          - CREDENTIALS_ROLLED
          - TOKEN_ROLLED
          - OTHER
          title: Access Audit Type
        example: LOGIN
      - name: created-min
        in: query
        description: Minimum created timestamp of the access audit in milliseconds since the Unix epoch (inclusive).
        required: false
        schema:
          type: integer
          format: int64
        example: 1672552800000
      - name: created-max
        in: query
        description: Maximum created timestamp of the access audit in milliseconds since the Unix epoch (inclusive).
        required: false
        schema:
          type: integer
          format: int64
        example: 1672552800000
      - name: page
        in: query
        description: The zero-indexed page number (must not be less than 0, defaults to 0)
        required: false
        schema:
          type: integer
          format: int32
          minimum: 0
        example: 0
      - name: size
        in: query
        description: The size of the page and maximum number of items to be returned (must not be less than 1, defaults to 20)
        required: false
        schema:
          type: integer
          format: int32
          minimum: 1
        example: 20
      - name: Authorization
        in: header
        description: 'A bearer authorization header containing a Risk Cloud API access token in the format `Authorization: Bearer {TOKEN}`.


          To obtain a Risk Cloud API access token, refer to [Obtain an API Access Token](https://www.logicgate.com/developer/risk-cloud-api-authentication/) in the [LogicGate Help Center](https://help.logicgate.com/hc/en-us).'
        required: true
        schema:
          type: string
        example: Bearer {TOKEN}
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PageModelOutAccessAuditApiOut'
      x-beta: 'true'
components:
  schemas:
    AccessAuditApiOut:
      type: object
      properties:
        id:
          type: string
          description: The unique ID of this Risk Cloud resource
          example: a1b2c3d4
        type:
          type: string
          description: The type of access event that was logged, such as LOGIN, LOGOUT, or LOGIN_FAILED.
          enum:
          - LOGIN
          - LOGOUT
          - LOGIN_FAILED
          - CREDENTIALS_ROLLED
          - TOKEN_ROLLED
          - OTHER
          example: LOGIN
          title: Access Audit Type
        user:
          $ref: '#/components/schemas/UserPropertyApiOut'
          description: The user associated with the access event, including their ID, name, and email address.
        remoteAddress:
          type: string
          description: The remote address or host from which the user attempted to access the system.
          example: 192.168.1.1
        details:
          type: string
          description: Additional context or information about the access event.
          example: Login succeeded
        created:
          type: string
          format: date-time
          description: The created timestamp of the audit measured in milliseconds since the Unix epoch
          example: 1672552800000
        object:
          type: string
          description: Identifies the type of object this data represents
          example: access_audit
      title: Access Audit
    UserPropertyApiOut:
      type: object
      properties:
        id:
          type: string
          description: The unique ID of this Risk Cloud resource
          example: a1b2c3d4
        name:
          type: string
          description: The name of the user
          example: Jane Doe
        email:
          type: string
          description: The email of the user
          example: jane.doe@example.com
        object:
          type: string
          description: Identifies the type of object this data represents
          example: user
      title: User (Property)
    PageModelOutAccessAuditApiOut:
      type: object
      properties:
        content:
          type: array
          description: A array of returned items
          items:
            $ref: '#/components/schemas/AccessAuditApiOut'
        links:
          $ref: '#/components/schemas/PageLinksOut'
          description: A collection of page URL links for navigation and iteration
        page:
          $ref: '#/components/schemas/PageInfoOut'
          description: A collection page metadata
      title: Page (Response)
    PageInfoOut:
      type: object
      properties:
        size:
          type: integer
          format: int64
          description: The size of the page and maximum number of items to be returned (must not be less than 1, defaults to 20)
          example: 20
        totalElements:
          type: integer
          format: int64
          description: The total number of items available
          example: 50
        totalPages:
          type: integer
          format: int64
          description: The total number of pages available based on the size
          example: 3
        number:
          type: integer
          format: int64
          description: The zero-indexed page number (must not be less than 0, defaults to 0)
          example: 0
      title: Page Info
    PageLinksOut:
      type: object
      properties:
        first:
          type: string
          description: A URL path to the first page of requested data
          example: /api/v2/resource?page=0&size=20
        prev:
          type: string
          description: A URL path to the next page of requested data or `null` if currently on first page
          example: /api/v2/resource?page=2&size=20
        self:
          type: string
          description: A URL path to the current page of requested data
          example: /api/v2/resource?page=3&size=20
        next:
          type: string
          description: A URL link to the next page of requested data or `null` if currently on last page
          example: /api/v2/resource?page=4&size=20
        last:
          type: string
          description: A URL link to the last page of requested data
          example: /api/v2/resource?page=6&size=20
      title: Page Links
  securitySchemes:
    API_Token:
      type: http
      name: Authorization
      in: header
      scheme: bearer
      bearerFormat: API Token
    basic:
      type: http
      name: Authorization
      in: header
      scheme: basic
      bearerFormat: basic
externalDocs:
  description: Developer Portal
  url: https://www.logicgate.com/developer/