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

InfluxDB Security and access endpoints API

The Security and access endpoints API from InfluxDB — 15 operation(s) for security and access endpoints.

InfluxDB Security and access endpoints 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 Security and access endpoints. 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 19 operations across 15 paths, and defines 21 schemas. It is described by OpenAPI 3.0.0.

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

19 operations 15 paths 21 schemas 4 DELETE8 GET1 PATCH5 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

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

Authentication & Security 2

InfluxDB Security and access endpoints 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 19

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

Security and access endpoints 19
GET
/api/v2/authorizations
List authorizations
GetAuthorizations 6 params → 200400401500default
POST
/api/v2/authorizations
Create an authorization
PostAuthorizations 1 param body → 201400401500default
DELETE
/api/v2/authorizations/{authID}
Delete an authorization
DeleteAuthorizationsID 2 params → 204400401404500default
GET
/api/v2/authorizations/{authID}
Retrieve an authorization
GetAuthorizationsID 2 params → 200400401404500default
PATCH
/api/v2/authorizations/{authID}
Update an API token to be active or inactive
PatchAuthorizationsID 2 params body → 200default
GET
/api/v2/orgs
List organizations
GetOrgs 7 params → 200400401404500default
GET
/api/v2/orgs/{orgID}
Retrieve an organization
GetOrgsID 2 params → 200401404500default
GET
/api/v2/orgs/{orgID}/members
List all members of an organization
GetOrgsIDMembers 2 params → 200400401404500default
DELETE
/api/v2/orgs/{orgID}/members/{userID}
Remove a member from an organization
DeleteOrgsIDMembersID 3 params → 204401404500default
GET
/api/v2/orgs/{orgID}/owners
List all owners of an organization
GetOrgsIDOwners 2 params → 200404default
DELETE
/api/v2/orgs/{orgID}/owners/{userID}
Remove an owner from an organization
DeleteOrgsIDOwnersID 3 params → 204401404500default
GET
/api/v2/orgs/{orgID}/secrets
List all secret keys for an organization
GetOrgsIDSecrets 2 params → 200default
DELETE
/api/v2/orgs/{orgID}/secrets/{secretID}
Delete a secret from an organization
DeleteOrgsIDSecretsID 3 params → 204default
POST
/api/v2/orgs/{orgID}/secrets/deletedeprecated
Delete secrets from an organization
PostOrgsIDSecrets 2 params body → 204default
POST
/api/v2/signin
Create a user session.
PostSignin 1 param → 204401403default
POST
/api/v2/signout
Expire a user session
PostSignout 1 param → 204401default
GET
/api/v2/users
List users
GetUsers 3 params → 200401422500default
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 21

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

Resource
object
5 properties 1 required
Link
string
URI of resource.
Users
object
2 properties
ErrorCode
string
code is the machine-readable error code.
ResourceOwner
ResourceMembers
object
2 properties
UserResponse
object
4 properties 1 required
SecretKeysResponse
Authorizations
object
2 properties
SecretKeys
object
1 property
Error
object
4 properties 1 required
ResourceMember
AuthorizationUpdateRequest
object
2 properties
AuthorizationPostRequest
2 required
Permission
object
2 properties 2 required
Links
object
URI pointers for additional paged results.
3 properties 1 required
Authorization
2 required
Organizations
object
2 properties
ResourceOwners
object
2 properties
PasswordResetBody
object
1 property 1 required
Organization
object
8 properties 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

influxdb-security-and-access-endpoints-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