openapi: 3.0.0
info:
  title: Secret Server Rest Activations RemotePasswordChanging 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: RemotePasswordChanging
  description: 'View Password Changing Settings '
paths:
  /v1/remote-password-changing/password-types/{id}:
    get:
      tags:
      - RemotePasswordChanging
      summary: Password Type By Id
      description: Gets Password Type By Id
      operationId: RemotePasswordChangingService_GetPasswordType
      parameters:
      - name: id
        in: path
        description: Password Type Id
        required: true
        schema:
          type: integer
          format: int32
      responses:
        '200':
          description: PasswordType
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PasswordTypeModel'
        '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
    put:
      tags:
      - RemotePasswordChanging
      summary: Update Password Type
      description: Update a Password Type
      operationId: RemotePasswordChangingService_UpdatePasswordType
      parameters:
      - name: id
        in: path
        description: Password Type Id
        required: true
        schema:
          type: integer
          format: int32
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PasswordTypeUpdateArgs'
        description: Password Type update options
      responses:
        '200':
          description: Updated Password Type
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PasswordTypeModel'
        '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
    delete:
      tags:
      - RemotePasswordChanging
      summary: Delete Password Type
      description: Delete a Password Type
      operationId: RemotePasswordChangingService_DeletePasswordType
      parameters:
      - name: id
        in: path
        description: Password Type Id
        required: true
        schema:
          type: integer
          format: int32
      responses:
        '200':
          description: Delete Password Type Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeletedModel'
        '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
  /v1/remote-password-changing/custom-commands/{id}:
    get:
      tags:
      - RemotePasswordChanging
      summary: Custom Command List
      description: Lists Available Custom Command for Password Type
      operationId: RemotePasswordChangingService_GetCustomCommands
      parameters:
      - name: id
        in: path
        description: Password Type Id
        required: true
        schema:
          type: integer
          format: int32
      - name: filter.commandTypeCode
        in: query
        description: CommandTypeCode
        required: false
        x-nullable: true
        schema:
          type: integer
          format: int32
      - name: skip
        in: query
        description: Number of records to skip before taking results
        required: false
        schema:
          type: integer
          format: int32
      - name: sortBy[0].direction
        in: query
        description: Sort direction
        required: false
        schema:
          type: string
      - name: sortBy[0].name
        in: query
        description: Sort field name
        required: false
        schema:
          type: string
      - name: sortBy[0].priority
        in: query
        description: Priority index. Sorts with lower values are executed earlier
        required: false
        schema:
          type: integer
          format: int32
      - name: take
        in: query
        description: Maximum number of records to include in results
        required: false
        schema:
          type: integer
          format: int32
      responses:
        '200':
          description: Custom Command List result for Password Type
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PagingOfCustomCommandModel'
        '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
    put:
      tags:
      - RemotePasswordChanging
      summary: Update Custom Command
      description: Update a Custom Command
      operationId: RemotePasswordChangingService_UpdateCustomCommand
      parameters:
      - name: id
        in: path
        description: Custom Command Id
        required: true
        schema:
          type: integer
          format: int32
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CustomCommandUpdateArgs'
        description: Custom Command update options
      responses:
        '200':
          description: Updated Custom Command
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CustomCommandModel'
        '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
    delete:
      tags:
      - RemotePasswordChanging
      summary: Delete Custom Command
      description: Delete a Custom Command
      operationId: RemotePasswordChangingService_DeleteCustomCommand
      parameters:
      - name: id
        in: path
        description: Custom Command Id
        required: true
        schema:
          type: integer
          format: int32
      responses:
        '200':
          description: Delete Password Custom Command
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeletedModel'
        '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
  /v1/remote-password-changing/password-types:
    get:
      tags:
      - RemotePasswordChanging
      summary: Password Type List
      description: Lists Available Password Types
      operationId: RemotePasswordChangingService_GetPasswordTypeList
      parameters:
      - name: filter.includeInactive
        in: query
        description: Whether to include inactive Password Types in the results
        required: false
        schema:
          type: boolean
      - name: filter.onlyIncludeCanEdits
        in: query
        description: When true, only include password types that have CanEdit
        required: false
        x-nullable: true
        schema:
          type: boolean
      - name: filter.onlyIncludeSqlScriptOptions
        in: query
        description: When true, only scripts that can be assigned to a SQL script will be returned
        required: false
        x-nullable: true
        schema:
          type: boolean
      - name: filter.searchTerm
        in: query
        description: Search password type name for this text
        required: false
        schema:
          type: string
      - name: skip
        in: query
        description: Number of records to skip before taking results
        required: false
        schema:
          type: integer
          format: int32
      - name: sortBy[0].direction
        in: query
        description: Sort direction
        required: false
        schema:
          type: string
      - name: sortBy[0].name
        in: query
        description: Sort field name
        required: false
        schema:
          type: string
      - name: sortBy[0].priority
        in: query
        description: Priority index. Sorts with lower values are executed earlier
        required: false
        schema:
          type: integer
          format: int32
      - name: take
        in: query
        description: Maximum number of records to include in results
        required: false
        schema:
          type: integer
          format: int32
      responses:
        '200':
          description: PasswordType List result
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PagingOfPasswordTypeSummary'
        '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
    post:
      tags:
      - RemotePasswordChanging
      summary: Create Password Type
      description: Create a New Password Type
      operationId: RemotePasswordChangingService_CreatePasswordType
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PasswordTypeCreateArgs'
        description: Password Type creation options
      responses:
        '200':
          description: Created Password Type
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PasswordTypeModel'
        '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
  /v1/remote-password-changing/password-type-auth/{id}:
    get:
      tags:
      - RemotePasswordChanging
      summary: Get Password Type Auth
      description: Get Password Type Auths for a Password Type
      operationId: RemotePasswordChangingService_GetPasswordTypeAuth
      parameters:
      - name: id
        in: path
        description: Password Type Id
        required: true
        schema:
          type: integer
          format: int32
      responses:
        '200':
          description: Password Type Auths for the Password Type
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PasswordTypeAuthModel'
        '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
    post:
      tags:
      - RemotePasswordChanging
      summary: Create Password Type Auth
      description: Create Password Type Auths for a Password Type
      operationId: RemotePasswordChangingService_CreatePasswordTypeAuth
      parameters:
      - name: id
        in: path
        description: Password Type Auth Id
        required: true
        schema:
          type: integer
          format: int32
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PasswordTypeAuthCreateArgs'
        description: Password Type Auth create options
      responses:
        '200':
          description: Password Type Auths for the Password Type
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PasswordTypeAuthModel'
        '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
    patch:
      tags:
      - RemotePasswordChanging
      summary: Update Password Type Auth
      description: Update a Password Type Auth
      operationId: RemotePasswordChangingService_UpdatePasswordTypeAuth
      parameters:
      - name: id
        in: path
        description: Password Type Auth Id
        required: true
        schema:
          type: integer
          format: int32
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PasswordTypeAuthUpdateArgs'
        description: Password Type Auth update options
      responses:
        '200':
          description: Password Type Auths for the Password Type
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PasswordTypeAuthModel'
        '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
  /v1/remote-password-changing/custom-commands:
    post:
      tags:
      - RemotePasswordChanging
      summary: Create Custom Command
      description: Create a New Custom Command
      operationId: RemotePasswordChangingService_CreateCustomCommand
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CustomCommandCreateArgs'
        description: Custom Command creation options
      responses:
        '200':
          description: Created Custom Command
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CustomCommandModel'
        '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
  /v2/remote-password-changing/password-types/{id}:
    put:
      tags:
      - RemotePasswordChanging
      summary: Update Password Type
      description: Update a Password Type
      operationId: RemotePasswordChangingService_UpdatePasswordTypeV2
      parameters:
      - name: id
        in: path
        description: Password Type Id
        required: true
        schema:
          type: integer
          format: int32
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PasswordTypeUpdateArgsV2'
        description: Password Type update options
      responses:
        '200':
          description: Updated Password Type
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PasswordTypeModel'
        '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:
    Sort:
      description: Sort options. Multiple sort options can be provided in the query string.
      required:
      - name
      - direction
      properties:
        direction:
          $ref: '#/components/schemas/SortDirection'
        name:
          description: Sort field name
          type: string
        priority:
          description: Priority index. Sorts with lower values are executed earlier
          type: integer
          format: int32
      type: object
    UpdateFieldValueOfRunnerType:
      description: Runner Type
      properties:
        dirty:
          description: Dirty
          type: boolean
        value:
          $ref: '#/components/schemas/RunnerType'
      type: object
    RunnerType:
      description: Runner Type
      properties: {}
      type: string
      enum:
      - Standard
      - Legacy
    UpdateFieldValueOfBoolean:
      description: Active
      properties:
        dirty:
          description: Dirty
          type: boolean
        value:
          description: Value
          type: boolean
      type: object
    SortDirection:
      description: Sort direction
      properties: {}
      type: string
      enum:
      - None
      - Asc
      - Desc
    Severity:
      description: Error severity level
      properties: {}
      type: string
      enum:
      - None
      - Retry
      - Warn
      - Critical
      - Fatal
    IRestPasswordTypeField:
      description: Password Type Fields
      properties:
        isOptional:
          description: IsOptional
          type: boolean
        name:
          description: Name
          type: string
        passwordTypeFieldId:
          description: PasswordTypeFieldId
          type: integer
          format: int32
        scanItemFieldId:
          description: ScanItemFieldId
          type: integer
          format: int32
          nullable: true
      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
    CustomCommandUpdateArgs:
      description: CustomCommandUpdateArgs
      properties:
        command:
          description: Command
          type: string
        commandTypeCode:
          description: CommandTypeCode
          type: integer
          format: int32
        comment:
          description: Comment
          type: string
        concurrencyId:
          description: ConcurrencyId
          type: string
        order:
          description: Order
          type: integer
          format: int32
        passwordTypeId:
          description: PasswordTypeId
          type: integer
          format: int32
        pause:
          description: Pause
          type: integer
          format: int32
      type: object
    UpdateFieldValueOfOptionalInt32:
      description: The minimum length required for local user passwords
      properties:
        dirty:
          description: Dirty
          type: boolean
        value:
          description: Value
          type: integer
          format: int32
          nullable: true
      type: object
    PagingOfPasswordTypeSummary:
      description: Specify paging and sorting options for querying records and returning results
      properties:
        batchCount:
          description: Number of result batches available with current query options
          type: integer
          format: int32
        currentPage:
          description: Index of current result page
          type: integer
          format: int32
        hasNext:
          description: Whether there are any results in additional pages
          type: boolean
        hasPrev:
          description: Whether there are any results in previous pages
          type: boolean
        nextSkip:
          description: Correct value of 'skip' for the next page of results
          type: integer
          format: int32
        pageCount:
          description: Number of result pages available with current query options
          type: integer
          format: int32
        prevSkip:
          description: Correct value of 'skip' for the previous page of results
          type: integer
          format: int32
        records:
          description: Query results
          items:
            $ref: '#/components/schemas/PasswordTypeSummary'
          type: array
        severity:
          $ref: '#/components/schemas/Severity'
        skip:
          description: Number of records to skip before taking results
          type: integer
          format: int32
        sortBy:
          description: List of sort properties
          items:
            $ref: '#/components/schemas/Sort'
          type: array
        success:
          description: Whether the query executed successfully
          type: boolean
        take:
          description: Maximum number of records to include in results
          type: integer
          format: int32
        total:
          description: Total number of results available
          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
    CustomCommandModel:
      description: Displays the properties of a Custom Command
      properties:
        command:
          description: Command Text
          type: string
        commandTypeCode:
          description: Command Type Code
          type: integer
          format: int32
        comment:
          description: Comment
          type: string
        concurrencyId:
          description: Concurrency Id
          type: string
        customCommandId:
          description: Custom Command Id
          type: integer
          format: int32
        order:
          description: Order number
          type: integer
          format: int32
        passwordTypeId:
          description: Password Type Id
          type: integer
          format: int32
        pause:
          description: Pause Duration (milliseconds)
          type: integer
          format: int32
      type: object
    PasswordTypeUpdateModel:
      description: Data
      properties:
        active:
          $ref: '#/components/schemas/UpdateFieldValueOfBoolean'
        customPort:
          $ref: '#/components/schemas/UpdateFieldValueOfOptionalInt32'
        exitCommand:
          $ref: '#/components/schemas/UpdateFieldValueOfString'
        ignoreSSL:
          $ref: '#/components/schemas/UpdateFieldValueOfBoolean'
        lineEnding:
          $ref: '#/components/schemas/UpdateFieldValueOfLineEnding'
        mainframeConnectionString:
          $ref: '#/components/schemas/UpdateFieldValueOfString'
        name:
          $ref: '#/components/schemas/UpdateFieldValueOfString'
        odbcConnectionString:
          $ref: '#/components/schemas/UpdateFieldValueOfString'
        requestTerminal:
          $ref: '#/components/schemas/UpdateFieldValueOfBoolean'
        runnerType:
          $ref: '#/components/schemas/UpdateFieldValueOfRunnerType'
        useSSL:
          $ref: '#/components/schemas/UpdateFieldValueOfBoolean'
        useUsernameAndPassword:
          $ref: '#/components/schemas/UpdateFieldValueOfBoolean'
        validForTakeover:
          $ref: '#/components/schemas/UpdateFieldValueOfBoolean'
        windowsCustomPorts:
          $ref: '#/components/schemas/UpdateFieldValueOfString'
      type: object
    PasswordTypeAuthUpdateArgs:
      description: The update arguments for password auth
      properties:
        data:
          $ref: '#/components/schemas/PasswordTypeAuthUpdateModel'
      type: object
    PasswordTypeAuthModel:
      description: A model of password auths for a password changer
      properties:
        commands:
          description: A list of all the password changer command auths
          items:
            $ref: '#/components/schemas/PasswordTypeAuthCommandModel'
          type: array
      type: object
    DeletedModel:
      description: Information about an object that was deleted
      properties:
        id:
          description: ID of the deleted object
          type: integer
          format: int32
        objectType:
          description: Type of the deleted object
          type: string
        responseCodes:
          description: List of response codes from the delete operation
          items:
            type: string
          type: array
      type: object
    PasswordTypeModel:
      description: Displays the properties of a Password Type
      properties:
        active:
          description: 'Whether the Password Type is Active '
          type: boolean
        allowsPrivilegedAccount:
          description: Allows a Default Privileged Account
          type: boolean
        canEdit:
          description: Whether the Password Type can be edited
          type: boolean
        concurrencyId:
          description: Globally unique Id
          type: string
        customPort:
          description: Custom Port
          type: integer
          format: int32
        exitCommand:
          description: Exit Command
          type: string
        fields:
          description: Password Type Fields
          items:
            $ref: '#/components/schemas/IRestPasswordTypeField'
          type: array
        hasCommands:
          description: Whether Commands Exist
          type: boolean
        hasLDAPSettings:
          description: Whether LDAP Settings Exist
          type: boolean
        heartbeatScriptArgs:
          description: Heartbeat Script Args
          type: string
        heartbeatScriptId:
          description: Heartbeat Script Id
          type: integer
          format: int32
          nullable: true
        ignoreSSL:
          description: Whether Password Type ignores SSL warnings
          type: boolean
        isWeb:
          description: Whether Is Web
          type: boolean
        ldapConnectionSettingsId:
          description: LDAP Connection Settings Id
          type: integer
          format: int32
          nullable: true
        lineEnding:
          $ref: '#/components/schemas/LineEnding'
        mainframeConnectionString:
          description: Mainframe Connection String
          type: string
        name:
          description: Password Type Name
          type: string
        odbcConnectionString:
          description: ODBC Connection String
          type: string
        passwordTypeId:
          description: Password Type Id
          type: integer
          format: int32
        requestTerminal:
          description: Request Terminal
          type: boolean
        rpcScriptArgs:
          description: RPC Script Args
          type: string
        rpcScriptId:
          description: RPC Script Id
          type: integer
          format: int32
          nullable: true
        runnerType:
          $ref: '#/components/schemas/RunnerType'
        scanItemTemplateId:
          description: Scan Template Id
          type: integer
          format: int32
          nullable: true
        supportsCustomSettings:
          description: Identifies if changer supports custom settings
          type: boolean
        supportsIgnoreSslErrors:
          description: Identifies if changer supports ignoring of SSL errors
          type: boolean
        supportsSsl:
          description: Identifies if changer supports SSL
          type: boolean
        supportsTakeOver:
          description: Identifies if changer supports take over
          type: boolean
        supportsUseSsl:
          description: Identifies if changer supports Use of SSL
          type: boolean
        typeName:
          description: Federator Type
          type: string
        useSSL:
          description: Whether Password Type uses SSL
          type: boolean
        useUsernameAndPassword:
          description: Whether Password Type uses both Username and Password
          type: boolean
        validForTakeover:
          description: Whether is Valid For Takeover
          type: boolean
        windowsCustomPorts:
          description: Custom Ports for Windows
          type: string
      type: object
    PagingOfCustomCommandModel:
      description: Specify paging and sorting options for querying records and returning results
      properties:
        batchCount:
          description: Number of result batches available with current query options
          type: integer
          format: int32
        currentPage:
          description: Index of current result page
          type: integer
          format: int32
        hasNext:
          description: Whether there are any results in additional pages
          type: boolean
        hasPrev:
          description: Whether there are any results in previous pages
          type: boolean
        nextSkip:
          description: Correct value of 'skip' for the next page of results
          type: integer
          format: int32
        pageCount:
          description: Number of result pages available with current query options
          type: integer
          format: int32
        prevSkip:
          description: Correct value of 'skip' for the previous page of results
          type: integer
          format: int32
        records:
          description: Query results
          items:
            $ref: '#/components/schemas/CustomCommandModel'
          type: array
        severity:
          $ref: '#/components/schemas/Severity'
        skip:
          description: Number of records to skip before taking results
          type: integer
          format: int32
        sortBy:
          description: List of sort properties
          items:
            $ref: '#/components/schemas/Sort'
          type: array
        success:
          description: Whether the query executed successfully
          type: boolean
        take:
          description: Maximum number of records to include in results
          type: integer
          format: int32
        total:
          description: Total number of results available
          type: integer
          format: int32
      type: object
    PasswordTypeAuthCommandModel:
      description: A model fo the password auth for an RPC command
      properties:
        commandTypeCode:
          description: The command type code for the password auth
          type: integer
          format: int32
        id:
          description: The ID of the password auth
          type: integer
          format: int32
        key:
          description: The key parameter
          type: string
        passphrase:
          description: The passphrase parameter
          type: string
        password:
          description: The password parameter
          type: string
        passwordTypeId:
          description: The password type ID for the RPC auth
          type: integer
          format: int32
        username:
          description: The username parameter
          type: string
      type: object
    PasswordTypeSummary:
      description: Password Type summary
      properties:
        active:
          description: Active
          type: boolean
        canEdit:
          description: CanEdit
          type: boolean
        hasCommands:
          description: HasCommands
          type: boolean
        heartbeatScriptId:
          description: HeartbeatScriptId
          type: integer
          format: int32
          nullable: true
        ignoreSSL:
          description: IgnoreSSL
          type: boolean
        isWeb:
          description: IsWeb
          type: boolean
        name:
          description: Name
          type: string
        passwordTypeId:
          description: PasswordTypeId
          type: integer
          format: int32
        requiredEdition:
          description: RequiredEdition
          type: string
        requiredEditionMessage:
          description: RequiredEditionMessage
          type: string
        rpcScriptId:
          description: RPCScriptId
          type: integer
          format: int32
          nullable: true
        runnerType:
          $ref: '#/components/schemas/RunnerType'
        scanItemTemplateActive:
          description: ScanItemTemplateActive
          type: boolean
        scanItemTemplateId:
          description: ScanItemTemplateId
          type: integer
          format: int32
          nullable: true
        scanItemTemplateName:
          description: ScanItemTemplateName
          type: string
        useSSL:
          description: UseSSL
          type: boolean
      type: object
    PasswordTypeAuthCreateModel:
      description: Password Type Auth Create Model
      properties:
        commandTypeCode:
          description: The command type code
          type: integer
          format: int32
        key:
          description: The key argument
          type: string
        passphrase:
          description: The passphrase argument
          type: string
        password:
          description: The password argument
          type: string
        username:
          description: The user name argument
          type: string
      type: object
    PasswordTypeAuthCreateArgs:
      description: Password Type Auth Create Args
      properties:
        data:
          $ref: '#/components/schemas/PasswordTypeAuthCreateModel'
      type: object
    PasswordTypeAuthUpdateModel:
      description: Password auth update data
      properties:
        key:
          $ref: '#/components/schemas/UpdateFieldValueOfString'
        passphrase:
          $ref: '#/components/schemas/UpdateFieldValueOfString'
        password:
          $ref: '#/components/schemas/UpdateFieldValueOfString'
        username:
          $ref: '#/components/schemas/UpdateFieldValueOfString'
      type: object
    CustomCommandCreateArgs:
      description: CustomCommandCreateArgs
      properties:
        command:
          description: Command
          type: string
        commandTypeCode:
          description: CommandTypeCode
          type: integer
          format: int32
        comment:
          description: Comment
          type: string
        passwordTypeId:
          description: PasswordTypeId
          type: integer
          format: int32
        pause:
          description: Pause
          type: integer
          format: int32
      type: object
    ResetPasswordTypeFieldAddModel:
      description: 'Optional: If Base Password Type Id is null then used to look up Base Password Type.'
      properties:
        name:
          description: Name
          type: string
        scanItemFieldId:
          description: ScanItemFieldId
          type: integer
          format: int32
          nullable: true
      type: object
    AuthenticationFailedResponse:
      description: Response object for authentication failures
      required:
      - message
      properties:
        message:
          description: Error message
          type: string
      type: object
    PasswordTypeCreateArgs:
      description: PasswordTypeCreateArgs
      properties:
        basePasswordTypeId:
          description: Base Password Type Id to use as the parent.
          type: integer
          format: int32
          nullable: true
        concurrencyId:
          description: 'Optional: Global unique id.'
          type: string
        name:
          description: Password Type Name
          type: string
        passwordTypeFields:
          description: 'Optional: If Base Password Type Id is null then used to look up Base Password Type.'
          items:
            $ref: '#/components/schemas/ResetPasswordTypeFieldAddModel'
          type: array
        typeName:
          description: 'Optional: If Base Password Type Id is null then used to look up Base Password Type.'
          type: string
      type: object
    PasswordTypeUpdateArgsV2:
      description: PasswordTypeUpdateArgsV2
      properties:
        data:
          $ref: '#/components/schemas/PasswordTypeUpdateModel'
      type: object
    PasswordTypeUpdateArgs:
      description: PasswordTypeUpdateArgs
      properties:
        active:
          description: Active
          type: boolean
        canEdit:
          description: CanEdit
          type: boolean
        customPort:
          description: CustomPort
          type: integer
          format: int32
        exitCommand:
          description: ExitCommand
          type: string
        hasCommands:
          description: HasCommands
          type: boolean
        heartbeatScriptArgs:
          description: HeartbeatScriptArgs
          type: string
        heartbeatScriptId:
          description: HeartbeatScriptId
          type: integer
          format: int32
          nullable: true
        ignoreSSL:
          description: IgnoreSSL
          type: boolean
        isWeb:
          description: IsWeb
          type: boolean
        ldapConnectionSettingsId:
          description: LdapConnectionSettingsId
          type: integer
          format: int32
          nullable: true
        lineEnding:
          $ref: '#/components/schemas/LineEnding'
        mainframeConnectionString:
          description: MainframeConnectionString
          type: string
        name:
          description: Name
          type: string
        odbcConnectionString:
          description: ODBCConnectionString
          type: string
        rpcScriptArgs:
          description: RPCScriptArgs
          type: string
        rpcScriptId:
          description: RPCScriptId
          type: integer
          format: int32
          nullable: true
        runnerType:
          $ref: '#/components/schemas/RunnerType'
        scanItemTemplateId:
          description: ScanItemTemplateId
          type: integer
          format: int32
          nullable: true
        useSSL:
          description: UseSSL
          type: boolean
        useUsernameAndPassword:
          description: UseUsernameAndPassword
          type: boolean
        validForTakeover:
          description: ValidForTakeover
          type: boolean
        windowsCustomPorts:
          description: WindowsCustomPorts
          type: string
      type: object
    UpdateFieldValueOfString:
      description: Description
      properties:
        dirty:
          description: Dirty
          type: boolean
        value:
          description: Value
          type: string
      type: object
    UpdateFieldValueOfLineEnding:
      description: Line ending type
      properties:
        dirty:
          description: Dirty
          type: boolean
        value:
          $ref: '#/components/schemas/LineEnding'
      type: object
    LineEnding:
      description: Line ending type
      properties: {}
      type: string
      enum:
      - NewLine
      - CarriageReturn
      - CarriageReturnNewLine
  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