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

Aiven Users API

The Users API from Aiven — 31 operation(s) for users.

Aiven Users API is one of 34 APIs that Aiven publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

This API exposes 8 JSON Schema definitions.

Tagged areas include User. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, authentication docs, and 8 JSON Schemas.

This API exposes 36 operations across 31 paths, and defines 45 schemas. It is described by OpenAPI 3.2.0, at version v1.

Requests are made against a single base URL, https://api.aiven.io/v1.

36 operations 31 paths 45 schemas 5 DELETE12 GET2 PATCH13 POST4 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
v1
Base URL
https://api.aiven.io/v1
Authentication
HTTP Bearer, OAuth 2.0
Resource Areas
1

Authentication & Security 2

Aiven Users API declares 2 security schemes for authenticating requests. It accepts HTTP bearer tokens (tokenAuth). It supports OAuth 2.0 (oauth2) using the authorizationCode flow, exposing 34 scopes.

  • tokenAuth — Header should be of the format authorization: aivenv1 . Tokens can be obtained from [your Aiven profile page](https://console.aiven.io/profile/auth)
  • oauth2 — OAuth2 security scheme

Paths & Operations 36

Across 31 paths, the API surfaces 36 operations — 5 DELETE, 12 GET, 2 PATCH, 13 POST, 4 PUT. Each is listed below with its method, path, parameters, and response codes.

Users 36
POST
/access_token
Create new access token
AccessTokenCreate body → 200
GET
/access_token
List all valid access tokens
AccessTokenList → 200
DELETE
/access_token/{token_prefix}
Revoke an access token
AccessTokenRevoke 1 param → 200
PUT
/access_token/{token_prefix}
Update an existing access token
AccessTokenUpdate 1 param body → 200
POST
/me/password_strength
Check password strength for an existing user
CheckPasswordStrengthExistingUser body → 200
POST
/user/password_strength
Check password strength for a new user
CheckPasswordStrengthNewUser body → 200
GET
/organization/{organization_id}/user/{member_user_id}/user-groups
List user groups of the organization's member
OrganizationMemberGroupsList 2 params → 200
GET
/organization/{organization_id}/user/{member_user_id}/permissions
List resources permissions of the organization's member
OrganizationMemberPermissionsList 2 params → 200404
GET
/organization/{organization_id}/user/{member_user_id}/authentication_methods
List authentication methods for a user in the organization
OrganizationUserAuthenticationMethodsList 2 params → 200
DELETE
/organization/{organization_id}/user/{member_user_id}
Remove a user from the organization
OrganizationUserDelete 2 params → 204400403
GET
/organization/{organization_id}/user/{member_user_id}
Get details on a user of the organization
OrganizationUserGet 2 params → 200
PATCH
/organization/{organization_id}/user/{member_user_id}
Update details on a user of the organization
OrganizationUserUpdate 2 params body → 200
GET
/organization/{organization_id}/user
List users of the organization
OrganizationUserList 2 params → 200
POST
/organization/{organization_id}/user/{member_user_id}/reset_password
Reset the password of a managed user in the organization
OrganizationUserPasswordReset 2 params → 204
DELETE
/organization/{organization_id}/user/{member_user_id}/access-token/{token_prefix}
Revoke the token of a managed user in the organization
OrganizationUserRevokeToken 3 params → 204
GET
/organization/{organization_id}/user/{member_user_id}/access-tokens
List tokens from an organization's member
OrganizationUserTokensList 2 params → 200
PUT
/me/2fa
Configure two-factor authentication
TwoFactorAuthConfigure body → 200
PUT
/me/2fa/otp
Complete one-time password configuration
TwoFactorAuthConfigureOTP body → 200
DELETE
/user/{user_id}
Delete user account
UserAccountDelete 1 param → 204400403
POST
/me/account/invites/acceptdeprecated
Accept all invites for a single account
UserAccountInvitesAccept → 200
GET
/me/account/invitesdeprecated
List pending account invites
UserAccountInvitesList → 200
POST
/me/account/invites/rejectdeprecated
Reject invite to a team
UserAccountInvitesReject → 200
POST
/userauth
Authenticate user
UserAuth body → 200403
POST
/userauth/login_options
Get available login options
UserAuthLoginOptions body → 200
DELETE
/me/authentication_methods/{user_authentication_method_id}
Delete linked authentication method, and revoke all associated access tokens
UserAuthenticationMethodDelete 1 param → 200
GET
/me/authentication_methods
List linked authentication methods
UserAuthenticationMethodsList → 200
POST
/me/expire_tokens
Expire all authorization tokens
UserExpireTokens → 200
GET
/me
Get information for the current session's user
UserInfo → 200
PATCH
/me
Edit profile
UserUpdate body → 200
POST
/me/logout
Logout user, removing current authentication token
UserLogout → 200
PUT
/me/password
Change user password
UserPasswordChange body → 200
POST
/user/password_reset/{verification_code}
Confirm user password reset
UserPasswordReset 1 param body → 200
POST
/user/password_reset_request
Request user password reset
UserPasswordResetRequest body → 200
POST
/user/verify_email/{verification_code}
Confirm user email address
UserVerifyEmail 1 param → 200
GET
/user/credit_code/{credit_code}
Validate campaign credit code
ValidateCreditCode 1 param → 200
GET
/me/referral/validation/{referral_code}
Validate referralcode code
ValidateReferralCode 1 param → 200

Schemas 45

The contract defines 45 schemas that model the data the API accepts and returns. The most detailed are AccessTokenCreateResponse (17 properties), AccessTokenUpdateResponse (16 properties), OrganizationUserUpdateRequestBody (7 properties), UserAuthResponse (7 properties). Each schema is shown below with its type and property counts.

OrganizationUserAuthenticationMethodsListResponse
object
OrganizationUserAuthenticationMethodsListResponse
1 property 1 required
CheckPasswordStrengthExistingUserRequestBody
object
CheckPasswordStrengthExistingUserRequestBody
2 properties 2 required
UserAuthLoginOptionsResponse
object
UserAuthLoginOptionsResponse
5 properties 1 required
UserUpdateResponse
object
UserUpdateResponse
3 properties 1 required
AccessTokenCreateResponse
object
AccessTokenCreateResponse
17 properties 6 required
UserAuthLoginOptionsRequestBody
object
UserAuthLoginOptionsRequestBody
1 property
UserInfoResponse
object
UserInfoResponse
3 properties 1 required
UserAuthRequestBody
object
UserAuthRequestBody
3 properties 2 required
TwoFactorAuthConfigureOTPResponse
object
TwoFactorAuthConfigureOTPResponse
4 properties 2 required
UserAuthenticationMethodDeleteResponse
object
UserAuthenticationMethodDeleteResponse
2 properties
OrganizationMemberPermissionsListResponse
object
OrganizationMemberPermissionsListResponse
1 property 1 required
AccessTokenCreateRequestBody
object
AccessTokenCreateRequestBody
5 properties 1 required
CheckPasswordStrengthNewUserResponse
object
CheckPasswordStrengthNewUserResponse
3 properties 1 required
UserPasswordResetRequestRequestBody
object
UserPasswordResetRequestRequestBody
1 property 1 required
UserPasswordChangeResponse
object
UserPasswordChangeResponse
3 properties 1 required
CheckPasswordStrengthExistingUserResponse
object
CheckPasswordStrengthExistingUserResponse
3 properties 1 required
UserLogoutResponse
object
UserLogoutResponse
2 properties
TwoFactorAuthConfigureResponse
object
TwoFactorAuthConfigureResponse
5 properties 1 required
UserAccountInvitesListResponse
object
UserAccountInvitesListResponse
3 properties 1 required
AccessTokenListResponse
object
AccessTokenListResponse
3 properties 1 required
UserPasswordResetRequestBody
object
UserPasswordResetRequestBody
1 property 1 required
OrganizationUserUpdateRequestBody
object
OrganizationUserUpdateRequestBody
7 properties
AccessTokenUpdateResponse
object
AccessTokenUpdateResponse
16 properties 4 required
UserUpdateRequestBody
object
UserUpdateRequestBody
5 properties 1 required
AccessTokenUpdateRequestBody
object
AccessTokenUpdateRequestBody
1 property 1 required
UserAccountInvitesRejectResponse
object
UserAccountInvitesRejectResponse
3 properties 1 required
OrganizationUserListResponse
object
OrganizationUserListResponse
1 property 1 required
TwoFactorAuthConfigureOTPRequestBody
object
TwoFactorAuthConfigureOTPRequestBody
3 properties 3 required
UserPasswordChangeRequestBody
object
UserPasswordChangeRequestBody
2 properties 2 required
UserExpireTokensResponse
object
UserExpireTokensResponse
2 properties
UserPasswordResetResponse
object
UserPasswordResetResponse
2 properties
AccessTokenRevokeResponse
object
AccessTokenRevokeResponse
2 properties
ValidateReferralCodeResponse
object
ValidateReferralCodeResponse
2 properties
OrganizationUserUpdateResponse
object
OrganizationUserUpdateResponse
5 properties 5 required
UserAuthenticationMethodsListResponse
object
UserAuthenticationMethodsListResponse
3 properties 1 required
TwoFactorAuthConfigureRequestBody
object
TwoFactorAuthConfigureRequestBody
2 properties 2 required
ValidateCreditCodeResponse
object
ValidateCreditCodeResponse
2 properties
UserPasswordResetRequestResponse
object
UserPasswordResetRequestResponse
2 properties
CheckPasswordStrengthNewUserRequestBody
object
CheckPasswordStrengthNewUserRequestBody
3 properties 1 required
UserAuthResponse
object
UserAuthResponse
7 properties 3 required
UserAccountInvitesAcceptResponse
object
UserAccountInvitesAcceptResponse
3 properties 1 required
OrganizationUserGetResponse
object
OrganizationUserGetResponse
5 properties 5 required
OrganizationMemberGroupsListResponse
object
OrganizationMemberGroupsListResponse
1 property 1 required
OrganizationUserTokensListResponse
object
OrganizationUserTokensListResponse
1 property 1 required
UserVerifyEmailResponse
object
UserVerifyEmailResponse
3 properties 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

aiven-users-api-openapi.yml Raw ↑

Other APIs Aiven publishes across the network.

Aiven Account API
Aiven Application_Users API
Aiven Authentication_Methods API
Aiven Billing API
Aiven BillingGroup API
Aiven Cloud_platforms API
Aiven Custom_Cloud API
Aiven Domains API
Aiven Groups API
Aiven Organization_Vpc API
Aiven OrganizationBillingGroup API
Aiven OrganizationEmissions API
Where this information came from

This is an independent, third-party profile of Aiven 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.