Instaclustr Bundle User API

openapi: 3.2.0
info:
  title: Instaclustr Bundle User API
  version: Deprecated
  x-logo:
    altText: Instaclustr Logo
    backgroundColor: '#FFFFFF'
    url: https://console2.instaclustr.com/assets/logos/instaclustr_logo_for_redocly.svg
  description: 'Operations tagged Bundle User across 2 of this provider''s published API definitions: instaclustr-deprecated-openapi.json, instaclustr-deprecated-openapi.yml. Each path carries the servers of the definition it was published in.'
servers:
- url: https://api.instaclustr.com
  description: Instaclustr API
security:
- Basic Authentication: []
tags:
- name: Bundle User
  description: Operations related to users in a bundle.
  x-insta-tag-group: Provisioning V1
paths:
  /provisioning/v1/{clusterId}/{bundle}/users:
    get:
      tags:
      - Bundle User
      summary: Get a list of bundle users
      description: Retrieve a list of bundle users currently enabled in the given cluster.
      operationId: listUsers
      parameters:
      - name: clusterId
        in: path
        required: true
        style: simple
        explode: false
        schema:
          type: string
          format: uuid
        example: 64223f17-7c9b-4986-8e2e-a44a91a26635
      - name: bundle
        in: path
        required: true
        style: simple
        explode: false
        schema:
          type: string
          example: kafka
      responses:
        '200':
          description: Successfully returned a JSON list of bundle users
          content:
            application/json:
              schema:
                type: array
                items:
                  type: string
              example:
              - ickafka
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorMessage'
        '401':
          description: Not Authorized
          content:
            application/json: {}
        '403':
          description: Missing permissions
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorMessage'
        '404':
          description: Resource not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorMessage'
        '415':
          description: 'Unsupported media type: returned when the payload is in an unsupported format.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorMessage'
        '429':
          description: 'Too many requests: returned when more than 35 requests per second are being received by your user.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorMessage'
        '503':
          description: Service Unavailable
        '504':
          description: Gateway Timeout
      deprecated: false
    post:
      tags:
      - Bundle User
      summary: Add a bundle user
      description: Add a new bundle user to the given cluster with read write access to all topics
      operationId: createUser
      parameters:
      - name: clusterId
        in: path
        required: true
        style: simple
        explode: false
        schema:
          type: string
          format: uuid
        example: 64223f17-7c9b-4986-8e2e-a44a91a26635
      - name: bundle
        in: path
        required: true
        style: simple
        explode: false
        schema:
          type: string
          example: kafka
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BundleUserCreateRequest'
      responses:
        '201':
          description: Bundle user successfully created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GenericResponse'
              example:
                message: User test1 created.
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorMessage'
        '401':
          description: Not Authorized
          content:
            application/json: {}
        '403':
          description: Missing permissions
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorMessage'
        '404':
          description: Resource not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorMessage'
        '415':
          description: 'Unsupported media type: returned when the payload is in an unsupported format.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorMessage'
        '429':
          description: 'Too many requests: returned when more than 35 requests per second are being received by your user.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorMessage'
        '503':
          description: Service Unavailable
        '504':
          description: Gateway Timeout
      deprecated: false
    delete:
      tags:
      - Bundle User
      summary: Delete a bundle user
      description: Delete bundle user for a given username
      operationId: deleteUser
      parameters:
      - name: clusterId
        in: path
        required: true
        style: simple
        explode: false
        schema:
          type: string
          format: uuid
        example: 64223f17-7c9b-4986-8e2e-a44a91a26635
      - name: bundle
        in: path
        required: true
        style: simple
        explode: false
        schema:
          type: string
          example: kafka
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BundleUserDeleteRequest'
      responses:
        '200':
          description: Bundle user successfully deleted
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GenericResponse'
              example:
                message: User test1 has been deleted.
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorMessage'
        '401':
          description: Not Authorized
          content:
            application/json: {}
        '403':
          description: Missing permissions
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorMessage'
        '404':
          description: Resource not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorMessage'
        '415':
          description: 'Unsupported media type: returned when the payload is in an unsupported format.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorMessage'
        '429':
          description: 'Too many requests: returned when more than 35 requests per second are being received by your user.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorMessage'
        '503':
          description: Service Unavailable
        '504':
          description: Gateway Timeout
      deprecated: false
    servers:
    - url: https://api.instaclustr.com
      description: Instaclustr API
  /provisioning/v1/{clusterId}/{bundle}/users/reset-password:
    post:
      tags:
      - Bundle User
      summary: Change bundle user password
      description: Reset bundle user password for a given username
      operationId: resetPasswordForUser
      parameters:
      - name: clusterId
        in: path
        required: true
        style: simple
        explode: false
        schema:
          type: string
          format: uuid
        example: 64223f17-7c9b-4986-8e2e-a44a91a26635
      - name: bundle
        in: path
        required: true
        style: simple
        explode: false
        schema:
          type: string
          example: kafka
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BundleUserResetPasswordRequest'
      responses:
        '200':
          description: Password successfully reset
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GenericResponse'
              example:
                message: Updated password for user test1.
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorMessage'
        '401':
          description: Not Authorized
          content:
            application/json: {}
        '403':
          description: Missing permissions
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorMessage'
        '404':
          description: Resource not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorMessage'
        '415':
          description: 'Unsupported media type: returned when the payload is in an unsupported format.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorMessage'
        '429':
          description: 'Too many requests: returned when more than 35 requests per second are being received by your user.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorMessage'
        '503':
          description: Service Unavailable
        '504':
          description: Gateway Timeout
      deprecated: false
    servers:
    - url: https://api.instaclustr.com
      description: Instaclustr API
