NetBird · Capability

NetBird REST API — Identity Providers

NetBird REST API — Identity Providers. 5 operations. Lead operation: List all Identity Providers. Self-contained Naftiko capability covering one Netbird business surface.

Run with Naftiko NetbirdIdentity Providers

What You Can Do

GET

Get — List all Identity Providers

/v1/api/identity-providers

POST

Post — Create an Identity Provider

/v1/api/identity-providers

GET

Get — Retrieve an Identity Provider

/v1/api/identity-providers/{idpid}

PUT

Put — Update an Identity Provider

/v1/api/identity-providers/{idpid}

DELETE

Delete — Delete an Identity Provider

/v1/api/identity-providers/{idpid}

MCP Tools

list-all-identity-providers

List all Identity Providers

read-only idempotent

create-identity-provider

Create an Identity Provider

retrieve-identity-provider

Retrieve an Identity Provider

read-only idempotent

update-identity-provider

Update an Identity Provider

idempotent

delete-identity-provider

Delete an Identity Provider

idempotent

Capability Spec

naftiko: 1.0.0-alpha2
info:
  label: NetBird REST API — Identity Providers
  description: 'NetBird REST API — Identity Providers. 5 operations. Lead operation: List all Identity Providers. Self-contained
    Naftiko capability covering one Netbird business surface.'
  tags:
  - Netbird
  - Identity Providers
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    NETBIRD_API_KEY: NETBIRD_API_KEY
capability:
  consumes:
  - type: http
    namespace: netbird-identity-providers
    baseUri: https://api.netbird.io
    description: NetBird REST API — Identity Providers business capability. Self-contained, no shared references.
    resources:
    - name: api-identity-providers
      path: /api/identity-providers
      operations:
      - name: get
        method: GET
        description: List all Identity Providers
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: post
        method: POST
        description: Create an Identity Provider
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
    - name: api-identity-providers-idpId
      path: /api/identity-providers/{idpId}
      operations:
      - name: get
        method: GET
        description: Retrieve an Identity Provider
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: idpId
          in: path
          type: string
          description: The unique identifier of an identity provider
          required: true
      - name: put
        method: PUT
        description: Update an Identity Provider
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: idpId
          in: path
          type: string
          description: The unique identifier of an identity provider
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
      - name: delete
        method: DELETE
        description: Delete an Identity Provider
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: idpId
          in: path
          type: string
          description: The unique identifier of an identity provider
          required: true
    authentication:
      type: bearer
      token: '{{env.NETBIRD_API_KEY}}'
  exposes:
  - type: rest
    namespace: netbird-identity-providers-rest
    port: 8080
    description: REST adapter for NetBird REST API — Identity Providers. One Spectral-compliant resource per consumed operation,
      prefixed with /v1.
    resources:
    - path: /v1/api/identity-providers
      name: api-identity-providers
      description: REST surface for api-identity-providers.
      operations:
      - method: GET
        name: get
        description: List all Identity Providers
        call: netbird-identity-providers.get
        outputParameters:
        - type: object
          mapping: $.
      - method: POST
        name: post
        description: Create an Identity Provider
        call: netbird-identity-providers.post
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/api/identity-providers/{idpid}
      name: api-identity-providers-idpid
      description: REST surface for api-identity-providers-idpId.
      operations:
      - method: GET
        name: get
        description: Retrieve an Identity Provider
        call: netbird-identity-providers.get
        with:
          idpId: rest.idpId
        outputParameters:
        - type: object
          mapping: $.
      - method: PUT
        name: put
        description: Update an Identity Provider
        call: netbird-identity-providers.put
        with:
          idpId: rest.idpId
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
      - method: DELETE
        name: delete
        description: Delete an Identity Provider
        call: netbird-identity-providers.delete
        with:
          idpId: rest.idpId
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: netbird-identity-providers-mcp
    port: 9090
    transport: http
    description: MCP adapter for NetBird REST API — Identity Providers. One tool per consumed operation, routed inline through
      this capability's consumes block.
    tools:
    - name: list-all-identity-providers
      description: List all Identity Providers
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: netbird-identity-providers.get
      outputParameters:
      - type: object
        mapping: $.
    - name: create-identity-provider
      description: Create an Identity Provider
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: netbird-identity-providers.post
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: retrieve-identity-provider
      description: Retrieve an Identity Provider
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: netbird-identity-providers.get
      with:
        idpId: tools.idpId
      outputParameters:
      - type: object
        mapping: $.
    - name: update-identity-provider
      description: Update an Identity Provider
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: netbird-identity-providers.put
      with:
        idpId: tools.idpId
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: delete-identity-provider
      description: Delete an Identity Provider
      hints:
        readOnly: false
        destructive: true
        idempotent: true
      call: netbird-identity-providers.delete
      with:
        idpId: tools.idpId
      outputParameters:
      - type: object
        mapping: $.