Dell Servers Sessions API

openapi: 3.2.0
info:
  title: Dell Servers Sessions API
  contact:
    name: Dell Technologies Support
    url: https://www.dell.com/support
  termsOfService: https://i.dell.com/sites/csdocuments/Legal_Docs/en/us/api-terms-of-use_en.pdf
  version: '1.0'
  description: 'Operations tagged Sessions across 2 of this provider''s published API definitions: dell-servers-idrac-redfish-openapi.yml, dell-servers-openmanage-enterprise-openapi.yml. Each path carries the servers of the definition it was published in.'
servers:
- url: https://{idrac-ip}/redfish/v1
  description: iDRAC Redfish Service Root
  variables:
    idrac-ip:
      description: IP address or hostname of the iDRAC interface
      default: 192.168.1.100
- url: https://{ome-server}/api
  description: OpenManage Enterprise API Server
  variables:
    ome-server:
      description: Hostname or IP address of the OpenManage Enterprise appliance
      default: ome-server.example.com
tags:
- name: Sessions
  description: Authentication session creation and management
paths:
  /SessionService/Sessions:
    get:
      operationId: listSessions
      summary: Dell Servers List active sessions
      description: Retrieves the collection of active sessions on the iDRAC including web UI sessions, Redfish API sessions, and SSH sessions.
      tags:
      - Sessions
      responses:
        '200':
          description: Collection of active sessions
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceCollection'
        '401':
          description: Unauthorized - invalid or missing credentials
      security:
      - basicAuth: []
    post:
      operationId: createSession
      summary: Dell Servers Create a new session
      description: Creates a new Redfish session by authenticating with username and password. Returns a session token in the X-Auth-Token response header that can be used for subsequent requests instead of basic authentication.
      tags:
      - Sessions
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
              - UserName
              - Password
              properties:
                UserName:
                  type: string
                  description: iDRAC username
                Password:
                  type: string
                  description: iDRAC password
      responses:
        '201':
          description: Session created successfully
          headers:
            X-Auth-Token:
              description: Session authentication token
              schema:
                type: string
            Location:
              description: URI of the created session resource
              schema:
                type: string
        '401':
          description: Authentication failed - invalid credentials
      security:
      - basicAuth: []
    servers:
    - url: https://{idrac-ip}/redfish/v1
      description: iDRAC Redfish Service Root
      variables:
        idrac-ip:
          description: IP address or hostname of the iDRAC interface
          default: 192.168.1.100
components:
  schemas:
    ResourceLink:
      type: object
      description: Link to a Redfish resource
      properties:
        '@odata.id':
          type: string
          description: OData resource URI
    ResourceCollection:
      type: object
      description: Redfish resource collection
      properties:
        '@odata.id':
          type: string
          description: OData resource identifier
        '@odata.type':
          type: string
          description: OData resource type
        Name:
          type: string
          description: Collection name
        Members@odata.count:
          type: integer
          description: Number of members in the collection
        Members:
          type: array
          description: Array of resource links
          items:
            $ref: '#/components/schemas/ResourceLink'
  securitySchemes:
    basicAuth:
      type: http
      scheme: basic
      description: HTTP Basic Authentication using iDRAC username and password credentials. All API requests require authentication except for the Redfish service root at /redfish/v1.
    sessionAuth:
      type: apiKey
      in: header
      name: X-Auth-Token
      description: Session-based authentication using a token obtained from the Sessions resource POST operation. The token is passed in the X-Auth-Token header.
x-refined-from:
- dell-servers-idrac-redfish-openapi.yml
- dell-servers-openmanage-enterprise-openapi.yml