components:
  schemas:
    BundleUserDeleteRequest:
      required:
      - username
      type: object
      properties:
        username:
          maxLength: 255
          minLength: 1
          type: string
          example: yourUserName
    GenericResponse:
      type: object
      properties:
        message:
          type: string
          description: message content
    BundleUserCreateRequest:
      required:
      - password
      - username
      type: object
      properties:
        username:
          maxLength: 255
          minLength: 1
          type: string
          example: yourUserName
        password:
          maxLength: 2147483647
          minLength: 8
          type: string
          description: Bundle user password
          example: yourPassword
        options:
          type: object
          description: 'A collection of optional bundle-specific user options - the options available to be set differ depending on the bundle type.</h3><table style="width:100%;word-break:break-word;font-size:0.8em">

            <tr><th>Bundle</th><th>Option</th><th>Allowable values</th></tr>

            <tr><td>Kafka</td><td>"sasl-scram-mechanism"</td><td>"SCRAM-SHA-256" (Default), "SCRAM-SHA-512"</td></tr>

            <tr><td>Kafka</td><td>"override-existing-user"</td><td>true (Default), false</td></tr>

            </table>'
          example:
            override-existing-user: true
            sasl-scram-mechanism: SCRAM-SHA-512
        initial-permissions:
          type: string
          description: Permissions upon user creation
          writeOnly: true
          example: standard
          enum:
          - standard
          - read-only
          - limited-admin
          - none
    BundleUserResetPasswordRequest:
      required:
      - password
      - username
      type: object
      properties:
        username:
          maxLength: 255
          minLength: 1
          type: string
          example: yourUserName
        password:
          maxLength: 2147483647
          minLength: 8
          type: string
          description: Password to apply
          example: yourNewPassword
        options:
          type: object
          description: 'A collection of optional bundle-specific user options - the options available to be set differ depending on the bundle type.</h3><table style="width:100%;word-break:break-word;font-size:0.8em">

            <tr><th>Bundle</th><th>Option</th><th>Allowable values</th></tr>

            <tr><td>Kafka</td><td>"sasl-scram-mechanism"</td><td>"SCRAM-SHA-256" (Default), "SCRAM-SHA-512"</td></tr>

            </table>'
          example:
            sasl-scram-mechanism: SCRAM-SHA-512
    ErrorMessage:
      type: object
      properties:
        status:
          type: integer
          format: int32
        message:
          type: string
        errorDetails:
          type: object
        code:
          type:
          - integer
          - 'null'
          format: int32
        link:
          type:
          - string
          - 'null'
  securitySchemes:
    Basic_Authentication:
      type: http
      description: Most requests to the API must use Basic Authentication and contain a valid username and appropriate API key for the endpoint.<br><br>API keys can be retrieved any time from the <a href='https://console2.instaclustr.com/' target='_blank'>console</a>. To find the API key relevant to the endpoint, refer to the Authentication & Rate Limit section for the endpoint or the group of the endpoint.
      scheme: basic
    No_Authentication:
      type: http
      description: Certain endpoints are publicly available and does not need any authentication to access.
      scheme: none
