Iru

Iru Users API

The Users API from Iru — 2 operation(s) for users.

GitHub OpenAPI

Operations 3

GET /api/v1/users List users #
GET /api/v1/users/{user_id} Get user #
DELETE /api/v1/users/{user_id} Delete user #

Documentation

📖
Documentation
https://docs.iru.com/en/endpoint/api/iru-api-overview
📖
APIReference
https://api-docs.kandji.io/
📖
Authentication
https://raw.githubusercontent.com/api-evangelist/kandji/refs/heads/main/authentication/kandji-authentication.yml
📖
RateLimits
https://raw.githubusercontent.com/api-evangelist/kandji/refs/heads/main/rate-limits/kandji-rate-limits.yml

Specifications

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

Other Resources

🔗
Postman
https://api-docs.kandji.io/
🔗
PostmanCollection
https://raw.githubusercontent.com/api-evangelist/kandji/refs/heads/main/collections/kandji-endpoint-management.postman_collection.json
🔗
Conventions
https://raw.githubusercontent.com/api-evangelist/kandji/refs/heads/main/conventions/kandji-conventions.yml
🔗
ErrorCatalog
https://raw.githubusercontent.com/api-evangelist/kandji/refs/heads/main/errors/kandji-problem-types.yml
🔗
DataModel
https://raw.githubusercontent.com/api-evangelist/kandji/refs/heads/main/data-model/kandji-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/kandji-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

kandji-users-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Iru Endpoint Management Users API
  description: '# Welcome to the Iru Endpoint Management API Documentation


    **Note:** Kandji is in the process of changing to Iru.'
  version: 1.0.0
servers:
- url: https://{subdomain}.api.kandji.io
  description: US Server
  variables:
    subdomain:
      default: your-subdomain
      description: Your Iru Endpoint Management subdomain
- url: https://{subdomain}.api.eu.kandji.io
  description: EU Server
  variables:
    subdomain:
      default: your-subdomain
      description: Your Iru Endpoint Management subdomain
