Factset VRS API documentation — Scim

naftiko: 1.0.0-alpha2
info:
  label: Factset VRS API documentation — Scim
  description: 'Factset VRS API documentation — Scim. 12 operations. Lead operation: Factset Retrieves a list of VRS role.
    Self-contained Naftiko capability covering one Factset business surface.'
  tags:
  - Factset
  - Scim
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    FACTSET_API_KEY: FACTSET_API_KEY
capability:
  consumes:
  - type: http
    namespace: vermilion-scim
    baseUri: ''
    description: Factset VRS API documentation — Scim business capability. Self-contained, no shared references.
    resources:
    - name: scim-v2-Groups
      path: /scim/v2/Groups
      operations:
      - name: getallroles
        method: GET
        description: Factset Retrieves a list of VRS role
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: count
          in: query
          type: integer
          description: Non-negative maximum number of entries to return
        - name: startIndex
          in: query
          type: integer
          description: The 1-based index of the first query result
      - name: createrole
        method: POST
        description: Factset Creates a role
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: scim-v2-Groups-groupId
      path: /scim/v2/Groups/{groupId}
      operations:
      - name: getrolebyid
        method: GET
        description: Factset Retrieves a VRS role
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: groupId
          in: path
          type: string
          description: The ID of the role
          required: true
      - name: deleterolebyid
        method: DELETE
        description: Factset Deletes a VRS role
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: groupId
          in: path
          type: string
          description: The ID of the group
          required: true
      - name: patchrolebyid
        method: PATCH
        description: Factset Add or remove a user to/from a group
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: groupId
          in: path
          type: string
          description: The ID of the role
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
      - name: updaterolebyid
        method: PUT
        description: Factset Updates a VRS Group
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: groupId
          in: path
          type: string
          description: The ID of the group
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: scim-v2-Users
      path: /scim/v2/Users
      operations:
      - name: getallusers
        method: GET
        description: Factset Retrieves a list of VRS users
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: count
          in: query
          type: integer
          description: Non-negative maximum number of entries to return
        - name: startIndex
          in: query
          type: integer
          description: The 1-based index of the first query result
      - name: createuser
        method: POST
        description: Factset Creates a 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-userId
      path: /scim/v2/Users/{userId}
      operations:
      - name: getuserbyid
        method: GET
        description: Factset Retrieves a VRS User
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: userId
          in: path
          type: string
          description: The ID of the user
          required: true
      - name: deleteuserbyid
        method: DELETE
        description: Factset Deletes a VRS user
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: userId
          in: path
          type: string
          description: The ID of the user
          required: true
      - name: patchuserbyid
        method: PATCH
        description: Factset Add or remove VRS user attributes
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: userId
          in: path
          type: string
          description: The ID of the user
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
      - name: updateuserbyid
        method: PUT
        description: Factset Updates a VRS user
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: userId
          in: path
          type: string
          description: The ID of the user
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    authentication:
      type: bearer
      token: '{{env.FACTSET_API_KEY}}'
  exposes:
  - type: rest
    namespace: vermilion-scim-rest
    port: 8080
    description: REST adapter for Factset VRS API documentation — Scim. One Spectral-compliant resource per consumed operation,
      prefixed with /v1.
    resources:
    - path: /v1/scim/v2/groups
      name: scim-v2-groups
      description: REST surface for scim-v2-Groups.
      operations:
      - method: GET
        name: getallroles
        description: Factset Retrieves a list of VRS role
        call: vermilion-scim.getallroles
        with:
          count: rest.count
          startIndex: rest.startIndex
        outputParameters:
        - type: object
          mapping: $.
      - method: POST
        name: createrole
        description: Factset Creates a role
        call: vermilion-scim.createrole
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/scim/v2/groups/{groupid}
      name: scim-v2-groups-groupid
      description: REST surface for scim-v2-Groups-groupId.
      operations:
      - method: GET
        name: getrolebyid
        description: Factset Retrieves a VRS role
        call: vermilion-scim.getrolebyid
        with:
          groupId: rest.groupId
        outputParameters:
        - type: object
          mapping: $.
      - method: DELETE
        name: deleterolebyid
        description: Factset Deletes a VRS role
        call: vermilion-scim.deleterolebyid
        with:
          groupId: rest.groupId
        outputParameters:
        - type: object
          mapping: $.
      - method: PATCH
        name: patchrolebyid
        description: Factset Add or remove a user to/from a group
        call: vermilion-scim.patchrolebyid
        with:
          groupId: rest.groupId
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
      - method: PUT
        name: updaterolebyid
        description: Factset Updates a VRS Group
        call: vermilion-scim.updaterolebyid
        with:
          groupId: rest.groupId
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/scim/v2/users
      name: scim-v2-users
      description: REST surface for scim-v2-Users.
      operations:
      - method: GET
        name: getallusers
        description: Factset Retrieves a list of VRS users
        call: vermilion-scim.getallusers
        with:
          count: rest.count
          startIndex: rest.startIndex
        outputParameters:
        - type: object
          mapping: $.
      - method: POST
        name: createuser
        description: Factset Creates a user
        call: vermilion-scim.createuser
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/scim/v2/users/{userid}
      name: scim-v2-users-userid
      description: REST surface for scim-v2-Users-userId.
      operations:
      - method: GET
        name: getuserbyid
        description: Factset Retrieves a VRS User
        call: vermilion-scim.getuserbyid
        with:
          userId: rest.userId
        outputParameters:
        - type: object
          mapping: $.
      - method: DELETE
        name: deleteuserbyid
        description: Factset Deletes a VRS user
        call: vermilion-scim.deleteuserbyid
        with:
          userId: rest.userId
        outputParameters:
        - type: object
          mapping: $.
      - method: PATCH
        name: patchuserbyid
        description: Factset Add or remove VRS user attributes
        call: vermilion-scim.patchuserbyid
        with:
          userId: rest.userId
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
      - method: PUT
        name: updateuserbyid
        description: Factset Updates a VRS user
        call: vermilion-scim.updateuserbyid
        with:
          userId: rest.userId
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: vermilion-scim-mcp
    port: 9090
    transport: http
    description: MCP adapter for Factset VRS API documentation — Scim. One tool per consumed operation, routed inline through
      this capability's consumes block.
    tools:
    - name: factset-retrieves-list-vrs-role
      description: Factset Retrieves a list of VRS role
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: vermilion-scim.getallroles
      with:
        count: tools.count
        startIndex: tools.startIndex
      outputParameters:
      - type: object
        mapping: $.
    - name: factset-creates-role
      description: Factset Creates a role
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: vermilion-scim.createrole
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: factset-retrieves-vrs-role
      description: Factset Retrieves a VRS role
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: vermilion-scim.getrolebyid
      with:
        groupId: tools.groupId
      outputParameters:
      - type: object
        mapping: $.
    - name: factset-deletes-vrs-role
      description: Factset Deletes a VRS role
      hints:
        readOnly: false
        destructive: true
        idempotent: true
      call: vermilion-scim.deleterolebyid
      with:
        groupId: tools.groupId
      outputParameters:
      - type: object
        mapping: $.
    - name: factset-add-remove-user-group
      description: Factset Add or remove a user to/from a group
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: vermilion-scim.patchrolebyid
      with:
        groupId: tools.groupId
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: factset-updates-vrs-group
      description: Factset Updates a VRS Group
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: vermilion-scim.updaterolebyid
      with:
        groupId: tools.groupId
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: factset-retrieves-list-vrs-users
      description: Factset Retrieves a list of VRS users
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: vermilion-scim.getallusers
      with:
        count: tools.count
        startIndex: tools.startIndex
      outputParameters:
      - type: object
        mapping: $.
    - name: factset-creates-user
      description: Factset Creates a user
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: vermilion-scim.createuser
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: factset-retrieves-vrs-user
      description: Factset Retrieves a VRS User
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: vermilion-scim.getuserbyid
      with:
        userId: tools.userId
      outputParameters:
      - type: object
        mapping: $.
    - name: factset-deletes-vrs-user
      description: Factset Deletes a VRS user
      hints:
        readOnly: false
        destructive: true
        idempotent: true
      call: vermilion-scim.deleteuserbyid
      with:
        userId: tools.userId
      outputParameters:
      - type: object
        mapping: $.
    - name: factset-add-remove-vrs-user
      description: Factset Add or remove VRS user attributes
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: vermilion-scim.patchuserbyid
      with:
        userId: tools.userId
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: factset-updates-vrs-user
      description: Factset Updates a VRS user
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: vermilion-scim.updateuserbyid
      with:
        userId: tools.userId
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.