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

Etcd Auth API

Authentication and authorization management for users and roles

Etcd Auth API is one of 10 APIs that Etcd publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Auth. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.

This API exposes 16 operations across 16 paths, and defines 31 schemas. It is described by OpenAPI 3.1.0, at version 3.5.

Requests are made against a single base URL, http://{host}:{port}/v3.

16 operations 16 paths 31 schemas 16 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
3.5
Server
http://{host}:{port}/v3
Authentication
HTTP Bearer
Terms of Service
Resource Areas
1

Authentication & Security 1

Etcd Auth API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (JWT) (bearerAuth). By default, every request must be authenticated.

  • bearerAuth — JWT token obtained from the /auth/authenticate endpoint. Include in the Authorization header as "Bearer {token}".

Paths & Operations 16

Across 16 paths, the API surfaces 16 operations — 16 POST. Each is listed below with its method, path, parameters, and response codes.

Auth 16

Authentication and authorization management for users and roles

POST
/auth/enable
Etcd Enable authentication
authEnable → 200
POST
/auth/disable
Etcd Disable authentication
authDisable → 200
POST
/auth/authenticate
Etcd Authenticate a user
authAuthenticate body → 200401
POST
/auth/user/add
Etcd Add a user
authUserAdd body → 200400
POST
/auth/user/get
Etcd Get user details
authUserGet body → 200404
POST
/auth/user/delete
Etcd Delete a user
authUserDelete body → 200404
POST
/auth/user/list
Etcd List all users
authUserList → 200
POST
/auth/user/changepw
Etcd Change a user's password
authUserChangePassword body → 200404
POST
/auth/user/grant
Etcd Grant a role to a user
authUserGrantRole body → 200404
POST
/auth/user/revoke
Etcd Revoke a role from a user
authUserRevokeRole body → 200404
POST
/auth/role/add
Etcd Add a role
authRoleAdd body → 200400
POST
/auth/role/get
Etcd Get role details
authRoleGet body → 200404
POST
/auth/role/delete
Etcd Delete a role
authRoleDelete body → 200404
POST
/auth/role/list
Etcd List all roles
authRoleList → 200
POST
/auth/role/grant
Etcd Grant a permission to a role
authRoleGrantPermission body → 200404
POST
/auth/role/revoke
Etcd Revoke a permission from a role
authRoleRevokePermission body → 200404

Schemas 31

The contract defines 31 schemas that model the data the API accepts and returns. The most detailed are ResponseHeader (4 properties), AuthUserAddRequest (4 properties), AuthRoleRevokePermissionRequest (3 properties), Error (3 properties). Each schema is shown below with its type and property counts.

AuthUserRevokeRoleResponse
object
Response from a user role revoke operation
1 property
AuthRoleAddResponse
object
Response from a role add operation
1 property
AuthUserChangePasswordResponse
object
Response from a password change operation
1 property
AuthUserDeleteRequest
object
Request to delete a user
1 property 1 required
Error
object
Error response from the etcd API
3 properties
AuthenticateResponse
object
Response from a successful authentication
2 properties
AuthUserGrantRoleRequest
object
Request to grant a role to a user
2 properties 2 required
AuthUserGetRequest
object
Request to get user details
1 property 1 required
AuthRoleDeleteResponse
object
Response from a role delete operation
1 property
AuthRoleRevokePermissionResponse
object
Response from a role permission revoke operation
1 property
AuthRoleRevokePermissionRequest
object
Request to revoke a permission from a role
3 properties 2 required
AuthRoleGrantPermissionResponse
object
Response from a role permission grant operation
1 property
AuthUserGetResponse
object
Response from a user get operation
2 properties
AuthRoleAddRequest
object
Request to add a new role
1 property 1 required
AuthUserDeleteResponse
object
Response from a user delete operation
1 property
AuthUserAddRequest
object
Request to add a new user
4 properties 1 required
AuthUserChangePasswordRequest
object
Request to change a user's password
3 properties 1 required
AuthRoleGetResponse
object
Response from a role get operation
2 properties
Permission
object
A permission granting access to a key range
3 properties
AuthRoleGrantPermissionRequest
object
Request to grant a permission to a role
2 properties 2 required
ResponseHeader
object
Header included in every etcd response containing cluster metadata and the revision at which the response was generated.
4 properties
AuthRoleGetRequest
object
Request to get role details
1 property 1 required
AuthEnableResponse
object
Response from enabling authentication
1 property
AuthenticateRequest
object
Request to authenticate a user
2 properties 2 required
AuthUserGrantRoleResponse
object
Response from a user role grant operation
1 property
AuthUserAddResponse
object
Response from a user add operation
1 property
AuthRoleDeleteRequest
object
Request to delete a role
1 property 1 required
AuthUserRevokeRoleRequest
object
Request to revoke a role from a user
2 properties 2 required
AuthUserListResponse
object
Response from a user list operation
2 properties
AuthRoleListResponse
object
Response from a role list operation
2 properties
AuthDisableResponse
object
Response from disabling authentication
1 property

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

etcd-auth-api-openapi.yml Raw ↑

Other APIs Etcd publishes across the network.

etcd gRPC API
etcd Concurrency API
etcd Metrics API
etcd v2 HTTP API
Etcd Cluster API
Etcd KV API
Etcd Lease API
Etcd Maintenance API
Etcd Watch API