RingCentral API — SCIM

naftiko: 1.0.0-alpha2
info:
  label: RingCentral API — SCIM
  description: 'RingCentral API — SCIM. 12 operations. Lead operation: List Resource Types. Self-contained Naftiko capability
    covering one Ringcentral business surface.'
  tags:
  - Ringcentral
  - SCIM
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    RINGCENTRAL_API_KEY: RINGCENTRAL_API_KEY
capability:
  consumes:
  - type: http
    namespace: platform-scim
    baseUri: https://platform.ringcentral.com
    description: RingCentral API — SCIM business capability. Self-contained, no shared references.
    resources:
    - name: scim-v2-ResourceTypes
      path: /scim/v2/ResourceTypes
      operations:
      - name: scimlistresourcetypes2
        method: GET
        description: List Resource Types
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: scim-v2-ResourceTypes-type
      path: /scim/v2/ResourceTypes/{type}
      operations:
      - name: scimgetresourcetype2
        method: GET
        description: Get Resource Type
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: type
          in: path
          type: string
          description: Resource type
          required: true
    - name: scim-v2-Schemas
      path: /scim/v2/Schemas
      operations:
      - name: scimlistschemas2
        method: GET
        description: List Schemas
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: scim-v2-Schemas-uri
      path: /scim/v2/Schemas/{uri}
      operations:
      - name: scimgetschema2
        method: GET
        description: Get Schema
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: uri
          in: path
          type: string
          description: Schema URI
          required: true
    - name: scim-v2-ServiceProviderConfig
      path: /scim/v2/ServiceProviderConfig
      operations:
      - name: scimgetproviderconfig2
        method: GET
        description: Get Provider Config
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: scim-v2-Users
      path: /scim/v2/Users
      operations:
      - name: scimsearchviaget2
        method: GET
        description: Search/List Users
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: filter
          in: query
          type: string
          description: Only support 'userName' or 'email' filter expressions for now
        - name: startIndex
          in: query
          type: integer
          description: Start index (1-based)
        - name: count
          in: query
          type: integer
          description: Page size
      - name: scimcreateuser2
        method: POST
        description: Create User
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: scim-v2-Users-.search
      path: /scim/v2/Users/.search
      operations:
      - name: scimsearchviapost2
        method: POST
        description: Search/List Users
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: scim-v2-Users-scimUserId
      path: /scim/v2/Users/{scimUserId}
      operations:
      - name: scimgetuser2
        method: GET
        description: Get User
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: scimupdateuser2
        method: PUT
        description: Update/Replace User
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
      - name: scimdeleteuser2
        method: DELETE
        description: Delete User
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: scimpatchuser2
        method: PATCH
        description: Update/Patch User
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    authentication:
      type: bearer
      token: '{{env.RINGCENTRAL_API_KEY}}'
  exposes:
  - type: rest
    namespace: platform-scim-rest
    port: 8080
    description: REST adapter for RingCentral API — SCIM. One Spectral-compliant resource per consumed operation, prefixed
      with /v1.
    resources:
    - path: /v1/scim/v2/resourcetypes
      name: scim-v2-resourcetypes
      description: REST surface for scim-v2-ResourceTypes.
      operations:
      - method: GET
        name: scimlistresourcetypes2
        description: List Resource Types
        call: platform-scim.scimlistresourcetypes2
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/scim/v2/resourcetypes/{type}
      name: scim-v2-resourcetypes-type
      description: REST surface for scim-v2-ResourceTypes-type.
      operations:
      - method: GET
        name: scimgetresourcetype2
        description: Get Resource Type
        call: platform-scim.scimgetresourcetype2
        with:
          type: rest.type
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/scim/v2/schemas
      name: scim-v2-schemas
      description: REST surface for scim-v2-Schemas.
      operations:
      - method: GET
        name: scimlistschemas2
        description: List Schemas
        call: platform-scim.scimlistschemas2
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/scim/v2/schemas/{uri}
      name: scim-v2-schemas-uri
      description: REST surface for scim-v2-Schemas-uri.
      operations:
      - method: GET
        name: scimgetschema2
        description: Get Schema
        call: platform-scim.scimgetschema2
        with:
          uri: rest.uri
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/scim/v2/serviceproviderconfig
      name: scim-v2-serviceproviderconfig
      description: REST surface for scim-v2-ServiceProviderConfig.
      operations:
      - method: GET
        name: scimgetproviderconfig2
        description: Get Provider Config
        call: platform-scim.scimgetproviderconfig2
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/scim/v2/users
      name: scim-v2-users
      description: REST surface for scim-v2-Users.
      operations:
      - method: GET
        name: scimsearchviaget2
        description: Search/List Users
        call: platform-scim.scimsearchviaget2
        with:
          filter: rest.filter
          startIndex: rest.startIndex
          count: rest.count
        outputParameters:
        - type: object
          mapping: $.
      - method: POST
        name: scimcreateuser2
        description: Create User
        call: platform-scim.scimcreateuser2
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/scim/v2/users/search
      name: scim-v2-users-search
      description: REST surface for scim-v2-Users-.search.
      operations:
      - method: POST
        name: scimsearchviapost2
        description: Search/List Users
        call: platform-scim.scimsearchviapost2
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/scim/v2/users/{scimuserid}
      name: scim-v2-users-scimuserid
      description: REST surface for scim-v2-Users-scimUserId.
      operations:
      - method: GET
        name: scimgetuser2
        description: Get User
        call: platform-scim.scimgetuser2
        outputParameters:
        - type: object
          mapping: $.
      - method: PUT
        name: scimupdateuser2
        description: Update/Replace User
        call: platform-scim.scimupdateuser2
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
      - method: DELETE
        name: scimdeleteuser2
        description: Delete User
        call: platform-scim.scimdeleteuser2
        outputParameters:
        - type: object
          mapping: $.
      - method: PATCH
        name: scimpatchuser2
        description: Update/Patch User
        call: platform-scim.scimpatchuser2
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: platform-scim-mcp
    port: 9090
    transport: http
    description: MCP adapter for RingCentral API — SCIM. One tool per consumed operation, routed inline through this capability's
      consumes block.
    tools:
    - name: list-resource-types
      description: List Resource Types
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: platform-scim.scimlistresourcetypes2
      outputParameters:
      - type: object
        mapping: $.
    - name: get-resource-type
      description: Get Resource Type
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: platform-scim.scimgetresourcetype2
      with:
        type: tools.type
      outputParameters:
      - type: object
        mapping: $.
    - name: list-schemas
      description: List Schemas
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: platform-scim.scimlistschemas2
      outputParameters:
      - type: object
        mapping: $.
    - name: get-schema
      description: Get Schema
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: platform-scim.scimgetschema2
      with:
        uri: tools.uri
      outputParameters:
      - type: object
        mapping: $.
    - name: get-provider-config
      description: Get Provider Config
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: platform-scim.scimgetproviderconfig2
      outputParameters:
      - type: object
        mapping: $.
    - name: search-list-users
      description: Search/List Users
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: platform-scim.scimsearchviaget2
      with:
        filter: tools.filter
        startIndex: tools.startIndex
        count: tools.count
      outputParameters:
      - type: object
        mapping: $.
    - name: create-user
      description: Create User
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: platform-scim.scimcreateuser2
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: search-list-users-2
      description: Search/List Users
      hints:
        readOnly: true
        destructive: false
        idempotent: false
      call: platform-scim.scimsearchviapost2
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: get-user
      description: Get User
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: platform-scim.scimgetuser2
      outputParameters:
      - type: object
        mapping: $.
    - name: update-replace-user
      description: Update/Replace User
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: platform-scim.scimupdateuser2
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: delete-user
      description: Delete User
      hints:
        readOnly: false
        destructive: true
        idempotent: true
      call: platform-scim.scimdeleteuser2
      outputParameters:
      - type: object
        mapping: $.
    - name: update-patch-user
      description: Update/Patch User
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: platform-scim.scimpatchuser2
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.