SpotDraft Public API — Users

naftiko: 1.0.0-alpha2
info:
  label: SpotDraft Public API — Users
  description: SpotDraft Users capability. 15 operations across versions v1/v2/v2.1.
  tags:
  - SpotDraft
  - CLM
  - Contracts
  - Users
  created: '2026-05-25'
  modified: '2026-05-25'
binds:
- namespace: env
  keys:
    SPOTDRAFT_CLIENT_ID: SPOTDRAFT_CLIENT_ID
    SPOTDRAFT_CLIENT_SECRET: SPOTDRAFT_CLIENT_SECRET
capability:
  consumes:
  - type: http
    namespace: users
    baseUri: https://api.us.spotdraft.com
    description: SpotDraft Users endpoints.
    headers: {}
    resources:
    - name: v1-public-auth-roles
      path: /api/v1/public/auth/roles
      operations:
      - name: v1-public-auth-roles-retrieve
        method: GET
        description: Get Roles
        outputRawFormat: json
    - name: v1-public-auth-users
      path: /api/v1/public/auth/users
      operations:
      - name: v1-public-auth-users-retrieve
        method: GET
        description: Get User List
        outputRawFormat: json
        inputParameters:
        - name: limit
          in: query
          type: integer
          required: false
        - name: page
          in: query
          type: integer
          required: false
        - name: user_email
          in: query
          type: string
          required: false
      - name: v1-public-auth-users-create
        method: POST
        description: Create User
        outputRawFormat: json
        inputParameters:
        - name: body
          in: body
          type: object
          required: true
    - name: v1-public-auth-users-user-id
      path: /api/v1/public/auth/users/{user_id}
      operations:
      - name: v1-public-auth-users-partial-update
        method: PATCH
        description: Update User roles
        outputRawFormat: json
        inputParameters:
        - name: user_id
          in: path
          type: integer
          required: true
        - name: body
          in: body
          type: object
          required: false
      - name: v1-public-auth-users-destroy
        method: DELETE
        description: Deactivate a User
        outputRawFormat: json
        inputParameters:
        - name: user_id
          in: path
          type: integer
          required: true
    - name: v2-1-public-auth-roles
      path: /api/v2.1/public/auth/roles/
      operations:
      - name: v2-1-public-auth-roles-retrieve
        method: GET
        description: Get Active Roles
        outputRawFormat: json
    - name: v2-1-public-auth-roles-role-id-members
      path: /api/v2.1/public/auth/roles/{role_id}/members
      operations:
      - name: v2-1-public-auth-roles-members-create
        method: POST
        description: Add Role Member
        outputRawFormat: json
        inputParameters:
        - name: role_id
          in: path
          type: integer
          required: true
        - name: body
          in: body
          type: object
          required: false
      - name: v2-1-public-auth-roles-members-destroy
        method: DELETE
        description: Delete Role Member
        outputRawFormat: json
        inputParameters:
        - name: role_id
          in: path
          type: integer
          required: true
    - name: v2-1-public-auth-users
      path: /api/v2.1/public/auth/users/
      operations:
      - name: v2-1-public-auth-users-retrieve
        method: GET
        description: Get User List
        outputRawFormat: json
        inputParameters:
        - name: limit
          in: query
          type: integer
          required: false
        - name: page
          in: query
          type: integer
          required: false
        - name: user_email
          in: query
          type: string
          required: false
        - name: user_name
          in: query
          type: string
          required: false
      - name: v2-1-public-auth-users-create
        method: POST
        description: Create and Invite User
        outputRawFormat: json
        inputParameters:
        - name: body
          in: body
          type: object
          required: true
    - name: v2-1-public-contracts-contract-id-authorized-users
      path: /api/v2.1/public/contracts/{contract_id}/authorized_users/
      operations:
      - name: v2-1-public-contracts-authorized-users-retrieve
        method: GET
        description: Get Contract Authorized Users List
        outputRawFormat: json
        inputParameters:
        - name: contract_id
          in: path
          type: integer
          required: true
    - name: v2-public-auth-roles
      path: /api/v2/public/auth/roles/
      operations:
      - name: v2-public-auth-roles-retrieve
        method: GET
        description: Get Active Roles
        outputRawFormat: json
    - name: v2-public-auth-roles-role-id-members
      path: /api/v2/public/auth/roles/{role_id}/members
      operations:
      - name: v2-public-auth-roles-members-create
        method: POST
        description: Add Role Member
        outputRawFormat: json
        inputParameters:
        - name: role_id
          in: path
          type: integer
          required: true
        - name: body
          in: body
          type: object
          required: false
      - name: v2-public-auth-roles-members-destroy
        method: DELETE
        description: Delete Role Member
        outputRawFormat: json
        inputParameters:
        - name: role_id
          in: path
          type: integer
          required: true
    - name: v2-public-auth-users
      path: /api/v2/public/auth/users/
      operations:
      - name: v2-public-auth-users-retrieve
        method: GET
        description: Get User List
        outputRawFormat: json
        inputParameters:
        - name: limit
          in: query
          type: integer
          required: false
        - name: page
          in: query
          type: integer
          required: false
        - name: user_email
          in: query
          type: string
          required: false