naftiko: 1.0.0-alpha2
info:
  label: Ironclad SCIM 2.0 API
  description: Ironclad SCIM 2.0 API. 14 operations across 6 resource paths. Self-contained Naftiko capability covering the
    Ironclad SCIM business surface.
  tags:
  - Ironclad
  - SCIM
  created: '2026-05-25'
  modified: '2026-05-25'
binds:
- namespace: env
  keys:
    IRONCLAD_ACCESS_TOKEN: IRONCLAD_ACCESS_TOKEN
capability:
  consumes:
  - type: http
    namespace: scim
    baseUri: https://na1.ironcladapp.com/scim/v2
    description: Ironclad SCIM business capability.
    resources:
    - name: users
      path: /Users
      operations: &id001
      - name: retrieve-all-users
        method: GET
        description: List all Users
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: filter
          in: query
          type: string
          description: Filters for identifying subsets of users. Filters must comply with the SCIM protocol's convention.
            For more details, see SCIM [RFC 7644 Section 3.4.2.2](https://datatracker.ietf.org/doc/html/rfc7644#section-3.4.2.2).
          required: false
      - name: create-a-user
        method: POST
        description: Create a User
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: users-userid
      path: /Users/{userId}
      operations: &id002
      - name: retrieve-a-user
        method: GET
        description: Retrieve a User
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters: []
      - name: update-user-data
        method: PATCH
        description: Update User Data
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
      - name: replace-a-user
        method: PUT
        description: Replace a User
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
      - name: delete-a-user
        method: DELETE
        description: Delete a User
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters: []
    - name: groups
      path: /Groups
      operations: &id003
      - name: retrieve-all-groups
        method: GET
        description: List all Groups
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: filter
          in: query
          type: string
          description: Filters for identifying subsets of groups. Filters must comply with the SCIM protocol's convention.
            For more details, see SCIM [RFC 7644 Section 3.4.2.2](https://datatracker.ietf.org/doc/html/rfc7644#section-3.4.2.2).
          required: false
      - name: create-a-group
        method: POST
        description: Create a Group
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: groups-groupid
      path: /Groups/{groupId}
      operations: &id004
      - name: retrieve-a-group
        method: GET
        description: Retrieve a Group
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters: []
      - name: update-group-membership
        method: PATCH
        description: Update a Group
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
      - name: replace-a-group
        method: PUT
        description: Replace a Group
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
      - name: delete-a-group
        method: DELETE
        description: Delete a Group
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters: []
    - name: schemas
      path: /Schemas
      operations: &id005
      - name: list-all-schemas
        method: GET
        description: List all Schemas
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters: []
    - name: schemas-schemaid
      path: /Schemas/{schemaId}
      operations: &id006
      - name: retrieve-a-schema
        method: GET
        description: Retrieve a Schema
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters: []
    authentication:
      type: apikey
      key: Authorization
      value: Bearer {{env.IRONCLAD_ACCESS_TOKEN}}
      placement: header
  exposes:
  - type: rest
    namespace: scim-rest
    port: 8080
    description: REST adapter for Ironclad SCIM. One resource per consumed operation.
    resources:
    - name: users
      path: /v1/Users
      operations: *id001
    - name: users-userid
      path: /v1/Users/{userId}
      operations: *id002
    - name: groups
      path: /v1/Groups
      operations: *id003
    - name: groups-groupid
      path: /v1/Groups/{groupId}
      operations: *id004
    - name: schemas
      path: /v1/Schemas
      operations: *id005
    - name: schemas-schemaid
      path: /v1/Schemas/{schemaId}
      operations: *id006