Gravitee.io - Access Management API — scope

naftiko: 1.0.0-alpha2
info:
  label: Gravitee.io - Access Management API — scope
  description: 'Gravitee.io - Access Management API — scope. 6 operations. Lead operation: List scopes for a security domain.
    Self-contained Naftiko capability covering one Gravitee business surface.'
  tags:
  - Gravitee
  - scope
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    GRAVITEE_API_KEY: GRAVITEE_API_KEY
capability:
  consumes:
  - type: http
    namespace: am-scope
    baseUri: ''
    description: Gravitee.io - Access Management API — scope business capability. Self-contained, no shared references.
    resources:
    - name: organizations-organizationId-environments-environmentId-domains-domain-scopes
      path: /organizations/{organizationId}/environments/{environmentId}/domains/{domain}/scopes
      operations:
      - name: listscopes
        method: GET
        description: List scopes 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: createscope
        method: POST
        description: Create a scope
        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-scopes-sc
      path: /organizations/{organizationId}/environments/{environmentId}/domains/{domain}/scopes/{scope}
      operations:
      - name: findscope
        method: GET
        description: Get a scope
        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: scope
          in: path
          type: string
          required: true
      - name: updatescope
        method: PUT
        description: Update a scope
        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: scope
          in: path
          type: string
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
      - name: deletescope
        method: DELETE
        description: Delete a scope
        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: scope
          in: path
          type: string
          required: true
      - name: patchscope
        method: PATCH
        description: Patch a scope
        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: scope
          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-scope-rest
    port: 8080
    description: REST adapter for Gravitee.io - Access Management API — scope. One Spectral-compliant resource per consumed
      operation, prefixed with /v1.
    resources:
    - path: /v1/organizations/{organizationid}/environments/{environmentid}/domains/{domain}/scopes
      name: organizations-organizationid-environments-environmentid-domains-domain-scopes
      description: REST surface for organizations-organizationId-environments-environmentId-domains-domain-scopes.
      operations:
      - method: GET
        name: listscopes
        description: List scopes for a security domain
        call: am-scope.listscopes
        with:
          organizationId: rest.organizationId
          environmentId: rest.environmentId
          domain: rest.domain
          page: rest.page
          size: rest.size
          q: rest.q
        outputParameters:
        - type: object
          mapping: $.
      - method: POST
        name: createscope
        description: Create a scope
        call: am-scope.createscope
        with:
          organizationId: rest.organizationId
          environmentId: rest.environmentId
          domain: rest.domain
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/organizations/{organizationid}/environments/{environmentid}/domains/{domain}/scopes/{scope}
      name: organizations-organizationid-environments-environmentid-domains-domain-scopes-sc
      description: REST surface for organizations-organizationId-environments-environmentId-domains-domain-scopes-sc.
      operations:
      - method: GET
        name: findscope
        description: Get a scope
        call: am-scope.findscope
        with:
          organizationId: rest.organizationId
          environmentId: rest.environmentId
          domain: rest.domain
          scope: rest.scope
        outputParameters:
        - type: object
          mapping: $.
      - method: PUT
        name: updatescope
        description: Update a scope
        call: am-scope.updatescope
        with:
          organizationId: rest.organizationId
          environmentId: rest.environmentId
          domain: rest.domain
          scope: rest.scope
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
      - method: DELETE
        name: deletescope
        description: Delete a scope
        call: am-scope.deletescope
        with:
          organizationId: rest.organizationId
          environmentId: rest.environmentId
          domain: rest.domain
          scope: rest.scope
        outputParameters:
        - type: object
          mapping: $.
      - method: PATCH
        name: patchscope
        description: Patch a scope
        call: am-scope.patchscope
        with:
          organizationId: rest.organizationId
          environmentId: rest.environmentId
          domain: rest.domain
          scope: rest.scope
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: am-scope-mcp
    port: 9090
    transport: http
    description: MCP adapter for Gravitee.io - Access Management API — scope. One tool per consumed operation, routed inline
      through this capability's consumes block.
    tools:
    - name: list-scopes-security-domain
      description: List scopes for a security domain
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: am-scope.listscopes
      with:
        organizationId: tools.organizationId
        environmentId: tools.environmentId
        domain: tools.domain
        page: tools.page
        size: tools.size
        q: tools.q
      outputParameters:
      - type: object
        mapping: $.
    - name: create-scope
      description: Create a scope
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: am-scope.createscope
      with:
        organizationId: tools.organizationId
        environmentId: tools.environmentId
        domain: tools.domain
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: get-scope
      description: Get a scope
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: am-scope.findscope
      with:
        organizationId: tools.organizationId
        environmentId: tools.environmentId
        domain: tools.domain
        scope: tools.scope
      outputParameters:
      - type: object
        mapping: $.
    - name: update-scope
      description: Update a scope
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: am-scope.updatescope
      with:
        organizationId: tools.organizationId
        environmentId: tools.environmentId
        domain: tools.domain
        scope: tools.scope
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: delete-scope
      description: Delete a scope
      hints:
        readOnly: false
        destructive: true
        idempotent: true
      call: am-scope.deletescope
      with:
        organizationId: tools.organizationId
        environmentId: tools.environmentId
        domain: tools.domain
        scope: tools.scope
      outputParameters:
      - type: object
        mapping: $.
    - name: patch-scope
      description: Patch a scope
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: am-scope.patchscope
      with:
        organizationId: tools.organizationId
        environmentId: tools.environmentId
        domain: tools.domain
        scope: tools.scope
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.