Infoworks

Infoworks Users API

The Users API from Infoworks — 13 operation(s) for users.

GitHub OpenAPI
Business capability
Identity & Access Management BC-620.20

Operations 19

GET /admin/users Get the User details #
POST /admin/users Create a new User #
GET /admin/users/{user_id} Get the details of the user linked with the user_id #
DELETE /admin/users/{user_id} Delete a user. #
PATCH /admin/users/{user_id} Update the User #
PATCH /admin/users/{user_id}/reset-password Reset password for user #
DELETE /admin/users/{user_id}/delete-schedules Delete all schedules for a specific user #
PATCH /admin/users/{user_id}/toggle-user-login Toggle user login ability #
POST /admin/users/{user_id}/accessible-domains Add the domain to the user linked with the user_id #
GET /users Get the User details #
POST /users Create a new User #
GET /users/{user_id} Get the details of the user linked with the user_id #
DELETE /users/{user_id} Delete a user. #
PATCH /users/{user_id} Update the User #
PATCH /users/{user_id}/reset-password Reset password for user #
DELETE /users/{user_id}/delete-schedules Delete all schedules for a specific user #
PATCH /users/{user_id}/toggle-user-login Toggle user login ability #
POST /users/{user_id}/accessible-domains Add the domain to the user linked with the user_id #
POST /users/unlock Unlock the user #

Documentation

📖
Authentication
https://raw.githubusercontent.com/api-evangelist/infoworks/refs/heads/main/authentication/infoworks-authentication.yml
📖
Documentation
https://docs.infoworks.io/developer-resources/rest-api
📖
APIReference
https://docs.infoworks.io/infoworks-rest-api-v3/ref

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/infoworks/refs/heads/main/openapi/infoworks-users-api-openapi.yml

Other Resources

🔗
ErrorCatalog
https://raw.githubusercontent.com/api-evangelist/infoworks/refs/heads/main/errors/infoworks-problem-types.yml
🔗
Conventions
https://raw.githubusercontent.com/api-evangelist/infoworks/refs/heads/main/conventions/infoworks-conventions.yml
🔗
DataModel
https://raw.githubusercontent.com/api-evangelist/infoworks/refs/heads/main/data-model/infoworks-data-model.yml

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/infoworks-users-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

infoworks-users-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  contact: {}
  title: Infoworks Rest API V3 Users API
  version: '1.0'
  description: Infoworks Rest API V3
servers:
- url: '{protocol}://{host}:{port}/v3'
  variables:
    protocol:
      default: http
      enum:
      - http
      - https
    host:
      default: localhost
    port:
      default: '3001'
tags:
- name: Users
  description: ''
