API Reference — AuthProviderService

naftiko: 1.0.0-alpha2
info:
  label: API Reference — AuthProviderService
  description: 'API Reference — AuthProviderService. 8 operations. Lead operation: AuthProviderService. Self-contained Naftiko
    capability covering one Stackrox business surface.'
  tags:
  - Stackrox
  - AuthProviderService
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    STACKROX_API_KEY: STACKROX_API_KEY
capability:
  consumes:
  - type: http
    namespace: stackrox-authproviderservice
    baseUri: https://{central-host}
    description: API Reference — AuthProviderService business capability. Self-contained, no shared references.
    resources:
    - name: v1-authProviders
      path: /v1/authProviders
      operations:
      - name: getauthproviders
        method: GET
        description: ''
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: name
          in: query
          type: string
        - name: type
          in: query
          type: string
      - name: postauthprovider
        method: POST
        description: ''
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
    - name: v1-authProviders-exchangeToken
      path: /v1/authProviders/exchangeToken
      operations:
      - name: exchangetoken
        method: POST
        description: ''
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: v1-authProviders-id
      path: /v1/authProviders/{id}
      operations:
      - name: getauthprovider
        method: GET
        description: ''
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: id
          in: path
          type: string
          required: true
      - name: deleteauthprovider
        method: DELETE
        description: ''
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: id
          in: path
          type: string
          required: true
      - name: putauthprovider
        method: PUT
        description: ''
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: id
          in: path
          type: string
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
      - name: updateauthprovider
        method: PATCH
        description: ''
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: id
          in: path
          type: string
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: v1-login-authproviders
      path: /v1/login/authproviders
      operations:
      - name: getloginauthproviders
        method: GET
        description: ''
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    authentication:
      type: apikey
      key: Authorization
      value: '{{env.STACKROX_API_KEY}}'
      placement: header
  exposes:
  - type: rest
    namespace: stackrox-authproviderservice-rest
    port: 8080
    description: REST adapter for API Reference — AuthProviderService. One Spectral-compliant resource per consumed operation,
      prefixed with /v1.
    resources:
    - path: /v1/v1/authproviders
      name: v1-authproviders
      description: REST surface for v1-authProviders.
      operations:
      - method: GET
        name: getauthproviders
        description: getauthproviders
        call: stackrox-authproviderservice.getauthproviders
        with:
          name: rest.name
          type: rest.type
        outputParameters:
        - type: object
          mapping: $.
      - method: POST
        name: postauthprovider
        description: postauthprovider
        call: stackrox-authproviderservice.postauthprovider
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/v1/authproviders/exchangetoken
      name: v1-authproviders-exchangetoken
      description: REST surface for v1-authProviders-exchangeToken.
      operations:
      - method: POST
        name: exchangetoken
        description: exchangetoken
        call: stackrox-authproviderservice.exchangetoken
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/v1/authproviders/{id}
      name: v1-authproviders-id
      description: REST surface for v1-authProviders-id.
      operations:
      - method: GET
        name: getauthprovider
        description: getauthprovider
        call: stackrox-authproviderservice.getauthprovider
        with:
          id: rest.id
        outputParameters:
        - type: object
          mapping: $.
      - method: DELETE
        name: deleteauthprovider
        description: deleteauthprovider
        call: stackrox-authproviderservice.deleteauthprovider
        with:
          id: rest.id
        outputParameters:
        - type: object
          mapping: $.
      - method: PUT
        name: putauthprovider
        description: putauthprovider
        call: stackrox-authproviderservice.putauthprovider
        with:
          id: rest.id
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
      - method: PATCH
        name: updateauthprovider
        description: updateauthprovider
        call: stackrox-authproviderservice.updateauthprovider
        with:
          id: rest.id
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/v1/login/authproviders
      name: v1-login-authproviders
      description: REST surface for v1-login-authproviders.
      operations:
      - method: GET
        name: getloginauthproviders
        description: getloginauthproviders
        call: stackrox-authproviderservice.getloginauthproviders
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: stackrox-authproviderservice-mcp
    port: 9090
    transport: http
    description: MCP adapter for API Reference — AuthProviderService. One tool per consumed operation, routed inline through
      this capability's consumes block.
    tools:
    - name: getauthproviders
      description: getauthproviders
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: stackrox-authproviderservice.getauthproviders
      with:
        name: tools.name
        type: tools.type
      outputParameters:
      - type: object
        mapping: $.
    - name: postauthprovider
      description: postauthprovider
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: stackrox-authproviderservice.postauthprovider
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: exchangetoken
      description: exchangetoken
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: stackrox-authproviderservice.exchangetoken
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: getauthprovider
      description: getauthprovider
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: stackrox-authproviderservice.getauthprovider
      with:
        id: tools.id
      outputParameters:
      - type: object
        mapping: $.
    - name: deleteauthprovider
      description: deleteauthprovider
      hints:
        readOnly: false
        destructive: true
        idempotent: true
      call: stackrox-authproviderservice.deleteauthprovider
      with:
        id: tools.id
      outputParameters:
      - type: object
        mapping: $.
    - name: putauthprovider
      description: putauthprovider
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: stackrox-authproviderservice.putauthprovider
      with:
        id: tools.id
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: updateauthprovider
      description: updateauthprovider
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: stackrox-authproviderservice.updateauthprovider
      with:
        id: tools.id
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: getloginauthproviders
      description: getloginauthproviders
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: stackrox-authproviderservice.getloginauthproviders
      outputParameters:
      - type: object
        mapping: $.