Snyk API — TenantRole

naftiko: 1.0.0-alpha2
info:
  label: Snyk API — TenantRole
  description: 'Snyk API — TenantRole. 5 operations. Lead operation: List all available roles for a given tenant (Early Access).
    Self-contained Naftiko capability covering one Snyk business surface.'
  tags:
  - Snyk
  - TenantRole
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    SNYK_API_KEY: SNYK_API_KEY
capability:
  consumes:
  - type: http
    namespace: rest-tenantrole
    baseUri: https://api.snyk.io/rest
    description: Snyk API — TenantRole business capability. Self-contained, no shared references.
    resources:
    - name: tenants-tenant_id-roles
      path: /tenants/{tenant_id}/roles
      operations:
      - name: listtenantroles
        method: GET
        description: List all available roles for a given tenant (Early Access)
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: tenant_id
          in: path
          type: string
          description: Unique identifier of the tenant.
          required: true
        - name: name
          in: query
          type: string
          description: Role name filter.
      - name: createtenantrole
        method: POST
        description: Create a custom tenant role for a given tenant (Early Access)
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: tenant_id
          in: path
          type: string
          description: Unique identifier of the tenant.
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
    - name: tenants-tenant_id-roles-role_id
      path: /tenants/{tenant_id}/roles/{role_id}
      operations:
      - name: deletetenantrole
        method: DELETE
        description: Delete a specific tenant role by its id and its tenant id. (Early Access)
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: tenant_id
          in: path
          type: string
          description: Unique identifier of the tenant.
          required: true
      - name: gettenantrole
        method: GET
        description: Return a specific role by its id and its tenant id. (Early Access)
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: tenant_id
          in: path
          type: string
          description: Unique identifier of the tenant.
          required: true
      - name: updatetenantrole
        method: PATCH
        description: Update a specific tenant role by its id and its tenant id. (Early Access)
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: tenant_id
          in: path
          type: string
          description: Unique identifier of the tenant.
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
    authentication:
      type: bearer
      token: '{{env.SNYK_API_KEY}}'
  exposes:
  - type: rest
    namespace: rest-tenantrole-rest
    port: 8080
    description: REST adapter for Snyk API — TenantRole. One Spectral-compliant resource per consumed operation, prefixed
      with /v1.
    resources:
    - path: /v1/tenants/{tenant-id}/roles
      name: tenants-tenant-id-roles
      description: REST surface for tenants-tenant_id-roles.
      operations:
      - method: GET
        name: listtenantroles
        description: List all available roles for a given tenant (Early Access)
        call: rest-tenantrole.listtenantroles
        with:
          tenant_id: rest.tenant_id
          name: rest.name
        outputParameters:
        - type: object
          mapping: $.
      - method: POST
        name: createtenantrole
        description: Create a custom tenant role for a given tenant (Early Access)
        call: rest-tenantrole.createtenantrole
        with:
          tenant_id: rest.tenant_id
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/tenants/{tenant-id}/roles/{role-id}
      name: tenants-tenant-id-roles-role-id
      description: REST surface for tenants-tenant_id-roles-role_id.
      operations:
      - method: DELETE
        name: deletetenantrole
        description: Delete a specific tenant role by its id and its tenant id. (Early Access)
        call: rest-tenantrole.deletetenantrole
        with:
          tenant_id: rest.tenant_id
        outputParameters:
        - type: object
          mapping: $.
      - method: GET
        name: gettenantrole
        description: Return a specific role by its id and its tenant id. (Early Access)
        call: rest-tenantrole.gettenantrole
        with:
          tenant_id: rest.tenant_id
        outputParameters:
        - type: object
          mapping: $.
      - method: PATCH
        name: updatetenantrole
        description: Update a specific tenant role by its id and its tenant id. (Early Access)
        call: rest-tenantrole.updatetenantrole
        with:
          tenant_id: rest.tenant_id
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: rest-tenantrole-mcp
    port: 9090
    transport: http
    description: MCP adapter for Snyk API — TenantRole. One tool per consumed operation, routed inline through this capability's
      consumes block.
    tools:
    - name: list-all-available-roles-given
      description: List all available roles for a given tenant (Early Access)
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: rest-tenantrole.listtenantroles
      with:
        tenant_id: tools.tenant_id
        name: tools.name
      outputParameters:
      - type: object
        mapping: $.
    - name: create-custom-tenant-role-given
      description: Create a custom tenant role for a given tenant (Early Access)
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: rest-tenantrole.createtenantrole
      with:
        tenant_id: tools.tenant_id
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: delete-specific-tenant-role-its
      description: Delete a specific tenant role by its id and its tenant id. (Early Access)
      hints:
        readOnly: false
        destructive: true
        idempotent: true
      call: rest-tenantrole.deletetenantrole
      with:
        tenant_id: tools.tenant_id
      outputParameters:
      - type: object
        mapping: $.
    - name: return-specific-role-its-id
      description: Return a specific role by its id and its tenant id. (Early Access)
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: rest-tenantrole.gettenantrole
      with:
        tenant_id: tools.tenant_id
      outputParameters:
      - type: object
        mapping: $.
    - name: update-specific-tenant-role-its
      description: Update a specific tenant role by its id and its tenant id. (Early Access)
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: rest-tenantrole.updatetenantrole
      with:
        tenant_id: tools.tenant_id
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.