openapi: 3.0.0
info:
  title: Secret Server Rest Activations Subscriptions API
  description: REST API documentation for Secret Server. This document describes how to use the REST API. All requests require an authentication token; please see the <a href="../OAuth/">authentication document</a> for more information. The <a href="swagger.json">Swagger specification</a> for this API is also available.
  termsOfService: https://delinea.com/eula
  contact:
    name: Support
    url: https://delinea.com
  version: 11.7.2
servers:
- url: /SecretServer/api
security:
- BearerToken: []
tags:
- name: Subscriptions
  description: SubscriptionsController
paths:
  /v1/subscriptions:
    get:
      tags:
      - Subscriptions
      summary: Get subscriptions
      description: Return information about the cloud subscription
      operationId: SubscriptionsService_GetSubscriptions
      responses:
        '200':
          description: Cloud subscription information
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SubscriptionsModel'
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BadRequestResponse'
        '403':
          description: Authentication failed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AuthenticationFailedResponse'
        '500':
          description: Internal server error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServerErrorResponse'
      deprecated: false
components:
  schemas:
    CloudSubscriptionSummaryModel:
      description: Subscriptions
      properties:
        description:
          description: Description
          type: string
        displayName:
          description: DisplayName
          type: string
        endDate:
          description: EndDate
          type: string
          format: date-time
          nullable: true
        note:
          description: Note
          type: string
        recurrence:
          description: Recurrence
          type: string
        startDate:
          description: StartDate
          type: string
          format: date-time
        units:
          description: Units
          type: integer
          format: int32
      type: object
    BadRequestResponse:
      description: Response object for invalid requests
      required:
      - message
      properties:
        message:
          description: Error message
          type: string
        messageDetail:
          description: Error message detail
          type: string
        errorCode:
          description: Error message code
          type: string
        modelState:
          description: An object describing validation errors
          type: object
      type: object
    InternalServerErrorResponse:
      description: Response object for internal server errors
      required:
      - message
      - exceptionMessage
      - exceptionType
      - stackTrace
      properties:
        message:
          description: Error message
          type: string
        exceptionMessage:
          description: Error message from exception
          type: string
        exceptionType:
          description: Exception type
          type: string
        stackTrace:
          description: Exception stack trace
          type: string
      type: object
    SubscriptionsModel:
      description: Cloud subscriptions
      properties:
        maxNumberOfDefaultEngines:
          description: MaxNumberOfDefaultEngines
          type: integer
          format: int32
        maxNumberOfNonDefaultEngines:
          description: MaxNumberOfNonDefaultEngines
          type: integer
          format: int32
        maxNumberOfSecrets:
          description: MaxNumberOfSecrets
          type: integer
          format: int32
        maxNumberOfSites:
          description: MaxNumberOfSites
          type: integer
          format: int32
        maxNumberOfUsers:
          description: MaxNumberOfUsers
          type: integer
          format: int32
        maxSessionMonitoringSecrets:
          description: MaxSessionMonitoringSecrets
          type: integer
          format: int32
        maxSessionMonitoringSecretsUnlimited:
          description: MaxSessionMonitoringSecretsUnlimited
          type: boolean
        maxSessionMonitoringStorage:
          description: MaxSessionMonitoringStorage
          type: integer
          format: int32
        numberOfDefaultEngines:
          description: NumberOfDefaultEngines
          type: integer
          format: int32
        numberOfNonDefaultEngines:
          description: NumberOfNonDefaultEngines
          type: integer
          format: int32
        numberOfSecrets:
          description: NumberOfSecrets
          type: integer
          format: int32
        numberOfSites:
          description: NumberOfSites
          type: integer
          format: int32
        numberOfUsers:
          description: NumberOfUsers
          type: integer
          format: int32
        sessionMonitoringSecrets:
          description: SessionMonitoringSecrets
          type: integer
          format: int32
        sessionMonitoringStorage:
          description: SessionMonitoringStorage
          type: number
          format: float
        subscriptions:
          description: Subscriptions
          items:
            $ref: '#/components/schemas/CloudSubscriptionSummaryModel'
          type: array
      type: object
    AuthenticationFailedResponse:
      description: Response object for authentication failures
      required:
      - message
      properties:
        message:
          description: Error message
          type: string
      type: object
  securitySchemes:
    BearerToken:
      type: apiKey
      description: 'Perform a POST request to `/oauth2/token`. It should include three form data parameters - `username`, `password`, and `grant_type`.The `grant_type` parameter should always have the value `password`.The access token returned should be included in the header of subsequent requests, like ''Authorization: Bearer <em>token</em>''. The token remains valid for a time period returned in the ''expires_in'' property (in seconds). For details, see the <a href="../OAuth/">token request documentation</a>.'
      name: Authorization
      in: header