paths:
  /admin/users:
    get:
      security:
      - BearerAuth: []
      operationId: GetUsers
      tags:
      - Users
      summary: Get the User details
      description: Get the User details
      responses:
        '200':
          description: Ok.
          content:
            application/json:
              schema:
                allOf:
                - type: object
                  properties:
                    limit:
                      type: integer
                      example: 10
                    offset:
                      type: integer
                      example: 0
                    links:
                      type: object
                      properties:
                        base:
                          type: string
                          format: uri
                          example: https://localhost:3001/v3/{admin/{workflows/{| |runs|tasks}|cluster-templates|jobs|admin-jobs|users}|sources|pipelines|cubes|domains}
                        self:
                          type: string
                          format: uri
                          example: https://localhost:3001/v3/{admin/{workflows/{| |runs|tasks}|cluster-templates|jobs|admin-jobs|users}|sources|pipelines|cubes|domains}?limit=10&offset=0
                        next:
                          type: string
                          format: uri
                          example: https://localhost:3001/v3/{admin/{workflows/{| |runs|tasks}|cluster-templates|jobs|admin-jobs|users}|sources|pipelines|cubes|domains}?limit=10&offset=10
                    total_count:
                      type: integer
                      example: 10
                  x-examples:
                    example-1: {}
                - type: object
                  properties:
                    message:
                      type: string
                      example: Example Success Message
                - type: object
                - properties:
                    result:
                      type: array
                      items:
                        allOf:
                        - type: object
                          properties:
                            id:
                              type: string
                              example: e77850ad5127a2d7dab870ff
                        - properties:
                            profile:
                              allOf:
                              - type: object
                                properties:
                                  name:
                                    type: string
                                    example: DF_SQLIMPORT
                              - properties:
                                  email:
                                    type: string
                                    example: xxx@infoworks.io
                              - properties:
                                  needs_password_reset:
                                    type: boolean
                                    example: false
                            emails:
                              type: array
                              items:
                                properties:
                                  address:
                                    type: string
                                    example: xxx@infoworks.io
                                  verified:
                                    type: boolean
                                    example: true
                            display_name:
                              type: string
                              example: Admin
                            roles:
                              type: array
                              items:
                                type: string
                                example: modeller
                            refresh_token:
                              type: string
                              example: zThziQ7MoJJP...
                            status:
                              type: object
                              properties:
                                is_online:
                                  type: boolean
                                  example: false
                                last_login_details:
                                  properties:
                                    date:
                                      type: string
                                      example: '2019-11-21T12:54:05.875Z'
                                    ip_address:
                                      type: string
                                      example: 10.12.43.23
                                    user_agent:
                                      type: string
                                      example: Mozilla/****
                        - properties:
                            accessible_domains:
                              type: array
                              items:
                                type: string
                                example: ffb38b0cc595cfcd05c54e49
                        - properties:
                            failed_logins:
                              type: array
                              items:
                                example: null
                            created_at:
                              type: string
                              example: '2019-11-21T12:54:05.875Z'
                            modified_at:
                              type: string
                              example: '2019-11-21T12:54:05.875Z'
                            is_password_required:
                              type: boolean
                              example: false
                            login_disabled:
                              type: boolean
                              example: true
                            locked_till:
                              type: string
                              example: '2019-11-21T12:54:05.875Z'
        '400':
          description: Request has invalid body or parameters.
          content:
            application/json:
              schema:
                type: object
                allOf:
                - type: object
                  properties:
                    message:
                      type: string
                      example: Something went wrong
                    details:
                      type: object
                      properties: {}
                - type: object
                  properties:
                    iw_code:
                      type: string
                      example: IW10006
                    help:
                      type: string
                      example: http://api.infoworks.io/help/IW10006
        '401':
          description: Authentication Failed. Please check your Credentials
          content:
            application/json:
              schema:
                type: object
                allOf:
                - type: object
                  properties:
                    message:
                      type: string
                      example: Something went wrong
                    details:
                      type: object
                      properties: {}
                - type: object
                  properties:
                    iw_code:
                      type: string
                      example: IW10005
                    help:
                      type: string
                      example: http://api.infoworks.io/help/IW10005
        '403':
          description: Forbidden. User lacks access to specified resource.
          content:
            application/json:
              schema:
                type: object
                allOf:
                - type: object
                  properties:
                    message:
                      type: string
                      example: Something went wrong
                    details:
                      type: object
                      properties: {}
                - type: object
                  properties:
                    iw_code:
                      type: string
                      example: IW10004
                    help:
                      type: string
                      example: http://api.infoworks.io/help/IW10004
        '500':
          description: Internal Server Error.
          content:
            application/json:
              schema:
                type: object
                allOf:
                - type: object
                  properties:
                    message:
                      type: string
                      example: Something went wrong
                    details:
                      type: object
                      properties: {}
                - type: object
                  properties:
                    iw_code:
                      type: string
                      example: IW10002
                    help:
                      type: string
                      example: http://api.infoworks.io/help/IW10002
    post:
      security:
      - BearerAuth: []
      operationId: createUser
      tags:
      - Users
      summary: Create a new User
      description: Create a new User
      requestBody:
        content:
          application/json:
            schema:
              allOf:
              - type: object
                properties:
                  profile:
                    allOf:
                    - type: object
                      properties:
                        name:
                          type: string
                          example: DF_SQLIMPORT
                    - properties:
                        email:
                          type: string
                          example: xxx@infoworks.io
                  roles:
                    type: array
                    items:
                      type: string
                      example: modeller
              - type: object
                properties:
                  password:
                    type: string
                    example: kdb***
              - properties:
                  accessible_domains:
                    type: array
                    items:
                      type: string
                      example: ffb38b0cc595cfcd05c54e49
      responses:
        '200':
          description: Ok.
          content:
            application/json:
              schema:
                allOf:
                - type: object
                  properties:
                    message:
                      type: string
                      example: Example Success Message
                - type: object
                  properties:
                    result:
                      type: object
                      properties:
                        id:
                          type: string
                          example: e77850ad5127a2d7dab870ff
        '400':
          description: Request has invalid body or parameters.
          content:
            application/json:
              schema:
                type: object
                allOf:
                - type: object
                  properties:
                    message:
                      type: string
                      example: Something went wrong
                    details:
                      type: object
                      properties: {}
                - type: object
                  properties:
                    iw_code:
                      type: string
                      example: IW10006
                    help:
                      type: string
                      example: http://api.infoworks.io/help/IW10006
        '401':
          description: Authentication Failed. Please check your Credentials
          content:
            application/json:
              schema:
                type: object
                allOf:
                - type: object
                  properties:
                    message:
                      type: string
                      example: Something went wrong
                    details:
                      type: object
                      properties: {}
                - type: object
                  properties:
                    iw_code:
                      type: string
                      example: IW10005
                    help:
                      type: string
                      example: http://api.infoworks.io/help/IW10005
        '403':
          description: Forbidden. User lacks access to specified resource.
          content:
            application/json:
              schema:
                type: object
                allOf:
                - type: object
                  properties:
                    message:
                      type: string
                      example: Something went wrong
                    details:
                      type: object
                      properties: {}
                - type: object
                  properties:
                    iw_code:
                      type: string
                      example: IW10004
                    help:
                      type: string
                      example: http://api.infoworks.io/help/IW10004
        '500':
          description: Internal Server Error.
          content:
            application/json:
              schema:
                type: object
                allOf:
                - type: object
                  properties:
                    message:
                      type: string
                      example: Something went wrong
                    details:
                      type: object
                      properties: {}
                - type: object
                  properties:
                    iw_code:
                      type: string
                      example: IW10002
                    help:
                      type: string
                      example: http://api.infoworks.io/help/IW10002
  /admin/users/{user_id}:
    parameters:
    - name: user_id
      in: path
      required: true
      schema:
        type: string
    get:
      security:
      - BearerAuth: []
      operationId: GetUserIdForAdmin
      tags:
      - Users
      summary: Get the details of the user linked with the user_id
      description: Get the details of the user linked with the user_id
      responses:
        '200':
          description: Ok.
          content:
            application/json:
              schema:
                allOf:
                - type: object
                  properties:
                    message:
                      type: string
                      example: Example Success Message
                - type: object
                - properties:
                    result:
                      type: object
                      allOf:
                      - type: object
                        properties:
                          id:
                            type: string
                            example: e77850ad5127a2d7dab870ff
                      - properties:
                          profile:
                            allOf:
                            - type: object
                              properties:
                                name:
                                  type: string
                                  example: DF_SQLIMPORT
                            - properties:
                                email:
                                  type: string
                                  example: xxx@infoworks.io
                            - properties:
                                needs_password_reset:
                                  type: boolean
                                  example: false
                          emails:
                            type: array
                            items:
                              properties:
                                address:
                                  type: string
                                  example: xxx@infoworks.io
                                verified:
                                  type: boolean
                                  example: true
                          roles:
                            type: array
                            items:
                              type: string
                              example: modeller
                          auth_token:
                            type: string
                            example: ksvfvb***
                          status:
                            type: object
                            properties:
                              is_online:
                                type: boolean
                                example: false
                              last_login_details:
                                properties:
                                  date:
                                    type: string
                                    example: '2019-11-21T12:54:05.875Z'
                                  ip_address:
                                    type: string
                                    example: 10.12.43.23
                                  user_agent:
                                    type: string
                                    example: Mozilla/****
                      - properties:
                          accessible_domains:
                            type: array
                            items:
                              type: string
                              example: ffb38b0cc595cfcd05c54e49
                      - properties:
                          failed_logins:
                            type: array
                            items:
                              example: null
                          created_at:
                            type: string
                            example: '2019-11-21T12:54:05.875Z'
        '400':
          description: Request has invalid body or parameters.
          content:
            application/json:
              schema:
                type: object
                allOf:
                - type: object
                  properties:
                    message:
                      type: string
                      example: Something went wrong
                    details:
                      type: object
                      properties: {}
                - type: object
                  properties:
                    iw_code:
                      type: string
                      example: IW10006
                    help:
                      type: string
                      example: http://api.infoworks.io/help/IW10006
        '401':
          description: Authentication Failed. Please check your Credentials
          content:
            application/json:
              schema:
                type: object
                allOf:
                - type: object
                  properties:
                    message:
                      type: string
                      example: Something went wrong
                    details:
                      type: object
                      properties: {}
                - type: object
                  properties:
                    iw_code:
                      type: string
                      example: IW10005
                    help:
                      type: string
                      example: http://api.infoworks.io/help/IW10005
        '403':
          description: Forbidden. User lacks access to specified resource.
          content:
            application/json:
              schema:
                type: object
                allOf:
                - type: object
                  properties:
                    message:
                      type: string
                      example: Something went wrong
                    details:
                      type: object
                      properties: {}
                - type: object
                  properties:
                    iw_code:
                      type: string
                      example: IW10004
                    help:
                      type: string
                      example: http://api.infoworks.io/help/IW10004
        '500':
          description: Internal Server Error.
          content:
            application/json:
              schema:
                type: object
                allOf:
                - type: object
                  properties:
                    message:
                      type: string
                      example: Something went wrong
                    details:
                      type: object
                      properties: {}
                - type: object
                  properties:
                    iw_code:
                      type: string
                      example: IW10002
                    help:
                      type: string
                      example: http://api.infoworks.io/help/IW10002
    delete:
      security:
      - BearerAuth: []
      operationId: deleteUserForAdmin
      tags:
      - Users
      summary: Delete a user.
      description: Delete a user.
      responses:
        '200':
          description: Ok
          content:
            application/json:
              schema:
                allOf:
                - type: object
                  properties:
                    message:
                      type: string
                      example: Example Success Message
        '400':
          description: Request has invalid body or parameters.
          content:
            application/json:
              schema:
                type: object
                allOf:
                - type: object
                  properties:
                    message:
                      type: string
                      example: Something went wrong
                    details:
                      type: object
                      properties: {}
                - type: object
                  properties:
                    iw_code:
                      type: string
                      example: IW10006
                    help:
                      type: string
                      example: http://api.infoworks.io/help/IW10006
        '401':
          description: Authentication Failed. Please check your Credentials
          content:
            application/json:
              schema:
                type: object
                allOf:
                - type: object
                  properties:
                    message:
                      type: string
                      example: Something went wrong
                    details:
                      type: object
                      properties: {}
                - type: object
                  properties:
                    iw_code:
                      type: string
                      example: IW10005
                    help:
                      type: string
                      example: http://api.infoworks.io/help/IW10005
        '403':
          description: Forbidden. User lacks access to specified resource.
          content:
            application/json:
              schema:
                type: object
                allOf:
                - type: object
                  properties:
                    message:
                      type: string
                      example: Something went wrong
                    details:
                      type: object
                      properties: {}
                - type: object
                  properties:
                    iw_code:
                      type: string
                      example: IW10004
                    help:
                      type: string
                      example: http://api.infoworks.io/help/IW10004
        '500':
          description: Internal Server Error.
          content:
            application/json:
              schema:
                type: object
                allOf:
                - type: object
                  properties:
                    message:
                      type: string
                      example: Something went wrong
                    details:
                      type: object
                      properties: {}
                - type: object
                  properties:
                    iw_code:
                      type: string
                      example: IW10002
                    help:
                      type: string
                      example: http://api.infoworks.io/help/IW10002
    patch:
      security:
      - BearerAuth: []
      operationId: updateUserForAdmin
      tags:
      - Users
      summary: Update the User
      description: Update the User
      requestBody:
        content:
          application/json:
            schema:
              allOf:
              - type: object
                properties:
                  profile:
                    allOf:
                    - type: object
                      properties:
                        name:
                          type: string
                          example: DF_SQLIMPORT
                    - properties:
                        email:
                          type: string
                          example: xxx@infoworks.io
                  roles:
                    type: array
                    items:
                      type: string
                      example: modeller
              - properties:
                  accessible_domains:
                    type: array
                    items:
                      type: string
                      example: ffb38b0cc595cfcd05c54e49
              - type: object
                properties:
                  password:
                    type: string
                    example: kdb***
      responses:
        '200':
          description: Ok.
          content:
            application/json:
              schema:
                allOf:
                - type: object
                  properties:
                    message:
                      type: string
                      example: Example Success Message
                - type: object
                  properties:
                    result:
                      type: object
                      properties:
                        id:
                          type: string
                          example: e77850ad5127a2d7dab870ff
        '400':
          description: Request has invalid body or parameters.
          content:
            application/json:
              schema:
                type: object
                allOf:
                - type: object
                  properties:
                    message:
                      type: string
                      example: Something went wrong
                    details:
                      type: object
                      properties: {}
                - type: object
                  properties:
                    iw_code:
                      type: string
                      example: IW10006
                    help:
                      type: string
                      example: http://api.infoworks.io/help/IW10006
        '401':
          description: Authentication Failed. Please check your Credentials
          content:
            application/json:
              schema:
                type: object
                allOf:
                - type: object
                  properties:
                    message:
                      type: string
                      example: Something went wrong
                    details:
                      type: object
                      properties: {}
                - type: object
                  properties:
                    iw_code:
                      type: string
                      example: IW10005
                    help:
                      type: string
                      example: http://api.infoworks.io/help/IW10005
        '403':
          description: Forbidden. User lacks access to specified resource.
          content:
            application/json:
              schema:
                type: object
                allOf:
                - type: object
                  properties:
                    message:
                      type: string
                      example: Something went wrong
                    details:
                      type: object
                      properties: {}
                - type: object
                  properties:
                    iw_code:
                      type: string
                      example: IW10004
                    help:
                      type: string
                      example: http://api.infoworks.io/help/IW10004
        '500':
          description: Internal Server Error.
          content:
            application/json:
              schema:
                type: object
                allOf:
                - type: object
                  properties:
                    message:
                      type: string
                      example: Something went wrong
                    details:
                      type: object
                      properties: {}
                - type: object
                  properties:
                    iw_code:
                      type: string
                      example: IW10002
                    help:
                      type: string
                      example: http://api.infoworks.io/help/IW10002
  /admin/users/{user_id}/reset-password:
    parameters:
    - name: user_id
      in: path
      required: true
      schema:
        type: string
    patch:
      security:
      - BearerAuth: []
      operationId: resetUserPassword
      tags:
      - Users
      summary: Reset password for user
      description: Reset password for user
      requestBody:
        content:
          application/json:
            schema:
              allOf:
              - type: object
                properties:
                  old_password:
                    type: string
                    example: kdb***
              - type: object
                properties:
                  new_password:
                    type: string
                    example: kdb***
      responses:
        '200':
          description: Ok.
          content:
            application/json:
              schema:
                allOf:
                - type: object
                  properties:
                    message:
                      type: string
                      example: Example Success Message
        '400':
          description: Request has invalid body or parameters.
          content:
            application/json:
              schema:
                type: object
                allOf:
                - type: object
                  properties:
                    message:
                      type: string
                      example: Something went wrong
                    details:
                      type: object
                      properties: {}
                - type: object
                  properties:
                    iw_code:
                      type: string
                      example: IW10006
                    help:
                      type: string
                      example: http://api.infoworks.io/help/IW10006
        '401':
          description: Authentication Failed. Please check your Credentials
          content:
            application/json:
              schema:
                type: object
                allOf:
                - type: object
                  properties:
                    message:
                      type: string
                      example: Something went wrong
                    details:
                      type: object
                      properties: {}
                - type: object
                  properties:
                    iw_code:
                      type: string
                      example: IW10005
                    help:
                      type: string
                      example: http://api.infoworks.i

# --- truncated at 32 KB (93 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/infoworks/refs/heads/main/openapi/infoworks-users-api-openapi.yml