security:
- BearerAuth: []
tags:
- name: Users
paths:
  /api/v1/users:
    get:
      summary: List users
      description: This endpoint makes a request to retrieve a list of users from user directory integrations.
      parameters:
      - name: email
        in: query
        required: false
        description: 'Returns users with email addresses containing the provided string. Example: `test_user_01@accuhive.io`'
        schema:
          type: string
        example: test_user_01@accuhive.io
      - name: id
        in: query
        required: false
        description: 'Search for a user matching the provided UUID value. Example: `69c009ca-1f78-4bdf-bb93-08d6d39041db`'
        schema:
          type: string
        example: 69c009ca-1f78-4bdf-bb93-08d6d39041db
      - name: integration_id
        in: query
        required: false
        description: 'Search for an integration matching the provided UUID value. Example: `f7461096-4ef9-43aa-88e9-ca1967ba0b38`'
        schema:
          type: string
        example: f7461096-4ef9-43aa-88e9-ca1967ba0b38
      - name: archived
        in: query
        required: false
        description: 'Return only users that are either archived (`true`) or not archived (`false`). Archived users are users that appear in the Users module under the Archived tab. Example: `false`'
        schema:
          type: boolean
        example: false
      - name: cursor
        in: query
        required: false
        description: 'Cursor for the next or previous page of results. Can also store the URL in the `next` and `previous` fields in the response. Example: `eyJpZCI6MTIzNDU2Nzg5fQ==`'
        schema:
          type: string
        example: eyJpZCI6MTIzNDU2Nzg5fQ==
      responses:
        '200':
          description: List of users
          content:
            application/json:
              schema:
                type: object
                properties:
                  next:
                    type:
                    - string
                    - 'null'
                  previous:
                    type:
                    - string
                    - 'null'
                  results:
                    type: array
                    items:
                      type: object
                      properties:
                        active:
                          type: boolean
                        archived:
                          type: boolean
                        created_at:
                          type: string
                          format: date-time
                        department:
                          type:
                          - string
                          - 'null'
                        deprecated_user_id:
                          type: string
                        email:
                          type: string
                        id:
                          type: string
                        integration:
                          type: object
                          properties:
                            id:
                              type: integer
                            name:
                              type: string
                            uuid:
                              type: string
                            type:
                              type: string
                        job_title:
                          type:
                          - string
                          - 'null'
                        name:
                          type: string
                        device_count:
                          type: integer
                        updated_at:
                          type: string
                          format: date-time
                example:
                  next: https://accuhive.kandji.io/api/v1/users?cursor=cD0yOTE0Mw%3D%3D
                  previous: null
                  results:
                  - active: true
                    archived: false
                    created_at: '2024-09-06T21:00:04.304248Z'
                    department: null
                    deprecated_user_id: '29360'
                    email: test_user_01@accuhive.io
                    id: 69c009ca-1f78-4bdf-bb93-08d6d39041db
                    integration:
                      id: 634
                      name: accuhive
                      uuid: f7461096-4ef9-43aa-88e9-ca1967ba0b38
                      type: office365
                    job_title: null
                    name: test_user_01
                    device_count: 2
                    updated_at: '2024-09-06T21:00:04.304280Z'
                  - active: true
                    archived: false
                    created_at: '2024-09-06T17:00:04.503800Z'
                    department: null
                    deprecated_user_id: '29359'
                    email: test_user_02@accuhive.io
                    id: adacf177-fbc2-4485-be26-05d8d965a8a6
                    integration:
                      id: 634
                      name: accuhive
                      uuid: f7461096-4ef9-43aa-88e9-ca1967ba0b38
                      type: office365
                    job_title: null
                    name: test_user_02
                    device_count: 0
                    updated_at: '2024-09-06T17:00:04.503814Z'
              example:
                next: https://accuhive.kandji.io/api/v1/users?cursor=cD0yOTE0Mw%3D%3D
                previous: null
                results:
                - active: true
                  archived: false
                  created_at: '2024-09-06T21:00:04.304248Z'
                  department: null
                  deprecated_user_id: '29360'
                  email: test_user_01@accuhive.io
                  id: 69c009ca-1f78-4bdf-bb93-08d6d39041db
                  integration:
                    id: 634
                    name: accuhive
                    uuid: f7461096-4ef9-43aa-88e9-ca1967ba0b38
                    type: office365
                  job_title: null
                  name: test_user_01
                  device_count: 2
                  updated_at: '2024-09-06T21:00:04.304280Z'
                - active: true
                  archived: false
                  created_at: '2024-09-06T17:00:04.503800Z'
                  department: null
                  deprecated_user_id: '29359'
                  email: test_user_02@accuhive.io
                  id: adacf177-fbc2-4485-be26-05d8d965a8a6
                  integration:
                    id: 634
                    name: accuhive
                    uuid: f7461096-4ef9-43aa-88e9-ca1967ba0b38
                    type: office365
                  job_title: null
                  name: test_user_02
                  device_count: 0
                  updated_at: '2024-09-06T17:00:04.503814Z'
      tags:
      - Users
      operationId: getApiV1Users
      x-operation-id-source: derived
  /api/v1/users/{user_id}:
    get:
      summary: Get user
      description: This request returns a specific user.
      parameters:
      - name: user_id
        in: path
        required: true
        schema:
          type: string
        description: The unique identifier of the user directory integration user.
      responses:
        '200':
          description: User details
          content:
            application/json:
              schema:
                type: object
                example:
                  active: true
                  archived: false
                  created_at: '2024-09-06T21:00:04.304248Z'
                  department: null
                  deprecated_user_id: '29360'
                  email: test_user_01@accuhive.io
                  id: 69c009ca-1f78-4bdf-bb93-08d6d39041db
                  integration:
                    id: 634
                    name: accuhive
                    uuid: f7461096-4ef9-43aa-88e9-ca1967ba0b38
                    type: office365
                  job_title: null
                  name: test_user_01
                  device_count: 2
                  updated_at: '2024-09-06T21:00:04.304280Z'
              example:
                active: true
                archived: false
                created_at: '2024-09-06T21:00:04.304248Z'
                department: null
                deprecated_user_id: '29360'
                email: test_user_01@accuhive.io
                id: 69c009ca-1f78-4bdf-bb93-08d6d39041db
                integration:
                  id: 634
                  name: accuhive
                  uuid: f7461096-4ef9-43aa-88e9-ca1967ba0b38
                  type: office365
                job_title: null
                name: test_user_01
                device_count: 2
                updated_at: '2024-09-06T21:00:04.304280Z'
      tags:
      - Users
      operationId: getApiV1UsersByUserId
      x-operation-id-source: derived
    delete:
      summary: Delete user
      description: This request deletes a user directory integration user.
      parameters:
      - name: user_id
        in: path
        required: true
        schema:
          type: string
        description: The unique identifier of the user directory integration user.
      responses:
        '200':
          description: User deleted successfully
          content:
            application/json:
              schema:
                type: object
                example:
                  detail: User deleted successfully
        '400':
          description: User still assigned to one or more devices
          content:
            application/json:
              schema:
                type: object
                properties:
                  detail:
                    type: string
                    example: User still assigned to one or more devices.
      tags:
      - Users
      operationId: deleteApiV1UsersByUserId
      x-operation-id-source: derived
components:
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT