openapi: 3.2.0
info:
  title: Infinidat InfiniBox REST API (7.3) Config API
  version: '7.3'
  summary: Management REST API served by every InfiniBox / InfiniBox SSA array.
  description: 'Derived faithfully from Infinidat''s own published Postman collection for the InfiniBox 7.3 API (https://github.com/Infinidat/api_7_3). The InfiniBox REST API is served by each array on-premises at https://<infinibox-host>/api/rest, so there is no single public base URL; the server below is a template. Operations, paths, parameters, request bodies and example responses are carried over verbatim from the collection - nothing has been invented. This is a partial surface: the collection carries 47 requests (46 against the array, one external Okta SSO redirect), which normalize to 40 operations across 38 paths. The full InfiniAPI surface documented on support.infinidat.com is larger.'
  contact:
    name: INFINIDAT Support
    url: https://support.infinidat.com/hc/en-us
  x-derived-from: postman/infinidat-infinibox-7-3-postman.json
  x-derivation-method: derived
servers:
- url: https://{infinibox_host}/api/rest
  description: The management API of a single InfiniBox array (the collection's {{sutURI}} variable).
  variables:
    infinibox_host:
      default: infinibox.example.com
      description: Hostname or management IP of the InfiniBox system.
security:
- basicAuth: []
- sessionCookie: []
tags:
- name: config
paths:
  /config:
    get:
      operationId: configGet
      summary: CONFIG Get
      tags:
      - config
      responses:
        '200':
          description: Successful response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InfiniBoxEnvelope'
        '401':
          description: Unauthenticated. The session is missing, expired or invalid.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InfiniBoxError'
      parameters:
      - $ref: '#/components/parameters/page'
      - $ref: '#/components/parameters/page_size'
      - $ref: '#/components/parameters/fields'
      - $ref: '#/components/parameters/sort'
  /config/ldap:
    post:
      operationId: ldapCreateAUserRepository
      summary: LDAP Create a User Repository
      tags:
      - config
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
            example:
              name: admin
              bind_username: admin
              bind_password: '123456'
              use_ldaps: true
              ldap_port: 389
              repository_type: LDAP
              servers:
              - infinidat.com
              schema_definition:
                group_class: groupOfNames
                group_memberof_attribute: memberof
                group_name_attribute: cn
                groups_basedn: ''
                user_class: posixAccount
                username_attribute: uid
                users_basedn: ''
      responses:
        '200':
          description: Successful response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InfiniBoxEnvelope'
        '401':
          description: Unauthenticated. The session is missing, expired or invalid.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InfiniBoxError'
  /config/ldap/:
    get:
      operationId: ldapGetRepositories
      summary: LDAP Get Repositories
      tags:
      - config
      responses:
        '200':
          description: Successful response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InfiniBoxEnvelope'
        '401':
          description: Unauthenticated. The session is missing, expired or invalid.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InfiniBoxError'
      parameters:
      - $ref: '#/components/parameters/page'
      - $ref: '#/components/parameters/page_size'
      - $ref: '#/components/parameters/fields'
      - $ref: '#/components/parameters/sort'
  /config/ldap/reload:
    post:
      operationId: ldapReload
      summary: LDAP Reload
      tags:
      - config
      responses:
        '200':
          description: Successful response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InfiniBoxEnvelope'
        '401':
          description: Unauthenticated. The session is missing, expired or invalid.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InfiniBoxError'
  /config/ldap/resolve_domain:
    post:
      operationId: ldapResolveDomain
      summary: LDAP Resolve Domain
      tags:
      - config
      responses:
        '200':
          description: Successful response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InfiniBoxEnvelope'
        '401':
          description: Unauthenticated. The session is missing, expired or invalid.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InfiniBoxError'
  /config/ldap/set_order:
    post:
      operationId: ldapReorder
      summary: LDAP Reorder
      tags:
      - config
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
            example: "[\n    {{ldapIds}}\n]"
      responses:
        '200':
          description: Successful response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InfiniBoxEnvelope'
        '401':
          description: Unauthenticated. The session is missing, expired or invalid.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InfiniBoxError'
  /config/ldap/test:
    post:
      operationId: ldapTestRepositoryComminucation
      summary: LDAP Test Repository Comminucation
      tags:
      - config
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
            example:
              name: admin
              domain_name: ad2k8r2.local
              bind_username: admin
              bind_password: '123456'
              use_ldaps: false
              ldap_port: 80
              repository_type: ActiveDirectory
              servers:
              - 172.20.84.246
              schema_definition:
                user_class: user
                username_attribute: sAMAccountName
                users_basedn: ''
                group_class: group
                group_name_attribute: cn
                group_memberof_attribute: memberof
                groups_basedn: ''
              id: 33
              search_order: 0
      responses:
        '200':
          description: Successful response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InfiniBoxEnvelope'
        '401':
          description: Unauthenticated. The session is missing, expired or invalid.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InfiniBoxError'
  /config/ldap/{ldap_id}:
    get:
      operationId: ldapGetFirstRepository
      summary: LDAP Get first Repository
      tags:
      - config
      parameters:
      - name: ldap_id
        in: path
        required: true
        schema:
          type: string
        description: Path variable carried verbatim from the InfiniBox 7.3 Postman collection.
      - $ref: '#/components/parameters/page'
      - $ref: '#/components/parameters/page_size'
      - $ref: '#/components/parameters/fields'
      - $ref: '#/components/parameters/sort'
      responses:
        '200':
          description: Successful response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InfiniBoxEnvelope'
        '401':
          description: Unauthenticated. The session is missing, expired or invalid.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InfiniBoxError'
    put:
      operationId: ldapUpdateTheRepositoryAttributes
      summary: LDAP Update the repository attributes
      tags:
      - config
      parameters:
      - name: ldap_id
        in: path
        required: true
        schema:
          type: string
        description: Path variable carried verbatim from the InfiniBox 7.3 Postman collection.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
            example:
              servers:
              - 1.0.0.9
      responses:
        '200':
          description: Successful response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InfiniBoxEnvelope'
        '401':
          description: Unauthenticated. The session is missing, expired or invalid.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InfiniBoxError'
  /config/ldap/{ldap_id}/test:
    post:
      operationId: ldapTestLDAPByID
      summary: LDAP Test LDAP by ID
      tags:
      - config
      parameters:
      - name: ldap_id
        in: path
        required: true
        schema:
          type: string
        description: Path variable carried verbatim from the InfiniBox 7.3 Postman collection.
      responses:
        '200':
          description: Successful response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InfiniBoxEnvelope'
        '401':
          description: Unauthenticated. The session is missing, expired or invalid.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InfiniBoxError'
  /config/ldap/{ldap_id}/test_group:
    post:
      operationId: ldapTestGroupByLDAPID
      summary: LDAP Test Group by LDAP ID
      tags:
      - config
      parameters:
      - name: ldap_id
        in: path
        required: true
        schema:
          type: string
        description: Path variable carried verbatim from the InfiniBox 7.3 Postman collection.
      responses:
        '200':
          description: Successful response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InfiniBoxEnvelope'
        '401':
          description: Unauthenticated. The session is missing, expired or invalid.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InfiniBoxError'
  /config/security:
    get:
      operationId: configSecurityGet
      summary: CONFIG Security Get
      tags:
      - config
      responses:
        '200':
          description: Successful response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InfiniBoxEnvelope'
        '401':
          description: Unauthenticated. The session is missing, expired or invalid.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InfiniBoxError'
      parameters:
      - $ref: '#/components/parameters/page'
      - $ref: '#/components/parameters/page_size'
      - $ref: '#/components/parameters/fields'
      - $ref: '#/components/parameters/sort'
components:
  parameters:
    page_size:
      name: page_size
      in: query
      required: false
      schema:
        type: integer
        default: 50
        maximum: 1000
      description: Objects per page; default 50, maximum 1000.
    sort:
      name: sort
      in: query
      required: false
      schema:
        type: string
      description: Field to sort by; prefix with - to reverse.
    page:
      name: page
      in: query
      required: false
      schema:
        type: integer
        default: 1
      description: 1-based page number (InfiniSDK efficient-querying guide).
    fields:
      name: fields
      in: query
      required: false
      schema:
        type: string
      description: Comma-separated list of fields to return.
  schemas:
    InfiniBoxError:
      type: object
      description: Error object carried on the envelope's error field.
      properties:
        code:
          type: string
        message:
          type: string
        severity:
          type: string
        reasons:
          type: array
          items:
            type: string
    InfiniBoxMetadata:
      type: object
      description: Pagination / readiness metadata returned alongside every result.
      properties:
        ready:
          type: boolean
        number_of_objects:
          type: integer
        page:
          type: integer
        page_size:
          type: integer
        pages_total:
          type: integer
    InfiniBoxEnvelope:
      type: object
      description: Standard InfiniBox response envelope observed in the collection's saved examples.
      properties:
        result:
          description: The requested object or array of objects.
        metadata:
          $ref: '#/components/schemas/InfiniBoxMetadata'
        error:
          oneOf:
          - type: 'null'
          - $ref: '#/components/schemas/InfiniBoxError'
  securitySchemes:
    basicAuth:
      type: http
      scheme: basic
      description: HTTP Basic authentication with an InfiniBox user, as used by InfiniSDK.
    sessionCookie:
      type: apiKey
      in: cookie
      name: sessionid
      description: Session established by POST /users/login and torn down by POST /users/logout.