Gravitee.io - Access Management API — application

naftiko: 1.0.0-alpha2
info:
  label: Gravitee.io - Access Management API — application
  description: 'Gravitee.io - Access Management API — application. 34 operations. Lead operation: List registered applications
    for a security domain. Self-contained Naftiko capability covering one Gravitee business surface.'
  tags:
  - Gravitee
  - application
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    GRAVITEE_API_KEY: GRAVITEE_API_KEY
capability:
  consumes:
  - type: http
    namespace: am-application
    baseUri: ''
    description: Gravitee.io - Access Management API — application business capability. Self-contained, no shared references.
    resources:
    - name: organizations-organizationId-environments-environmentId-domains-domain-applicati
      path: /organizations/{organizationId}/environments/{environmentId}/domains/{domain}/applications
      operations:
      - name: listapplications
        method: GET
        description: List registered applications for a security domain
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: organizationId
          in: path
          type: string
          required: true
        - name: environmentId
          in: path
          type: string
          required: true
        - name: domain
          in: path
          type: string
          required: true
        - name: page
          in: query
          type: integer
        - name: size
          in: query
          type: integer
        - name: q
          in: query
          type: string
        - name: expand
          in: query
          type: array
      - name: createapplication
        method: POST
        description: Create an application
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: organizationId
          in: path
          type: string
          required: true
        - name: environmentId
          in: path
          type: string
          required: true
        - name: domain
          in: path
          type: string
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: organizations-organizationId-environments-environmentId-domains-domain-applicati
      path: /organizations/{organizationId}/environments/{environmentId}/domains/{domain}/applications/{application}
      operations:
      - name: findapplication
        method: GET
        description: Get an application
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: organizationId
          in: path
          type: string
          required: true
        - name: environmentId
          in: path
          type: string
          required: true
        - name: domain
          in: path
          type: string
          required: true
        - name: application
          in: path
          type: string
          required: true
      - name: updateapplication
        method: PUT
        description: Update an application
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: organizationId
          in: path
          type: string
          required: true
        - name: environmentId
          in: path
          type: string
          required: true
        - name: domain
          in: path
          type: string
          required: true
        - name: application
          in: path
          type: string
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
      - name: deleteapplication
        method: DELETE
        description: Delete an application
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: organizationId
          in: path
          type: string
          required: true
        - name: environmentId
          in: path
          type: string
          required: true
        - name: domain
          in: path
          type: string
          required: true
        - name: application
          in: path
          type: string
          required: true
      - name: patchapplication
        method: PATCH
        description: Patch an application
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: organizationId
          in: path
          type: string
          required: true
        - name: environmentId
          in: path
          type: string
          required: true
        - name: domain
          in: path
          type: string
          required: true
        - name: application
          in: path
          type: string
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: organizations-organizationId-environments-environmentId-domains-domain-applicati
      path: /organizations/{organizationId}/environments/{environmentId}/domains/{domain}/applications/{application}/analytics
      operations:
      - name: getapplicationanalytics
        method: GET
        description: Find application analytics
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: organizationId
          in: path
          type: string
          required: true
        - name: environmentId
          in: path
          type: string
          required: true
        - name: domain
          in: path
          type: string
          required: true
        - name: application
          in: path
          type: string
          required: true
        - name: from
          in: query
          type: integer
          description: Used to define the start date of the time window to query
        - name: to
          in: query
          type: integer
          description: Used to define the end date of the time window to query
        - name: interval
          in: query
          type: integer
          description: The time interval when getting histogram data
        - name: size
          in: query
          type: integer
          description: The number of data to retrieve
        - name: type
          in: query
          type: string
          description: The type of data to retrieve (group_by, date_histo, count)
          required: true
        - name: field
          in: query
          type: string
    - name: organizations-organizationId-environments-environmentId-domains-domain-applicati
      path: /organizations/{organizationId}/environments/{environmentId}/domains/{domain}/applications/{application}/emails
      operations:
      - name: findapplicationemail
        method: GET
        description: Find a email for an application
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: organizationId
          in: path
          type: string
          required: true
        - name: environmentId
          in: path
          type: string
          required: true
        - name: domain
          in: path
          type: string
          required: true
        - name: application
          in: path
          type: string
          required: true
        - name: template
          in: query
          type: string
          required: true
      - name: createapplicationemail
        method: POST
        description: Create a email for an application
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: organizationId
          in: path
          type: string
          required: true
        - name: environmentId
          in: path
          type: string
          required: true
        - name: domain
          in: path
          type: string
          required: true
        - name: application
          in: path
          type: string
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: organizations-organizationId-environments-environmentId-domains-domain-applicati
      path: /organizations/{organizationId}/environments/{environmentId}/domains/{domain}/applications/{application}/emails/{email}
      operations:
      - name: updateapplicationemail
        method: PUT
        description: Update an email for an application
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: organizationId
          in: path
          type: string
          required: true
        - name: environmentId
          in: path
          type: string
          required: true
        - name: domain
          in: path
          type: string
          required: true
        - name: application
          in: path
          type: string
          required: true
        - name: email
          in: path
          type: string
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
      - name: deleteapplicationemail
        method: DELETE
        description: Delete an email for an application
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: organizationId
          in: path
          type: string
          required: true
        - name: environmentId
          in: path
          type: string
          required: true
        - name: domain
          in: path
          type: string
          required: true
        - name: application
          in: path
          type: string
          required: true
        - name: email
          in: path
          type: string
          required: true
    - name: organizations-organizationId-environments-environmentId-domains-domain-applicati
      path: /organizations/{organizationId}/environments/{environmentId}/domains/{domain}/applications/{application}/flows
      operations:
      - name: listappflows
        method: GET
        description: List registered flows for an application
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: organizationId
          in: path
          type: string
          required: true
        - name: environmentId
          in: path
          type: string
          required: true
        - name: domain
          in: path
          type: string
          required: true
        - name: application
          in: path
          type: string
          required: true
      - name: defineappflows
        method: PUT
        description: Create or update list of flows
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: organizationId
          in: path
          type: string
          required: true
        - name: environmentId
          in: path
          type: string
          required: true
        - name: domain
          in: path
          type: string
          required: true
        - name: application
          in: path
          type: string
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: organizations-organizationId-environments-environmentId-domains-domain-applicati
      path: /organizations/{organizationId}/environments/{environmentId}/domains/{domain}/applications/{application}/flows/{flow}
      operations:
      - name: getappflow
        method: GET
        description: Get a flow
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: organizationId
          in: path
          type: string
          required: true
        - name: environmentId
          in: path
          type: string
          required: true
        - name: domain
          in: path
          type: string
          required: true
        - name: application
          in: path
          type: string
          required: true
        - name: flow
          in: path
          type: string
          required: true
      - name: updateappflow
        method: PUT
        description: Update a flow
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: organizationId
          in: path
          type: string
          required: true
        - name: environmentId
          in: path
          type: string
          required: true
        - name: domain
          in: path
          type: string
          required: true
        - name: application
          in: path
          type: string
          required: true
        - name: flow
          in: path
          type: string
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: organizations-organizationId-environments-environmentId-domains-domain-applicati
      path: /organizations/{organizationId}/environments/{environmentId}/domains/{domain}/applications/{application}/forms
      operations:
      - name: findapplicationform
        method: GET
        description: Find a form for an application
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: organizationId
          in: path
          type: string
          required: true
        - name: environmentId
          in: path
          type: string
          required: true
        - name: domain
          in: path
          type: string
          required: true
        - name: application
          in: path
          type: string
          required: true
        - name: template
          in: query
          type: string
          required: true
      - name: createapplicationform
        method: POST
        description: Create a form for an application
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: organizationId
          in: path
          type: string
          required: true
        - name: environmentId
          in: path
          type: string
          required: true
        - name: domain
          in: path
          type: string
          required: true
        - name: application
          in: path
          type: string
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: organizations-organizationId-environments-environmentId-domains-domain-applicati
      path: /organizations/{organizationId}/environments/{environmentId}/domains/{domain}/applications/{application}/forms/{form}
      operations:
      - name: updateapplicationform
        method: PUT
        description: Update a form for an application
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: organizationId
          in: path
          type: string
          required: true
        - name: environmentId
          in: path
          type: string
          required: true
        - name: domain
          in: path
          type: string
          required: true
        - name: application
          in: path
          type: string
          required: true
        - name: form
          in: path
          type: string
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
      - name: deleteapplicationform
        method: DELETE
        description: Delete a form for an application
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: organizationId
          in: path
          type: string
          required: true
        - name: environmentId
          in: path
          type: string
          required: true
        - name: domain
          in: path
          type: string
          required: true
        - name: application
          in: path
          type: string
          required: true
        - name: form
          in: path
          type: string
          required: true
    - name: organizations-organizationId-environments-environmentId-domains-domain-applicati
      path: /organizations/{organizationId}/environments/{environmentId}/domains/{domain}/applications/{application}/members
      operations:
      - name: getmembers
        method: GET
        description: List members for an application
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: organizationId
          in: path
          type: string
          required: true
        - name: environmentId
          in: path
          type: string
          required: true
        - name: domain
          in: path
          type: string
          required: true
        - name: application
          in: path
          type: string
          required: true
      - name: addorupdatemember
        method: POST
        description: Add or update an application member
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: organizationId
          in: path
          type: string
          required: true
        - name: environmentId
          in: path
          type: string
          required: true
        - name: domain
          in: path
          type: string
          required: true
        - name: application
          in: path
          type: string
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: organizations-organizationId-environments-environmentId-domains-domain-applicati
      path: /organizations/{organizationId}/environments/{environmentId}/domains/{domain}/applications/{application}/members/permissions
      operations:
      - name: getapplicationmemberpermissions
        method: GET
        description: List application member's permissions
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: organizationId
          in: path
          type: string
          required: true
        - name: environmentId
          in: path
          type: string
          required: true
        - name: domain
          in: path
          type: string
          required: true
        - name: application
          in: path
          type: string
          required: true
    - name: organizations-organizationId-environments-environmentId-domains-domain-applicati
      path: /organizations/{organizationId}/environments/{environmentId}/domains/{domain}/applications/{application}/members/{member}
      operations:
      - name: removeapplicationmember
        method: DELETE
        description: Remove a membership
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: organizationId
          in: path
          type: string
          required: true
        - name: environmentId
          in: path
          type: string
          required: true
        - name: domain
          in: path
          type: string
          required: true
        - name: application
          in: path
          type: string
          required: true
        - name: member
          in: path
          type: string
          required: true
    - name: organizations-organizationId-environments-environmentId-domains-domain-applicati
      path: /organizations/{organizationId}/environments/{environmentId}/domains/{domain}/applications/{application}/resources
      operations:
      - name: listapplicationresources
        method: GET
        description: List resources for an application
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: organizationId
          in: path
          type: string
          required: true
        - name: environmentId
          in: path
          type: string
          required: true
        - name: domain
          in: path
          type: string
          required: true
        - name: application
          in: path
          type: string
          required: true
        - name: page
          in: query
          type: integer
        - name: size
          in: query
          type: integer
    - name: organizations-organizationId-environments-environmentId-domains-domain-applicati
      path: /organizations/{organizationId}/environments/{environmentId}/domains/{domain}/applications/{application}/resources/{resource}
      operations:
      - name: getapplicationresource
        method: GET
        description: Get a resource for an application
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: organizationId
          in: path
          type: string
          required: true
        - name: environmentId
          in: path
          type: string
          required: true
        - name: domain
          in: path
          type: string
          required: true
        - name: application
          in: path
          type: string
          required: true
        - name: resource
          in: path
          type: string
          required: true
    - name: organizations-organizationId-environments-environmentId-domains-domain-applicati
      path: /organizations/{organizationId}/environments/{environmentId}/domains/{domain}/applications/{application}/resources/{resource}/policies
      operations:
      - name: listapplicationpolicies
        method: GET
        description: Get resource access policies
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: organizationId
          in: path
          type: string
          required: true
        - name: environmentId
          in: path
          type: string
          required: true
        - name: domain
          in: path
          type: string
          required: true
        - name: application
          in: path
          type: string
          required: true
        - name: resource
          in: path
          type: string
          required: true
    - name: organizations-organizationId-environments-environmentId-domains-domain-applicati
      path: /organizations/{organizationId}/environments/{environmentId}/domains/{domain}/applications/{application}/resources/{resource}/policies/{policy}
      operations:
      - name: getapplicationresourcepolicy
        method: GET
        description: Get resource access policy
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: organizationId
          in: path
          type: string
          required: true
        - name: environmentId
          in: path
          type: string
          required: true
        - name: domain
          in: path
          type: string
          required: true
        - name: application
          in: path
          type: string
          required: true
        - name: resource
          in: path
          type: string
          required: true
        - name: policy
          in: path
          type: string
          required: true
    - name: organizations-organizationId-environments-environmentId-domains-domain-applicati
      path: /organizations/{organizationId}/environments/{environmentId}/domains/{domain}/applications/{application}/secrets
      operations:
      - name: listsecrets
        method: GET
        description: List secrets of an application
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: organizationId
          in: path
          type: string
          required: true
        - name: environmentId
          in: path
          type: string
          required: true
        - name: domain
          in: path
          type: string
          required: true
        - name: application
          in: path
          type: string
          required: true
      - name: createsecret
        method: POST
        description: Create a secret for an application
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: organizationId
          in: path
          type: string
          required: true
        - name: environmentId
          in: path
          type: string
          required: true
        - name: domain
          in: path
          type: string
          required: true
        - name: application
          in: path
          type: string
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: organizations-organizationId-environments-environmentId-domains-domain-applicati
      path: /organizations/{organizationId}/environments/{environmentId}/domains/{domain}/applications/{application}/secrets/{secret}
      operations:
      - name: deleteclientsecret
        method: DELETE
        description: Delete a secret of an application
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: organizationId
          in: path
          type: string
          required: true
        - name: environmentId
          in: path
          type: string
          required: true
        - name: domain
          in: path
          type: string
          required: true
        - name: application
          in: path
          type: string
          required: true
        - name: secret
          in: path
          type: string
          required: true
    - name: organizations-organizationId-environments-environmentId-domains-domain-applicati
      path: /organizations/{organizationId}/environments/{environmentId}/domains/{domain}/applications/{application}/secrets/{secret}/_renew
      operations:
      - name: renewclientsecret
        method: POST
        description: Renew application secret
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: organizationId
          in: path
          type: string
          required: true
        - name: environmentId
          in: path
          type: string
          required: true
        - name: domain
          in: path
          type: string
          required: true
        - name: application
          in: path
          type: string
          required: true
        - name: secret
          in: path
          type: string
          required: true
    - name: organizations-organizationId-environments-environmentId-domains-domain-applicati
      path: /organizations/{organizationId}/environments/{environmentId}/domains/{domain}/applications/{application}/type
      operations:
      - name: updateapplicationtype
        method: PUT
        description: Update an application type
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: organizationId
          in: path
          type: string
          required: true
        - name: environmentId
          in: path
          type: string
          required: true
        - name: domain
          in: path
          type: string
          required: true
        - name: application
          in: path
          type: string
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: organizations-organizationId-environments-environmentId-domains-domain-cimd-appl
      path: /organizations/{organizationId}/environments/{environmentId}/domains/{domain}/cimd/applications
      operations:
      - name: createapplicationfromcimd
        method: POST
        description: Create an application from a CIMD document URL
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: organizationId
          in: path
          type: string
          required: true
        - name: environmentId
          in: path
          type: string
          required: true
        - name: domain
          in: path
          type: string
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: organizations-organizationId-environments-environmentId-domains-domain-cimd-vali
      path: /organizations/{organizationId}/environments/{environmentId}/domains/{domain}/cimd/validate
      operations:
      - name: validatecimdurl
        method: POST
        description: Validate a CIMD URL and return parsed metadata preview
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: organizationId
          in: path
          type: string
          required: true
        - name: environmentId
          in: path
          type: string
          required: true
        - name: domain
          in: path
          type: string
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    authentication:
      type: bearer
      token: '{{env.GRAVITEE_API_KEY}}'
  exposes:
  - type: rest
    namespace: am-application-rest
    port: 8080
    description: REST adapter for Gravitee.io - Access Management API — application. One Spectral-compliant resource per consumed
      operation, prefixed with /v1.
    resources:
    - path: /v1/organizations/{organizationid}/environments/{environmentid}/domains/{domain}/applications
      name: organizations-organizationid-environments-environmentid-domains-domain-applicati
      description: REST surface for organizations-organizationId-environments-environmentId-domains-domain-applicati.
      operations:
      - method: GET
        name: listapplications
        description: List registered applications for a security domain
        call: am-application.listapplications
        with:
          organizationId: rest.organizationId
          environmentId: rest.environmentId
          domain: rest.domain
          page: rest.page
          size: rest.size
          q: rest.q
          expand: rest.expand
        outputParameters:
        - type: object
          mapping: $.
      - method: POST
        name: createapplication
        description: Create an application
        call: am-application.createapplication
  

# --- truncated at 32 KB (69 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/gravitee/refs/heads/main/capabilities/am-application.yaml