How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

InfluxDB Users API

Retrieve specific users.InfluxDB Cloud lets you invite and collaborate with multiple users in your organization.To invite and remove users from your organization, use the InfluxDB Cloud user interface (UI);you can't use the InfluxDB API to manage users in InfluxDB Cloud.Once a user is added to your organization, you can use the`GET /api/v2/users` and `GET /api/v2/users/USER_ID` API endpoints toview specific members.### User sessions with authorizationsOptionally, you can scope an authorization (and its API token) to a user.If a user signs in with username and password, creating a _user session_,the session carries the permissions granted by all the user's authorizations.To create a user session, use the [`POST /api/v2/signin` endpoint](#operation/PostSignin).### Related guides- [Manage users](https://docs.influxdata.com/influxdb/cloud/organizations/users/)

InfluxDB Users API is one of 40 APIs that InfluxDB publishes on the APIs.io network, described by a machine-readable OpenAPI specification and an AsyncAPI event-driven specification.

Tagged areas include User. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an AsyncAPI specification, authentication docs, and a getting-started guide.

This API exposes 9 operations across 5 paths, and defines 6 schemas. It is described by OpenAPI 3.2.0.

Requests are made against the base URL https://cloud2.influxdata.com/api/v2.

9 operations 5 paths 6 schemas 1 DELETE3 GET1 PATCH2 POST2 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
Base URL
https://cloud2.influxdata.com/api/v2
Authentication
HTTP Basic, API Key
Resource Areas
1

Authentication & Security 2

InfluxDB Users API declares 2 security schemes for authenticating requests. It accepts HTTP basic authentication (BasicAuthentication). An API key is passed in the header as Authorization (TokenAuthentication). By default, every request must be authenticated.

  • BasicAuthentication — Basic authentication scheme Use the HTTP Basic authentication scheme for InfluxDB /api/v2 API operations that support it: Syntax Authorization: Basic BASE64ENC…
  • TokenAuthentication — Use the [Token authentication](section/Authentication/TokenAuthentication) scheme to authenticate to the InfluxDB API. In your API requests, send an Authorizat…

Paths & Operations 9

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

Users 9

Retrieve specific users. InfluxDB Cloud lets you invite and collaborate with multiple users in your organization. To invite and remove users from your organization, use the Influx…

GET
/api/v2/me
Retrieve the currently authenticated user
GetMe 1 param → 200401500default
PUT
/api/v2/me/password
Update a password
PutMePassword 2 params body → 204400401default
GET
/api/v2/users
List users
GetUsers 3 params → 200401422500default
POST
/api/v2/users
Create a user
PostUsers 1 param body → 201401422500default
DELETE
/api/v2/users/{userID}
Delete a user
DeleteUsersID 2 params → 204400401404500default
GET
/api/v2/users/{userID}
Retrieve a user
GetUsersID 2 params → 200default
PATCH
/api/v2/users/{userID}
Update a user
PatchUsersID 2 params body → 200400401404500default
POST
/api/v2/users/{userID}/password
Update a password
PostUsersIDPassword 2 params body → 204400default
PUT
/api/v2/users/{userID}/password
Update a password
PutUsersIDPassword 2 params body → 204400default

Schemas 6

The contract defines 6 schemas that model the data the API accepts and returns. The most detailed are User (5 properties), Error (4 properties), UserResponse (4 properties), Users (2 properties). Each schema is shown below with its type and property counts.

PasswordResetBody
object
1 property 1 required
ErrorCode
string
code is the machine-readable error code.
UserResponse
object
4 properties 1 required
Users
object
2 properties
Error
object
4 properties 1 required
User
object
5 properties 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

influxdb-users-api-openapi.yml Raw ↑

Other APIs InfluxDB publishes across the network.

InfluxDB Authorizations (API tokens) API
InfluxDB Bucket Schemas API
InfluxDB Buckets API
InfluxDB Cells API
InfluxDB Checks API
InfluxDB Config API
InfluxDB Dashboards API
InfluxDB Data I/O endpoints API
InfluxDB DBRPs API
InfluxDB Delete API
InfluxDB Invokable Scripts API
InfluxDB Labels API
Where this information came from

This is an independent, third-party profile of InfluxDB Users API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.