x-refined-from:
- instaclustr-deprecated-openapi.json
- instaclustr-deprecated-openapi.yml
x-tagGroups:
- name: Cluster Management V2
  tags:
  - Cluster Management V2 - Trait
  - Account Cluster List V2
  - AWS Encryption Key V2
  - AWS Endpoint DNS Names V2
  - AWS Endpoint Service Names V2
  - AWS Endpoint Service Principals V2
  - AWS FSx ONTAP File Systems
  - AWS FSx ONTAP Filesystem Credentials V2
  - AWS Prefix List Firewall Rule V1
  - AWS Prefix List Firewall Rules V1
  - AWS Security Group Firewall Rule V2
  - AWS Security Group Firewall Rules V2
  - AWS VPC Peer V2
  - Apache Cassandra Provisioning V2
  - Apache Kafka ACL V2
  - Apache Kafka ACL V3
  - Apache Kafka Connect Mirror V2
  - Apache Kafka Connect Provisioning V2
  - Apache Kafka Provisioning V2
  - Apache Kafka Provisioning V3
  - Apache Kafka Rest Proxy User
  - Apache Kafka Schema Registry User
  - Apache Kafka Tiered Storage
  - Apache Kafka Topic V2
  - Apache Kafka Topic V3
  - Apache Kafka User
  - Apache Zookeeper Provisioning V2
  - Azure Private Link Service Subscriptions
  - Azure Vnet Peer V2
  - BYOC AWS CloudFormation
  - BYOC AWS Provider Account Setup V1
  - Cadence Domain Rate Limits V2
  - Cadence Global Domain Rate Limits V2
  - Cadence Provisioning V2
  - ClickHouse Configurations
  - ClickHouse Integrations
  - ClickHouse Provisioning
  - Cloud Provider Details V2
  - Cluster Exclusion Window V2
  - Cluster Maintenance Events V2
  - Cluster Network Firewall Rule V2
  - Cluster Network Firewall Rules V2
  - Cluster Non Recurring Exclusion Window V2
  - Cluster Settings V2
  - Cluster Suspend Resume V2
  - Custom Tags V2
  - GCP PSC Service Attachments Accept List V2
  - GCP VPC Peer V2
  - Horizontal Scaling Operations
  - Karapace Rest Proxy User
  - Karapace Schema Registry User
  - MCP Gateway Backend V1
  - MCP Gateway Persona Access Control V1
  - MCP Gateway Provisioning V1
  - MCP Gateway Tool V1
  - MCP Gateway Virtual Server V1
  - Management Units Usage
  - OpenSearch Egress Rules V2
  - OpenSearch External S3 Bucket V2
  - OpenSearch Provisioning V2
  - PostgreSQL Configuration V2
  - PostgreSQL Operations
  - PostgreSQL Provisioning V2
  - Private Link Private Service Connect Endpoint Addresses V2
  - Redis Provisioning V2
  - Redis User V2
  - Resize Operations V2
  - Terraform Import V2
  - User Actions V3
  - Valkey Provisioning V2
  - Valkey User V2
- name: Monitoring
  tags:
  - Monitoring - Trait
  - Monitoring API
  - Monitoring API - Cluster
  - Monitoring API - Data Centre
  - Monitoring API - Node
- name: User Management
  tags:
  - User Management and SCIM 2.0 API - Trait
  - Service User Management API
  - User Management and SCIM 2.0 API
- name: Other
  tags:
  - Organization Management API
  - Pricing information - Node sizes