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

Rainforest QA users API

Operations about users

Rainforest QA users API is one of 18 APIs that Rainforest QA publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include users. The published artifact set on APIs.io includes an OpenAPI specification and authentication docs.

This API exposes 10 operations across 7 paths, and defines 6 schemas. It is described by OpenAPI 3.0.0, at version 1.

Requests are made against a single base URL, https://app.rainforestqa.com/api.

10 operations 7 paths 6 schemas 2 DELETE3 GET2 POST3 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.0
API Version
1
Base URL
https://app.rainforestqa.com/api
Authentication
API Key
Resource Areas
1

Authentication & Security 1

Rainforest QA users API declares 1 security scheme for authenticating requests. An API key is passed in the header as CLIENT_TOKEN (api_key). By default, every request must be authenticated.

Paths & Operations 10

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

users 10

Operations about users

GET
/1/users
List users
get-users 3 params → 200
POST
/1/users
Invite a user to authenticated account
post-users body → 201
GET
/1/users/all
List all users with and without permissions
get-users-all 1 param → 200
PUT
/1/users/permissions
Update user permissisons
put-users-permissions body → 200
POST
/1/users/reset_password
Reset the password for an email
post-users-reset_password body → 201
GET
/1/users/{user_id}
Get a user's account information
get-user 1 param → 200
PUT
/1/users/{user_id}
Update a user
put-user 1 param body → 200
DELETE
/1/users/{user_id}
Delete a user account
delete-user 2 params → 204
PUT
/1/users/{user_id}/regenerate_api_token
Rotate a user's API token
put-user-regenerate_api_token 1 param → 200
DELETE
/1/users/{user_id}/omniauth/{provider}
Delete a user's Omniauth provider profile
delete-user-omniauth 2 params → 204

Schemas 6

The contract defines 6 schemas that model the data the API accepts and returns. The most detailed are User (14 properties), put-user (6 properties), Profile (3 properties), post-users (3 properties). Each schema is shown below with its type and property counts.

post-users-reset_password
object
Reset the password for an email
1 property 1 required
put-users-permissions
object
Update user permissisons
1 property 1 required
put-user
object
Update a user
6 properties
User
object
User model
14 properties
post-users
object
Invite a user to authenticated account
3 properties 1 required
Profile
object
3 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

rainforest-qa-users-api-openapi.yml Raw ↑

Other APIs Rainforest QA publishes across the network.

Rainforest QA callback API
Rainforest QA clients API
Rainforest QA connections API
Rainforest QA credit_cards API
Rainforest QA environments API
Rainforest QA features API
Rainforest QA folders API
Rainforest QA generators API
Rainforest QA on_premise_crowd API
Rainforest QA run_groups API
Rainforest QA runs API
Rainforest QA site_environments API