Aiven O Auth2 API

openapi: 3.2.0
info:
  contact:
    email: support@aiven.io
    name: Aiven support team
    url: https://aiven.io/support-services
  title: Aiven API Documentation O Auth2 API
  version: v1
  x-logo:
    altText: Aiven logo
    backgroundColor: '#fafafa'
    href: https://api.aiven.io/doc
    url: https://aiven.io/assets/img/aiven-logo.png
  description: '# Introduction


    Direct link to openapi.json for use with external tools


    Aiven is a modern fully-managed open source data platform for streaming, storing, and analyzing data on any public cloud. On Aiven Platform, you can operate your data infrastructure with a few devops tools: Aiven Console, Aiven Terraform Provider, Aiven CLI, and Aiven Operator for Kubernetes. All of them are built on an open secure powerful REST API for integration with custom tooling. The Aiven REST API

    provides programmatic access to Aiven.io services. To call the Aiven API, you can use either CLI tools (for example, `cURL` or Aiven CLI client) or GUI tools, such as the Aiven public API Postman collection. This Aiven API documentation will help you operate your Aiven organization, projects, or services programmatically by integrating your applications and processes with Aiven. # Description


    Aiven''s APIs (Application Programming Interfaces) power its platform for data management. Aiven has a number of REST APIs that can help you build strong and robust data infrastructure for your applications. The Aiven API is organized around core resources. Each core resource has multiple endpoints, which can be interacted with using different HTTP methods. ## Core resources


    ### Platform APIs


    Account

    Operations on the organization level related to accounts, projects, user groups, users, invites, billing groups, payment methods, credit cards, authentication methods, and more

    User

    Operations related to users and users'' profiles, access, authentication, authorization, user management, and more

    Project

    General operations on projects related to users, VPCs, invitations, alerts, peering connections, and more

    BillingGroup

    Operation on invoices, billing groups'' credits and events

    Support ticket

    Operations on support tickets: listing, creating, looping users in


    ### Services APIs


    Service

    All general (non-service-specific) operations on the service level: service creation, termination, configuration, updates, information retrieval, reset, and more

    Service Integrations

    Operations related to integrating services and managing service integrations

    Service: ClickHouse

    ClickHouse-specific operations on queries and databases

    Service: Flink

    Operations on Flink queries, jobs, and applications

    Service: Kafka

    Kafka and Kafka Connect specific operations on connectors, ACL entries, quotas, topics, topic messages, schema registry, and more

    Service: Kafka MirrorMaker

    Operations on replication flows

    Service: MySQL

    Fetching service query statistics

    Service: OpenSearch

    Operations on ACL configuration, security administration and configuration

    Service: PostgreSQL

    Operations on extensions, service query statistics, and connection pools


    # Requests


    There are multiple ways you can interact with the Aiven API over HTTP. You can access it by sending requests from a client (for example, a web browser) to the Aiven''s server. In this API reference, you''ll find code examples of how to do that using `cURL` and a few different client libraries (programming languages). To send an API request, you need to specify the following:


    * HTTP method

    * Path

    * Request headers


    Typically, `content-type` needs to be set to `application/json`: `content-type: application/json`. There are a few exceptions though. * Path, query, or body parameters (either required or optional).'
servers:
- url: https://api.aiven.io/v1
tags:
- name: OAuth2
  x-displayName: OAuth2
paths:
  /userinfo:
    get:
      summary: Return the identity of the authenticated user (OIDC UserInfo)
      tags:
      - OAuth2
      operationId: UserInfoGet
      responses:
        '200':
          description: Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UserInfoGetResponse'
        '403':
          description: Operation not allowed
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                    title: Human readable error message
                  errors:
                    type: array
                    title: List of error details. Typically there is only one element
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          title: Human readable error message
                        error_code:
                          type: string
                          enum:
                          - request_forbidden
                          title: Machine processable error code. Clients must be prepared to handle new codes.
                          description: 'request_forbidden: Not authorized to view the request'
      security:
      - tokenAuth: []
        oauth2:
        - accounts:read
components:
  schemas:
    UserInfoGetResponse:
      type: object
      description: UserInfoGetResponse
      properties:
        email:
          type: string
          description: User's email address
        email_verified:
          type: boolean
          description: Whether acorn considers the email verified
        name:
          type: string
          description: User's display name
        preferred_username:
          type: string
          description: User's preferred username
        sub:
          type: string
          description: Stable subject identifier (acorn user_id)
      required:
      - email
      - email_verified
      - sub
  securitySchemes:
    tokenAuth:
      description: 'Header should be of the format `authorization: aivenv1 <TOKEN>`. Tokens can be obtained from [your Aiven profile page](https://console.aiven.io/profile/auth)'
      scheme: bearer
      type: http
    oauth2:
      type: oauth2
      description: OAuth2 security scheme
      flows:
        authorizationCode:
          authorizationUrl: https://console.aiven.io/oauth/authorize
          tokenUrl: https://api.aiven.io/v1/oauth2/token
          scopes:
            all: Provide full access to the API
            accounts: Allow enumerating and reading accounts configuration
            accounts:read: Allow modifying account configuration
            accounts:write: Provides full access to authentication related API
            authentication: Provides full access to authentication related API
            authentication:read: Allow reading authentication related configuration on resources (user profile, accounts)
            authentication:write: Allow modifying authentication related configurations on resources (user profile, accounts)
            billing: Provide full access to billing APIs
            billing:read: Allow reading billing information and configuration
            billing:write: Allow writing billing configuration
            payments: Provide full access to payment method APIs
            payments:read: Allow reading the payment method configurations
            payments:write: Allows writing payment method configuration
            privatelink: Provide full access to private link APIs
            privatelink:read: Allow enumerating and reading private link items and configurations
            privatelink:write: Allow writing (creating, modifying, deleting) private link items
            projects: Provide full access to projects APIs
            projects:read: Allow enumerating projects and reading their configuration
            projects:write: Allow writing (creating, modifying, deleting) projects
            scim: Provide full access to SCIM operations
            scim:read: Allow reading SCIM endpoints
            scim:write: Allow writing (modifying) SCIM endpoints
            services: Provide full access to services APIs
            services:read: Allow enumerating services and reading their configuration
            services:write: Allow writing (creating, modifying, deleting) services
            static_ips: Provide full access to static IPs APIs
            static_ips:read: Allow enumerating and reading static IP items and configurations
            static_ips:write: Allow writing (creating, modifying, deleting) static IP items
            user: Provide full access to user profile APIs
            user:read: Allow reading user profile and configuration
            user:write: Allow writing (modifying) user profile and configuration
externalDocs:
  description: Aiven CLI client
  url: https://github.com/aiven/aiven-client