Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
Kin Lane

Chat with Kin

AI assistant · trained on my blog

Rapid7

Rapid7 User API

Resources and operations for managing users, permissions, and privileges.

Documentation Provider Profile APIs.io OpenAPI GitHub

Rapid7 User API is one of 50 APIs that Rapid7 publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include User. The published artifact set on APIs.io includes an OpenAPI specification.

This API exposes 32 operations across 19 paths, and defines 25 schemas. It is described by OpenAPI 3.1.0, at version v1.

Requests are made against a single base URL, https://[region].api.insight.rapid7.com/ias/v1.

32 operations 19 paths 25 schemas 7 DELETE15 GET2 POST8 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
v1
Base URL
https://us.api.insight.rapid7.com/vm/v4
Resource Areas
1

Paths & Operations 32

Across 19 paths, the API surfaces 32 operations — 7 DELETE, 15 GET, 2 POST, 8 PUT. Each is listed below with its method, path, parameters, and response codes.

User 32

Resources and operations for managing users, permissions, and privileges.

GET
/api/3/authentication_sources
Authentication Sources
getAuthenticationSources → 200401404500503
GET
/api/3/authentication_sources/{id}
Authentication Source
getAuthenticationSource 1 param → 200401404500503
GET
/api/3/authentication_sources/{id}/users
Authentication Source Users
getAuthenticationSourceUsers 1 param → 200401404500503
GET
/api/3/privileges
Privileges
getPrivileges → 200401404500503
GET
/api/3/privileges/{id}
Privilege
getPrivilege 1 param → 200401404500503
GET
/api/3/privileges/{id}/users
Users With Privilege
getUsersWithPrivilege 1 param → 200401404500503
GET
/api/3/roles
Roles
getRoles → 200401404500503
GET
/api/3/roles/{id}
Role
getRole 1 param → 200401404500503
PUT
/api/3/roles/{id}
Role
updateRole 2 params → 200400401404500503
DELETE
/api/3/roles/{id}
Role
deleteRole 1 param → 200400401404500503
GET
/api/3/roles/{id}/users
Users With Role
getRoleUsers 1 param → 200401404500503
GET
/api/3/users
Users
getUsers 3 params → 200401404500503
POST
/api/3/users
Users
createUser 1 param → 200400401500503
GET
/api/3/users/{id}
User
getUser 1 param → 200401404500503
PUT
/api/3/users/{id}
User
updateUser 2 params → 200400401404500503
DELETE
/api/3/users/{id}
User
deleteUser 1 param → 200401404500503
GET
/api/3/users/{id}/2FA
Two-Factor Authentication
getTwoFactorAuthenticationKey 1 param → 200401404500503
POST
/api/3/users/{id}/2FA
Two-Factor Authentication
regenerateTwoFactorAuthentication 1 param → 200400401500503
PUT
/api/3/users/{id}/2FA
Two-Factor Authentication
setTwoFactorAuthentication 2 params → 200400401404500503
GET
/api/3/users/{id}/asset_groups
Asset Groups Access
getUserAssetGroups 1 param → 200401404500503
PUT
/api/3/users/{id}/asset_groups
Asset Groups Access
setUserAssetGroups 2 params → 200400401404500503
DELETE
/api/3/users/{id}/asset_groups
Asset Groups Access
removeAllUserAssetGroups 1 param → 200401404500503
PUT
/api/3/users/{id}/asset_groups/{assetGroupId}
Asset Group Access
addUserAssetGroup 2 params → 200400401404500503
DELETE
/api/3/users/{id}/asset_groups/{assetGroupId}
Asset Group Access
removeUserAssetGroup 2 params → 200401404500503
DELETE
/api/3/users/{id}/lock
Unlock Account
unlockUser 1 param → 200401404500503
PUT
/api/3/users/{id}/password
Password Reset
resetPassword 2 params → 200400401404500503
GET
/api/3/users/{id}/privileges
User Privileges
getUserPrivileges 1 param → 200401404500503
GET
/api/3/users/{id}/sites
Sites Access
getUserSites 1 param → 200401404500503
PUT
/api/3/users/{id}/sites
Sites Access
setUserSites 2 params → 200400401404500503
DELETE
/api/3/users/{id}/sites
Sites Access
removeAllUserSites 1 param → 200401404500503
PUT
/api/3/users/{id}/sites/{siteId}
Site Access
addUserSite 2 params → 200400401404500503
DELETE
/api/3/users/{id}/sites/{siteId}
Site Access
removeUserSite 2 params → 200401404500503

Schemas 25

The contract defines 25 schemas that model the data the API accepts and returns. The most detailed are UserEdit (11 properties), User (10 properties), UserRole (6 properties), AuthenticationSource (5 properties). Each schema is shown below with its type and property counts.

Privileges
object
2 properties
NotFoundError
object
3 properties 1 required
UserRole
object
6 properties
InternalServerError
object
3 properties 1 required
TokenResource
object
2 properties
Links
object
1 property
ReferencesWith«UserID,Link»
object
2 properties
Resources«Role»
object
2 properties
CreateAuthenticationSource
object
2 properties 1 required
UnauthorizedError
object
3 properties 1 required
UserEdit
object
11 properties 4 required
Resources«AuthenticationSource»
object
2 properties
User
object
10 properties 2 required
ReferencesWith«AssetGroupID,Link»
object
2 properties
ServiceUnavailableError
object
3 properties 1 required
PageOf«User»
object
3 properties
Role
object
5 properties 3 required
LocalePreferences
object
3 properties
CreatedReference«UserID,Link»
object
2 properties
BadRequestError
object
3 properties 1 required
UserCreateRole
object
4 properties 1 required
ReferencesWith«SiteID,Link»
object
2 properties
PageInfo
object
4 properties
AuthenticationSource
object
5 properties
Link
object
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

rapid7-user-api-openapi.yml Raw ↑

Other APIs Rapid7 publishes across the network.

Rapid7 InsightVM Cloud API
AE Profile APIs.io
Rapid7 Insight Platform API
AE Profile APIs.io
Rapid7 InsightIDR API
AE Profile APIs.io
Rapid7 Accounts API
AE Profile APIs.io
Rapid7 Administration API
AE Profile APIs.io
Rapid7 Apps API
AE Profile APIs.io
Rapid7 Asset API
AE Profile APIs.io
Rapid7 Asset Discovery API
AE Profile APIs.io
Rapid7 Asset Group API
AE Profile APIs.io
Rapid7 Assets API
AE Profile APIs.io
Rapid7 Attachments API
AE Profile APIs.io
Rapid7 Attack Templates API
AE Profile APIs.io
#User
← Back to R APIs
API Details
ID
rapid7:rapid7-user-api
Base URL
https://us.api.insight.rapid7.com/vm/v4
Docs
https://help.rapid7.com/insightvm/en-us/api/api.html
Provider
Rapid7
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network