Rapid7

Rapid7 Accounts API

An API used to find and search InsightIDR accounts. See https://docs.rapid7.com/insightidr/users-and-accounts-on-your-domain for further information on accounts.

Documentation GitHub OpenAPI

Operations 2

POST /idr/v1/accounts/_search Search accounts #

GET /idr/v1/accounts/{rrn} Get account by RRN #

Specifications

⚙

OpenAPI

https://raw.githubusercontent.com/api-evangelist/rapid7/refs/heads/main/openapi/rapid7-accounts-api-openapi.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/rapid7-accounts-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

openapi: 3.2.0
info:
  title: InsightIDR Accounts API
  version: v1
  description: 'Introduction


    Welcome to the reference documentation for the InsightIDR public APIs.


    Here are a few resources to help you learn how to start using our APIs:


    Learn about basic concepts and capabilities


    Get an Insight platform API key to set up authentication


    See available Insight product APIs


    Learn more about InsightIDR


    After you''ve got the basics down, you can use this API guide to find examples of requests and responses.'
servers:
- url: https://{region}.api.insight.rapid7.com/
  variables:
    region:
      default: us
      description: Insight API region
security: []
tags:
- name: Accounts
  description: An API used to find and search InsightIDR accounts. See https://docs.rapid7.com/insightidr/users-and-accounts-on-your-domain for further information on accounts.
paths:
  /idr/v1/accounts/_search:
    post:
      tags:
      - Accounts
      summary: Search accounts
      description: 'A search API for accounts. You can search for accounts matching the given search criteria.


        FieldCan Search?Can Sort?Type


        authentication_serviceYesYesString


        disabledYesNoBoolean


        domainYesYesString


        nameYesYesString


        user.rrnYesYesString


        user.nameYesYesString'
      operationId: searchAccounts
      parameters:
      - name: index
        in: query
        description: The optional, 0 based index of the page to retrieve.  Must be an integer greater than or equal to 0.
        required: false
        schema:
          minimum: 0
          type: integer
          default: 0
        example: 0
      - name: size
        in: query
        description: The optional size of the page to retrieve. Must be an integer greater than 0 or less than or equal to 1000.
        required: false
        schema:
          maximum: 1000
          minimum: 1
          type: integer
          default: 20
        example: 20
      requestBody:
        description: The criteria and sorting information for searching.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SearchRequest'
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PageAccountV2'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '403':
          description: Insufficient Permissions
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: Entity Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '405':
          description: Method Not Allowed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '502':
          description: Bad Gateway
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '503':
          description: Service Unavailable
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '504':
          description: Gateway Timeout
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
  /idr/v1/accounts/{rrn}:
    get:
      tags:
      - Accounts
      summary: Get account by RRN
      description: Retrieve an account with the given RRN (Rapid7 Resource Name).
      operationId: findAccountByRrn
      parameters:
      - name: rrn
        in: path
        description: The RRN of the account.
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccountV2'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '403':
          description: Insufficient Permissions
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: Entity Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '405':
          description: Method Not Allowed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '502':
          description: Bad Gateway
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '503':
          description: Service Unavailable
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '504':
          description: Gateway Timeout
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
components:
  schemas:
    UserSummaryV2:
      required:
      - name
      - rrn
      type: object
      properties:
        rrn:
          type: string
          description: The unique identifier for this user.
          example: rrn:uba:us:6bcf6c5b-552d-49a4-a3f5-259e0514585f:user:83002c85d7c6
        name:
          type: string
          description: The name for this user.
          example: John Doe
      description: The user this account is associated with.
    PageMetadata:
      required:
      - index
      - size
      - total_data
      - total_pages
      type: object
      properties:
        index:
          type: integer
          description: 'The 0 based index of the page retrieved. '
          format: int32
          example: 0
        size:
          type: integer
          description: 'The size of the page requested. '
          format: int32
          example: 20
        total_pages:
          type: integer
          description: 'The total number of pages available with the given filter parameters. '
          format: int32
          example: 1
        total_data:
          type: integer
          description: 'The total number of results available with the given filter parameters. '
          format: int64
          example: 15
      description: The pagination parameters used to generate this page result. Depending on the API, additional parameters may be dynamically present.
    SearchRequestSort:
      type: object
      properties:
        field:
          type: string
          description: The field to sort by.
          example: name
        order:
          type: string
          description: The sorting direction. Sorting is case-insensitive when sorting strings.
          enum:
          - ASC
          - DESC
          - ASC,DESC
      description: The sorting information.
    SearchRequestCriteria:
      type: object
      properties:
        field:
          type: string
          description: The field to search within.
          example: name
        operator:
          type: string
          description: The search operation to perform. All operators are case-insensitive when operating on strings.
          enum:
          - EQUALS
          - CONTAINS
          - IN
        value:
          type: object
          description: The value to search for.
      description: The criteria for which entities to return.
    PageAccountV2:
      required:
      - data
      - metadata
      type: object
      properties:
        data:
          type: array
          description: The list of data that matches the pagination parameters. If no results match this will be an empty list.
          items:
            $ref: '#/components/schemas/AccountV2'
        metadata:
          $ref: '#/components/schemas/PageMetadata'
    AccountV2:
      required:
      - authentication_service
      - disabled
      - name
      - rrn
      - user
      type: object
      properties:
        rrn:
          type: string
          description: The unique identifier for this account.
          example: rrn:uba:us:6bcf6c5b-552d-49a4-a3f5-259e0514585f:account:83002c85d7c6
        name:
          type: string
          description: The name for this account.
          example: jdoe@acme.com
        domain:
          type: string
          description: The domain that this account is associated with.
          example: tor.acme.com
        disabled:
          type: boolean
          description: True if the account is disabled.
        user:
          $ref: '#/components/schemas/UserSummaryV2'
        authentication_service:
          type: string
          description: The service to which this account is tied, which is responsible for authenticating this account.
          example: ACTIVE_DIRECTORY
      description: Information about an account
    SearchRequest:
      type: object
      properties:
        search:
          type: array
          description: The criteria for which entities to return.
          items:
            $ref: '#/components/schemas/SearchRequestCriteria'
        sort:
          type: array
          description: The sorting information.
          items:
            $ref: '#/components/schemas/SearchRequestSort'
    ErrorResponse:
      required:
      - message
      type: object
      properties:
        message:
          type: string
          description: A human-readable message describing the error that occurred.
          example: A human-readable message describing the error that occurred.
        correlation_id:
          type: string
          description: An identifier that uniquely identifies the failed request.
          example: 6b6503c8-2da9-41c0-94cb-2f34069e00cd
externalDocs:
  description: Product docs
  url: https://insightidr.help.rapid7.com/docs