LogicGate Application API

openapi: 3.1.0
info:
  title: Risk Cloud Access Audit Application 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: Application
  description: An [Application](https://help.logicgate.com/hc/en-us/articles/4402674055572-Create-a-new-Application) is a collection of Workflows, Steps, and logic that collectively solve a business use case
paths:
  /api/v2/applications:
    get:
      tags:
      - Application
      summary: Retrieve applications
      description: '**Permissions:** [Build Access](https://help.logicgate.com/hc/en-us/articles/4402683190164-Control-Build-Access-for-Applications)


        Retrieve a page of all applications that the current user has [Build Access](https://help.logicgate.com/hc/en-us/articles/4402683190164-Control-Build-Access-for-Applications) to.'
      operationId: readAllApplications
      parameters:
      - 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: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PageModelOutApplicationApiOut'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AppStatusResponse'
      x-beta: 'true'
    post:
      tags:
      - Application
      summary: Create an application
      description: '**Permissions:** [Build Access](https://help.logicgate.com/hc/en-us/articles/4402683190164-Control-Build-Access-for-Applications)


        Create an application from a JSON request body.'
      operationId: createApplication
      parameters:
      - 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}
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ApplicationApiCreateIn'
        required: true
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApplicationApiOut'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AppBadRequestResponse'
      x-beta: 'true'
  /api/v2/applications/{id}:
    get:
      tags:
      - Application
      summary: Retrieve an application
      description: '**Permissions:** [Build Access to application](https://help.logicgate.com/hc/en-us/articles/4402683190164-Control-Build-Access-for-Applications)


        Retrieve an application specified by the ID in the URL path.'
      operationId: readApplication
      parameters:
      - name: id
        in: path
        description: The unique ID of the application
        required: true
        schema:
          type: string
      - 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: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApplicationApiOut'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AppBadRequestResponse'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AppBadRequestResponse'
      x-beta: 'true'
    delete:
      tags:
      - Application
      summary: Delete an application
      description: '**Permissions:** [Build Access to application](https://help.logicgate.com/hc/en-us/articles/4402683190164-Control-Build-Access-for-Applications)


        Delete an application specified by the ID in the URL path.'
      operationId: deleteApplication
      parameters:
      - name: id
        in: path
        description: The unique ID of the application
        required: true
        schema:
          type: string
      - 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:
        '204':
          description: No Content
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AppBadRequestResponse'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AppStatusResponse'
      x-beta: 'true'
    patch:
      tags:
      - Application
      summary: Update an application
      description: '**Permissions:** [Build Access to application](https://help.logicgate.com/hc/en-us/articles/4402683190164-Control-Build-Access-for-Applications)


        Update an application specified by the ID in the URL path from a JSON request body. Only present properties with non-empty values are updated.'
      operationId: update_1
      parameters:
      - name: id
        in: path
        description: The unique ID of the application
        required: true
        schema:
          type: string
      - 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}
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ApplicationApiUpdateIn'
        required: true
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApplicationApiOut'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AppBadRequestResponse'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AppStatusResponse'
      x-beta: 'true'
components:
  schemas:
    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
    ApplicationApiUpdateIn:
      type: object
      properties:
        name:
          type: string
          description: The name of the application
          example: Cyber Risk Management Application
        description:
          type: string
          description: The description of the application
          example: Cyber Risk Management Description Text
        color:
          type: string
          description: The hex representation of the icon color of the application
          example: '#00a3de'
        icon:
          type: string
          description: The icon type of the application
          enum:
          - BOOKMARK
          - BOLT
          - BULLHORN
          - CERTIFICATE
          - CHECK_SQUARE_O
          - CLOUD
          - COMMENTS
          - CUBES
          - DOLLAR
          - EXCLAMATION_TRIANGLE
          - TEXT_O
          - FOLDER
          - GIFT
          - GLOBE
          - HEARTBEAT
          - LEAF
          - LEGAL
          - LIFE_RING
          - MEDKIT
          - MONEY
          - PERCENT
          - ROCKET
          - SIGNAL
          - UNIVERSITY
          - USER_CIRCLE
          example: CUBES
        type:
          type: string
          description: The type of Risk Cloud application
          enum:
          - ACCESS_MANAGEMENT
          - AML_KYC
          - ASSET_MANAGEMENT
          - AUDIT_MANAGEMENT
          - BUSINESS_CONTINUITY_PLANNING
          - CHANGE_MANAGEMENT
          - COMPLAINT_MANAGEMENT
          - COMPLIANCE_MANAGEMENT
          - CONTRACT_MANAGEMENT
          - CONTROLS_COMPLIANCE
          - CONTROLS_MANAGEMENT
          - CRISIS_MANAGEMENT
          - CUSTOM
          - CUSTOM_GRC_USE_CASE
          - CYBER_RISK_MANAGEMENT
          - DATA_PRIVACY_MANAGEMENT
          - EMPLOYEE_COMPLIANCE
          - ENTERPRISE_RISK_MANAGEMENT
          - ESG
          - INCIDENT_MANAGEMENT
          - INTERNAL_AUDIT_MANAGEMENT
          - IT_RISK_MANAGEMENT
          - NONE
          - OPERATIONAL_RESILIENCY
          - OTHER
          - POLICY_AND_PROCEDURE_MANAGEMENT
          - POLICY_MANAGEMENT
          - PRIVACY_MANAGEMENT
          - QUANTIFY
          - REGULATORY_COMPLIANCE
          - REPOSITORY
          - RISK_QUANTIFICATION
          - SOX_TESTING
          - STANDARDS_REGULATIONS
          - SURVEY
          - THIRD_PARTY_RISK_MANAGEMENT
          example: CONTROLS_COMPLIANCE
        live:
          type: boolean
          description: Whether the application is live
          example: false
        restrictBuildAccess:
          type: boolean
          description: Whether users with the Build entitlement must be explicitly granted permission to edit this application
          example: false
        shortCode:
          type: string
          description: Short display code for the application
          example: TPRM
          pattern: ^(?! +$)[a-zA-Z0-9 ]{1,10}$
      title: Application (Update)
    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
    AppBadRequestResponse:
      type: object
      properties:
        property:
          type: string
        value:
          type: string
        message:
          type: string
    ApplicationApiCreateIn:
      type: object
      properties:
        name:
          type: string
          description: The name of the application
          example: Cyber Risk Management Application
          minLength: 1
        description:
          type: string
          description: The description of the application
          example: Cyber Risk Management Description Text
        color:
          type: string
          description: 'The hex representation of the icon color of the application (defaults to #00a3de)'
          example: '#00a3de'
        icon:
          type: string
          description: The icon type of the application (defaults to CUBES)
          enum:
          - BOOKMARK
          - BOLT
          - BULLHORN
          - CERTIFICATE
          - CHECK_SQUARE_O
          - CLOUD
          - COMMENTS
          - CUBES
          - DOLLAR
          - EXCLAMATION_TRIANGLE
          - TEXT_O
          - FOLDER
          - GIFT
          - GLOBE
          - HEARTBEAT
          - LEAF
          - LEGAL
          - LIFE_RING
          - MEDKIT
          - MONEY
          - PERCENT
          - ROCKET
          - SIGNAL
          - UNIVERSITY
          - USER_CIRCLE
          example: CUBES
        type:
          type: string
          description: The type of Risk Cloud application (defaults to NONE)
          enum:
          - ACCESS_MANAGEMENT
          - AML_KYC
          - ASSET_MANAGEMENT
          - AUDIT_MANAGEMENT
          - BUSINESS_CONTINUITY_PLANNING
          - CHANGE_MANAGEMENT
          - COMPLAINT_MANAGEMENT
          - COMPLIANCE_MANAGEMENT
          - CONTRACT_MANAGEMENT
          - CONTROLS_COMPLIANCE
          - CONTROLS_MANAGEMENT
          - CRISIS_MANAGEMENT
          - CUSTOM
          - CUSTOM_GRC_USE_CASE
          - CYBER_RISK_MANAGEMENT
          - DATA_PRIVACY_MANAGEMENT
          - EMPLOYEE_COMPLIANCE
          - ENTERPRISE_RISK_MANAGEMENT
          - ESG
          - INCIDENT_MANAGEMENT
          - INTERNAL_AUDIT_MANAGEMENT
          - IT_RISK_MANAGEMENT
          - NONE
          - OPERATIONAL_RESILIENCY
          - OTHER
          - POLICY_AND_PROCEDURE_MANAGEMENT
          - POLICY_MANAGEMENT
          - PRIVACY_MANAGEMENT
          - QUANTIFY
          - REGULATORY_COMPLIANCE
          - REPOSITORY
          - RISK_QUANTIFICATION
          - SOX_TESTING
          - STANDARDS_REGULATIONS
          - SURVEY
          - THIRD_PARTY_RISK_MANAGEMENT
          example: CONTROLS_COMPLIANCE
        shortCode:
          type: string
          description: Short display code for the application
          example: TPRM
          pattern: ^(?! +$)[a-zA-Z0-9 ]{1,10}$
      required:
      - name
      title: Application (Create)
    ApplicationApiOut:
      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 application
          example: Cyber Risk Management Application
        description:
          type: string
          description: The description of the application
          example: Cyber Risk Management Description Text
        color:
          type: string
          description: The hex representation of the icon color of the application
          example: '#00a3de'
        icon:
          type: string
          description: The icon type of the application
          enum:
          - BOOKMARK
          - BOLT
          - BULLHORN
          - CERTIFICATE
          - CHECK_SQUARE_O
          - CLOUD
          - COMMENTS
          - CUBES
          - DOLLAR
          - EXCLAMATION_TRIANGLE
          - TEXT_O
          - FOLDER
          - GIFT
          - GLOBE
          - HEARTBEAT
          - LEAF
          - LEGAL
          - LIFE_RING
          - MEDKIT
          - MONEY
          - PERCENT
          - ROCKET
          - SIGNAL
          - UNIVERSITY
          - USER_CIRCLE
          example: CUBES
        type:
          type: string
          description: The type of Risk Cloud application
          enum:
          - ACCESS_MANAGEMENT
          - AML_KYC
          - ASSET_MANAGEMENT
          - AUDIT_MANAGEMENT
          - BUSINESS_CONTINUITY_PLANNING
          - CHANGE_MANAGEMENT
          - COMPLAINT_MANAGEMENT
          - COMPLIANCE_MANAGEMENT
          - CONTRACT_MANAGEMENT
          - CONTROLS_COMPLIANCE
          - CONTROLS_MANAGEMENT
          - CRISIS_MANAGEMENT
          - CUSTOM
          - CUSTOM_GRC_USE_CASE
          - CYBER_RISK_MANAGEMENT
          - DATA_PRIVACY_MANAGEMENT
          - EMPLOYEE_COMPLIANCE
          - ENTERPRISE_RISK_MANAGEMENT
          - ESG
          - INCIDENT_MANAGEMENT
          - INTERNAL_AUDIT_MANAGEMENT
          - IT_RISK_MANAGEMENT
          - NONE
          - OPERATIONAL_RESILIENCY
          - OTHER
          - POLICY_AND_PROCEDURE_MANAGEMENT
          - POLICY_MANAGEMENT
          - PRIVACY_MANAGEMENT
          - QUANTIFY
          - REGULATORY_COMPLIANCE
          - REPOSITORY
          - RISK_QUANTIFICATION
          - SOX_TESTING
          - STANDARDS_REGULATIONS
          - SURVEY
          - THIRD_PARTY_RISK_MANAGEMENT
          example: CONTROLS_COMPLIANCE
        live:
          type: boolean
          description: Whether the application is live
          example: false
        restrictBuildAccess:
          type: boolean
          description: Whether users with the Build entitlement must be explicitly granted permission to edit this application
          example: false
        shortCode:
          type: string
          description: Short display code for the application
          example: TPRM
        object:
          type: string
          description: Identifies the type of object this data represents
          example: application
      title: Application (Response)
    AppStatusResponse:
      type: object
      properties:
        status:
          type: string
        message:
          type: string
    PageModelOutApplicationApiOut:
      type: object
      properties:
        content:
          type: array
          description: A array of returned items
          items:
            $ref: '#/components/schemas/ApplicationApiOut'
        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)
  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/