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 Users. 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.0.0.
Requests are made against the base URL https://cloud2.influxdata.com/api/v2.
Metadata
The identity and technical contract details declared by the specification.
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.
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…
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.
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from InfluxDB 12
Other APIs InfluxDB publishes across the network.