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

InfluxData Security and access endpoints API

The Security and access endpoints API from InfluxData — 16 operation(s) for security and access endpoints.

InfluxData Security and access endpoints API is one of 45 APIs that InfluxData publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Security and access endpoints. The published artifact set on APIs.io includes an OpenAPI specification, an API reference, API documentation, and a getting-started guide.

This API exposes 20 operations across 16 paths, and defines 20 schemas. It is described by OpenAPI 3.0.0, at version 2.0.1.

Requests are made against a single base URL, /api/v2.

20 operations 16 paths 20 schemas 4 DELETE9 GET1 PATCH5 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.0
API Version
2.0.1
Base URL
https://us-east-1-1.aws.cloud2.influxdata.com/api/v2
Authentication
API Key, HTTP Basic
License
Resource Areas
1

Authentication & Security 2

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

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

Paths & Operations 20

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

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

Schemas 20

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

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

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

influxdata-security-and-access-endpoints-api-openapi.yml Raw ↑

Other APIs InfluxData publishes across the network.

InfluxData Authorizations (API tokens) API
InfluxData Backup API
InfluxData Bucket Schemas API
InfluxData Buckets API
InfluxData Cells API
InfluxData Checks API
InfluxData Config API
InfluxData Dashboards API
InfluxData Data I/O endpoints API
InfluxData DBRPs API
InfluxData Debug API
InfluxData Delete API