openapi: 3.0.0
info:
  title: Secret Server Rest Activations Secrets 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: Secrets
  description: View and maintain Secrets
paths:
  /v1/secrets/{id}:
    put:
      tags:
      - Secrets
      summary: Update Secret
      description: Update a single secret by ID
      operationId: SecretsService_UpdateSecret
      parameters:
      - name: autoCheckIn
        in: query
        description: Automatically check in a secret after finding or updating.
        required: false
        schema:
          type: boolean
      - name: autoCheckout
        in: query
        description: Automatically check out secret before finding or updating.
        required: false
        schema:
          type: boolean
      - name: autoComment
        in: query
        description: Leave a comment when checking in or out.
        required: false
        schema:
          type: string
      - name: forceCheckIn
        in: query
        description: If secret is checked out, then force a check in.
        required: false
        schema:
          type: boolean
      - name: id
        in: path
        description: Secret ID
        required: true
        schema:
          type: integer
          format: int32
      - name: secretPath
        in: query
        description: A full path including folder and secret name can be passed as a query string parameter when the secret ID is set to 0.  This will lookup the secret ID by path.
        required: false
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SecretUpdateArgs'
        description: Secret update options
      responses:
        '200':
          description: Secret object
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SecretModel'
        '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:
      - Secrets
      summary: Deactivate a Secret
      description: A deactivated secret is hidden from users who do not have a role containing the View Inactive Secrets permission. Secret Server uses these "soft deletes" to maintain the audit history for all data. However, deactivated secrets are still accessible by administrators (like a permanent Recycle Bin) to ensure that audit history is maintained and to support recovery. A user must have the "View Inactive Secrets" permission in addition to Owner permission on a secret to access the secret View page for a deleted secret. To permanently remove all information on a secret, use the "Erase Secret" function.
      operationId: SecretsService_Delete
      parameters:
      - name: autoCheckIn
        in: query
        description: Automatically check in a secret after finding or updating.
        required: false
        schema:
          type: boolean
      - name: autoCheckout
        in: query
        description: Automatically check out secret before finding or updating.
        required: false
        schema:
          type: boolean
      - name: autoComment
        in: query
        description: Leave a comment when checking in or out.
        required: false
        schema:
          type: string
      - name: forceCheckIn
        in: query
        description: If secret is checked out, then force a check in.
        required: false
        schema:
          type: boolean
      - name: id
        in: path
        description: Secret ID
        required: true
        schema:
          type: integer
          format: int32
      - name: secretPath
        in: query
        description: A full path including folder and secret name can be passed as a query string parameter when the secret ID is set to 0.  This will lookup the secret ID by path.
        required: false
        schema:
          type: string
      responses:
        '200':
          description: Object deletion result
          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/secrets/{id}/fields/{slug}/listdetails:
    get:
      tags:
      - Secrets
      summary: Get Secret List Field List Data
      description: Get the lists associated to a secret list data field
      operationId: SecretsService_GetListFieldListDefinitions
      parameters:
      - name: autoCheckIn
        in: query
        description: Automatically check in a secret after finding or updating.
        required: false
        schema:
          type: boolean
      - name: autoCheckout
        in: query
        description: Automatically check out secret before finding or updating.
        required: false
        schema:
          type: boolean
      - name: autoComment
        in: query
        description: Leave a comment when checking in or out.
        required: false
        schema:
          type: string
      - name: forceCheckIn
        in: query
        description: If secret is checked out, then force a check in.
        required: false
        schema:
          type: boolean
      - name: id
        in: path
        description: Secret ID
        required: 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
      - name: slug
        in: path
        description: The field slug name of the list field. This is the fieldSlugName property of the SecretField object. By default, it is the lower-case field name with all spaces replaced with dashes (-).
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Combined summary of all lists assigned to the secret field.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PagingOfCategorizedListSummary'
        '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:
      - Secrets
      summary: Update Secret List Field List Data
      description: Updates the lists associated to a secret list data field
      operationId: SecretsService_UpdateListFieldListDefinitions
      parameters:
      - name: autoCheckIn
        in: query
        description: Automatically check in a secret after finding or updating.
        required: false
        schema:
          type: boolean
      - name: autoCheckout
        in: query
        description: Automatically check out secret before finding or updating.
        required: false
        schema:
          type: boolean
      - name: autoComment
        in: query
        description: Leave a comment when checking in or out.
        required: false
        schema:
          type: string
      - name: forceCheckIn
        in: query
        description: If secret is checked out, then force a check in.
        required: false
        schema:
          type: boolean
      - name: id
        in: path
        description: Secret ID
        required: true
        schema:
          type: integer
          format: int32
      - name: slug
        in: path
        description: Secret field name
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SecretListFieldListArgs'
        description: Secret options
      responses:
        '200':
          description: Combined summary of all lists assigned to the secret field.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PagingOfCategorizedListSummary'
        '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:
      - Secrets
      summary: Delete Secret List Field List Data
      description: Deletes the lists associated to a secret list data field
      operationId: SecretsService_DeleteListFieldListDefinitions
      parameters:
      - name: autoCheckIn
        in: query
        description: Automatically check in a secret after finding or updating.
        required: false
        schema:
          type: boolean
      - name: autoCheckout
        in: query
        description: Automatically check out secret before finding or updating.
        required: false
        schema:
          type: boolean
      - name: autoComment
        in: query
        description: Leave a comment when checking in or out.
        required: false
        schema:
          type: string
      - name: forceCheckIn
        in: query
        description: If secret is checked out, then force a check in.
        required: false
        schema:
          type: boolean
      - name: id
        in: path
        description: Secret ID
        required: true
        schema:
          type: integer
          format: int32
      - name: listGuid
        in: query
        description: Secret options
        required: false
        schema:
          type: string
          format: uuid
      - name: slug
        in: path
        description: Secret field name
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Combined summary of all lists assigned to the secret field.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PagingOfCategorizedListSummary'
        '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/secrets:
    get:
      tags:
      - Secrets
      summary: Search Secrets
      description: Search, filter, sort, and page secrets
      operationId: SecretsService_SearchV2
      parameters:
      - name: filter.allowDoubleLocks
        in: query
        description: Whether to allow DoubleLocks as part of the search. True by default.
        required: false
        x-nullable: true
        schema:
          type: boolean
      - name: filter.doNotCalculateTotal
        in: query
        description: Whether to return the total number of secrets matching the filters. False by default. If false, the total can be retrieved separately by calling /v1/secrets/search-total with the same arguments used in the search.
        required: false
        x-nullable: true
        schema:
          type: boolean
      - name: filter.doubleLockId
        in: query
        description: Only include Secrets with this DoubleLock ID assigned in the search results.
        required: false
        x-nullable: true
        schema:
          type: integer
          format: int32
      - name: filter.extendedFields
        in: query
        description: An array of names of Secret Template fields to return.  Only exposed fields can be returned.  This parameter will be ignored if ExtFieldsCombined is sent.
        required: false
        explode: true
        schema:
          type: array
          items:
            type: string
      - name: filter.extendedTypeId
        in: query
        description: If not null, return only secrets matching the specified extended mapping type as defined on the secret’s template.
        required: false
        x-nullable: true
        schema:
          type: integer
          format: int32
      - name: filter.extFieldsCombined
        in: query
        description: A comma delimited list of all extended fields to return.  All fields must be marked as exposed for display.  When populated this value will be used instead of ExtendedFields[].  Combining the fields decreases the size of the GET URL to avoid the 2048 character length restriction in IIS.
        required: false
        schema:
          type: string
      - name: filter.folderId
        in: query
        description: If not null, returns only secrets within the specified folder.
        required: false
        x-nullable: true
        schema:
          type: integer
          format: int32
      - name: filter.hasLauncher
        in: query
        description: Whether to only return secrets with or without launchers. If null, returns secrets regardless of whether they have launchers.
        required: false
        x-nullable: true
        schema:
          type: boolean
      - name: filter.heartbeatStatus
        in: query
        description: If not null, returns only secrets with a certain heartbeat status.
        required: false
        x-nullable: true
        schema:
          type: string
      - name: filter.includeActive
        in: query
        description: Whether to include active secrets in results (when excluded equals true).
        required: false
        x-nullable: true
        schema:
          type: boolean
      - name: filter.includeInactive
        in: query
        description: Whether to include inactive secrets in results.
        required: false
        schema:
          type: boolean
      - name: filter.includeRestricted
        in: query
        description: Whether to include restricted secrets in results. Restricted secrets are secrets that are DoubleLocked, require approval, or require a comment to view.
        required: false
        schema:
          type: boolean
      - name: filter.includeSubFolders
        in: query
        description: Whether to include secrets in subfolders of the specified folder.
        required: false
        schema:
          type: boolean
      - name: filter.isExactMatch
        in: query
        description: Whether to do an exact match of the search text or a partial match. If an exact match, the entire secret name, field value, or list option in a list field must match the search text.
        required: false
        x-nullable: true
        schema:
          type: boolean
      - name: filter.onlyCheckedOutSecrets
        in: query
        description: Whether to only return secrets that are or are not checked out. If null, returns secrets regardless of whether they are checked out.
        required: false
        x-nullable: true
        schema:
          type: boolean
      - name: filter.onlyRPCEnabled
        in: query
        description: Whether to only include secrets whose template has Remote Password Changing enabled.
        required: false
        x-nullable: true
        schema:
          type: boolean
      - name: filter.onlySecretsCheckedOutByUser
        in: query
        description: Whether to only return secrets that are or are not checked out by the querying user. If null, returns secrets regardless of whether they are checked out.
        required: false
        x-nullable: true
        schema:
          type: boolean
      - name: filter.onlySharedWithMe
        in: query
        description: When true only Secrets where you are not the owner and the Secret was shared explicitly with your user id will be returned.
        required: false
        x-nullable: true
        schema:
          type: boolean
      - name: filter.passwordTypeIds
        in: query
        description: If not null, returns only secrets matching the specified password types.
        required: false
        explode: true
        schema:
          type: array
          items:
            type: integer
      - name: filter.permissionRequired
        in: query
        description: Specify whether to filter by List, View, Edit, or Owner permission. Default is List.
        required: false
        x-nullable: true
        schema:
          type: string
      - name: filter.scope
        in: query
        description: Specify whether to search All, Recent, or Favorites
        required: false
        x-nullable: true
        schema:
          type: string
      - name: filter.searchField
        in: query
        description: If set, restricts the search to only match secrets where the value of the field specified by name contains the search text.
        required: false
        schema:
          type: string
      - name: filter.searchFieldSlug
        in: query
        description: If set, restricts the search to only match secrets where the value of the field specified by the slug name contains the search text. This will override SearchField.
        required: false
        schema:
          type: string
      - name: filter.searchText
        in: query
        description: The text to match in the secret name, field value, or list field contents.
        required: false
        schema:
          type: string
      - name: filter.secretIds
        in: query
        description: If not null or empty, returns only secrets matching the specified secret ids.
        required: false
        explode: true
        schema:
          type: array
          items:
            type: integer
      - name: filter.secretTemplateIds
        in: query
        description: If not null or empty, returns only secrets matching the specified templates.
        required: false
        explode: true
        schema:
          type: array
          items:
            type: integer
      - name: filter.secretTemplateIdsCombined
        in: query
        description: A comma delimited list of all secret template IDs.  When populated this value will be used instead of SecretTemplateIds[].  Combining the fields decreases the size of the GET URL to avoid the 2048 character length restriction in IIS.
        required: false
        schema:
          type: string
      - name: filter.siteId
        in: query
        description: If not null, returns only secrets within a the specified site.
        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: Secret search result object
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PagingOfSecretSummary'
        '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/secrets/search-total:
    get:
      tags:
      - Secrets
      summary: Get Secret Search Total
      description: Gets the total number of secrets matching the secret search filter
      operationId: SecretsService_SearchTotalV2
      parameters:
      - name: filter.allowDoubleLocks
        in: query
        description: Whether to allow DoubleLocks as part of the search. True by default.
        required: false
        x-nullable: true
        schema:
          type: boolean
      - name: filter.doNotCalculateTotal
        in: query
        description: Whether to return the total number of secrets matching the filters. False by default. If false, the total can be retrieved separately by calling /v1/secrets/search-total with the same arguments used in the search.
        required: false
        x-nullable: true
        schema:
          type: boolean
      - name: filter.doubleLockId
        in: query
        description: Only include Secrets with this DoubleLock ID assigned in the search results.
        required: false
        x-nullable: true
        schema:
          type: integer
          format: int32
      - name: filter.extendedFields
        in: query
        description: An array of names of Secret Template fields to return.  Only exposed fields can be returned.  This parameter will be ignored if ExtFieldsCombined is sent.
        required: false
        explode: true
        schema:
          type: array
          items:
            type: string
      - name: filter.extendedTypeId
        in: query
        description: If not null, return only secrets matching the specified extended mapping type as defined on the secret’s template.
        required: false
        x-nullable: true
        schema:
          type: integer
          format: int32
      - name: filter.extFieldsCombined
        in: query
        description: A comma delimited list of all extended fields to return.  All fields must be marked as exposed for display.  When populated this value will be used instead of ExtendedFields[].  Combining the fields decreases the size of the GET URL to avoid the 2048 character length restriction in IIS.
        required: false
        schema:
          type: string
      - name: filter.folderId
        in: query
        description: If not null, returns only secrets within the specified folder.
        required: false
        x-nullable: true
        schema:
          type: integer
          format: int32
      - name: filter.hasLauncher
        in: query
        description: Whether to only return secrets with or without launchers. If null, returns secrets regardless of whether they have launchers.
        required: false
        x-nullable: true
        schema:
          type: boolean
      - name: filter.heartbeatStatus
        in: query
        description: If not null, returns only secrets with a certain heartbeat status.
        required: false
        x-nullable: true
        schema:
          type: string
      - name: filter.includeActive
        in: query
        description: Whether to include active secrets in results (when excluded equals true).
        required: false
        x-nullable: true
        schema:
          type: boolean
      - name: filter.includeInactive
        in: query
        description: Whether to include inactive secrets in results.
        required: false
        schema:
          type: boolean
      - name: filter.includeRestricted
        in: query
        description: Whether to include restricted secrets in results. Restricted secrets are secrets that are DoubleLocked, require approval, or require a comment to view.
        required: false
        schema:
          type: boolean
      - name: filter.includeSubFolders
        in: query
        description: Whether to include secrets in subfolders of the specified folder.
        required: false
        schema:
          type: boolean
      - name: filter.isExactMatch
        in: query
        description: Whether to do an exact match of the search text or a partial match. If an exact match, the entire secret name, field value, or list option in a list field must match the search text.
        required: false
        x-nullable: true
        schema:
          type: boolean
      - name: filter.onlyCheckedOutSecrets
        in: query
        description: Whether to only return secrets that are or are not checked out. If null, returns secrets regardless of whether they are checked out.
        required: false
        x-nullable: true
        schema:
          type: boolean
      - name: filter.onlyRPCEnabled
        in: query
        description: Whether to only include secrets whose template has Remote Password Changing enabled.
        required: false
        x-nullable: true
        schema:
          type: boolean
      - name: filter.onlySecretsCheckedOutByUser
        in: query
        description: Whether to only return secrets that are or are not checked out by the querying user. If null, returns secrets regardless of whether they are checked out.
        required: false
        x-nullable: true
        schema:
          type: boolean
      - name: filter.onlySharedWithMe
        in: query
        description: When true only Secrets where you are not the owner and the Secret was shared explicitly with your user id will be returned.
        required: false
        x-nullable: true
        schema:
          type: boolean
      - name: filter.passwordTypeIds
        in: query
        description: If not null, returns only secrets matching the specified password types.
        required: false
        explode: true
        schema:
          type: array
          items:
            type: integer
      - name: filter.permissionRequired
        in: query
        description: Specify whether to filter by List, View, Edit, or Owner permission. Default is List.
        required: false
        x-nullable: true
        schema:
          type: string
      - name: filter.scope
        in: query
        description: Specify whether to search All, Recent, or Favorites
        required: false
        x-nullable: true
        schema:
          type: string
      - name: filter.searchField
        in: query
        description: If set, restricts the search to only match secrets where the value of the field specified by name contains the search text.
        required: false
        schema:
          type: string
      - name: filter.searchFieldSlug
        in: query
        description: If set, restricts the search to only match secrets where the value of the field specified by the slug name contains the search text. This will override SearchField.
        required: false
        schema:
          type: string
      - name: filter.searchText
        in: query
        description: The text to match in the secret name, field value, or list field contents.
        required: false
        schema:
          type: string
      - name: filter.secretIds
        in: query
        description: If not null or empty, returns only secrets matching the specified secret ids.
        required: false
        explode: true
        schema:
          type: array
          items:
            type: integer
      - name: filter.secretTemplateIds
        in: query
        description: If not null or empty, returns only secrets matching the specified templates.
        required: false
        explode: true
        schema:
          type: array
          items:
            type: integer
      - name: filter.secretTemplateIdsCombined
        in: query
        description: A comma delimited list of all secret template IDs.  When populated this value will be used instead of SecretTemplateIds[].  Combining the fields decreases the size of the GET URL to avoid the 2048 character length restriction in IIS.
        required: false
        schema:
          type: string
      - name: filter.siteId
        in: query
        description: If not null, returns only secrets within a the specified site.
        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: Integer number of matching secrets
          content:
            application/json:
              schema:
                description: Int32
                type: integer
                format: int32
        '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/secrets/lookup:
    get:
      tags:
      - Secrets
      summary: Lookup Secrets with Search
      description: Search, filter, sort, and page secrets, returning only secret ID and name
      operationId: SecretsService_SearchSecretLookup
      parameters:
      - name: filter.allowDoubleLocks
        in: query
        description: Whether to allow DoubleLocks as part of the search. True by default.
        required: false
        x-nullable: true
        schema:
          type: boolean
      - name: filter.doNotCalculateTotal
        in: query
        description: Whether to return the total number of secrets matching the filters. False by default. If false, the total can be retrieved separately by calling /v1/secrets/search-total with the same arguments used in the search.
        required: false
        x-nullable: true
        schema:
          type: boolean
      - name: filter.doubleLockId
        in: query
        description: Only include Secrets with this DoubleLock ID assigned in the search results.
        required: false
        x-nullable: true
        schema:
          type: integer
          format: int32
      - name: filter.extendedFields
        in: query
        description: An array of names of Secret Template fields to return.  Only exposed fields can be returned.
        required: false
        explode: true
        schema:
          type: array
          items:
            type: string
      - name: filter.extendedTypeId
        in: query
        description: If not null, return only secrets matching the specified extended mapping type as defined on the secret’s template.
        required: false
        x-nullable: true
        schema:
          type: integer
          format: int32
      - name: filter.folderId
        in: query
        description: If not null, returns only secrets within the specified folder.
        required: false
        x-nullable: true
        schema:
          type: integer
          format: int32
      - name: filter.heartbeatStatus
        in: query
        description: If not null, returns only secrets with a certain heartbeat status.
        required: false
        x-nullable: true
        schema:
          type: string
      - name: filter.includeActive
        in: query
        description: Whether to include active secrets in results (when excluded equals true).
        required: false
        x-nullable: true
        schema:
          type: boolean
      - name: filter.includeInactive
        in: query
        description: Whether to include inactive secrets in results.
        required: false
        schema:
          type: boolean
      - name: filter.includeRestricted
        in: query
        description: Whether to include restricted secrets in results. Restricted secrets are secrets that are DoubleLocked, require approval, or require a comment to view.
        required: false
        schema:
          type: boolean
      - name: filter.includeSubFolders
        in: query
        description: Whether to include secrets in subfolders of the specified folder.
        required: false
        schema:
          type: boolean
      - name: filter.isExactMatch
        in: query
        description: Whether to do an exact match of the search text or a partial match. If an exact match, the entire secret name, field value, or list option in a list field must match the search text.
        required: false
        x-nullable: true
        schema:
          type: boolean
      - name: filter.onlyRPCEnabled
        in: query
        description: Whether to only include secrets whose template has Remote Password Changing enabled.
        required: false
        x-nullable: true
        schema:
          type: boolean
      - name: filter.onlySecretsCheckedOutByUser
        in: query
        description: Whether to only return secrets that are or are not checked out by the querying user. If null, returns secrets regardless of whether they are checked out.
        required: false
        x-nullable: true
        schema:
          type: boolean
      - name: filter.onlySharedWithMe
        in: query
        description: When true only Secrets where you are not the owner and the Secret was shared explicitly with your user id will be returned.
        required: false
        x-nullable: true
        schema:
          type: boolean
      - name: filter.passwordTypeIds
        in: query
        description: If not null, returns only secrets matching the specified password types.
        required: false
        explode: true
        schema:
          type: array
          items:
            type: integer
      - name: filter.permissionRequired
        in: query
        description: Specify whether to filter by List, View, Edit, or Owner permission. Default is List.
        required: false
        x-nullable: true
        schema:
          type: string
      - name: filter.scope
        in: query
        description: Specify whether to search All, Recent, or Favorites
        required: false
        x-nullable: true
        schema:
          type: string
      - name: filter.searchField
        in: query
        description: If set, restricts the search to only match secrets where the value of the field specified by name contains the search text.
        required: false
        schema:
          type: string
      - name: filter.searchFieldSlug
        in: query
        description: If set, restricts the search to only match secrets where the value of the field specified by the slug name contains the search text. This will override SearchField.
        required: false
        schema:
          type: string
      - name: filter.searchText
        in: query
        description: The text to match in the secret name, field value, or list field contents.
        required: false
        schema:
          type: string
      - name: filter.secretTemplateId
        in: query
        description: If not null, returns only secrets matching the specified template.
        required: false
        x-nullable: true
        schema:
          type: integer
          format: int32
      - name: filter.siteId
        in: query
        description: If not null, returns only secrets within a the specified site.
        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: Secret search result object
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PagingOfSecretLookup'
        '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/secrets/lookup/{id}:
    get:
      tags:
      - Secrets
      summary: Lookup Secret
      description: Look up secret by ID and return secret name and ID
      operationId: SecretsService_GetLookup
      parameters:
      - name: id
        in: path
        description: Secret ID
        required: true
        schema:
          type: integer
          format: int32
      - name: secretPath
        in: query
        description: A full path including folder and secret name can be passed as a query string parameter when the secret ID is set to 0.  This will lookup the secret ID by path.
        required: false
        schema:
          type: string
      responses:
        '200':
          description: Secret lookup result object
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SecretLookup'
        '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/secrets/stub:
    get:
      tags:
      - Secrets
      summary: Get Secret Stub
      description: Return the default values for a new secret
      operationId: SecretsService_Stub
      parameters:
      - name: folderId
        in: query
        description: Containing folder ID. May be null unless secrets are required to be in folders.
        required: false
        schema:
          type: integer
          format: int32
      - name: secretTemplateId
        in: query
        description: Secret template ID
        required: true
        schema:
          type: integer
          format: int32
      responses:
        '200':
          description: Secret object
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SecretModel'
        '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/secrets/{id}:
    get:
      tags:
      - Secrets
      summary: Get Secret
      description: Get a single secret by ID
      operationId: SecretsService_GetSecretV2
      parameters:
      - name: includeInactive
        in: query
        description: Whether to include inactive secrets in the results
        required: false
        schema:
          type: boolean
      - name: noAutoCheckout
        in: query
        description: Don't check out the secret if needed
        required: false
        schema:
          type: boolean
      - name: autoCheckIn
        in: query
        description: Automatically check in a secret after finding or updating.
        required: false
        schema:
          type: boolean
      - name: autoCheckout
        in: query
        description: Automatically check out secret before finding or updating.
        required: false
        schema:
          type: boolean
      - name: autoComment
        in: query
        description: Leave a comment when checking in or out.
        required: false
        schema:
          type: string
      - name: forceCheckIn
        in: query
        description: If secret is checked out, then force a check in.
        required: false
        schema:
          type: boolean
      - name: id
        in: path
        description: Secret ID
        required: true
        schema:
          type: integer
          format: int32
      - name: secretPath
        in: query
        description: A full path including folder and secret name can be passed as a query string parameter when the secret ID is set to 0.  This will lookup the secret ID by path.
        required: false
        schema:
          type: string
      responses:
        '200':
          description: Secret object
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SecretModelV2'
        '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/secrets/{id}/preview:
    get:
      tags:
      - Secrets
      summary: Get Secret Preview
      description: Get a preview of an unrestricted secret by ID. Restricted secrets will return an AccessDeniedException.
      operationId: SecretsService_GetSecretPreview
      parameters:
      - name: autoCheckIn
        in: query
        description: Automatically check in a secret after finding or updating.
        required: false
        schema:
          type: boolean
      - name: autoCheckout
        in: query
        description: Automatically check out secret before finding or updating.
        required: false
        schema:
          type: boolean
      - name: autoComment
        in: query
        description: Leave a comment when checking in or out.
        required: false
        schema:
          type: string
      - name: forceCheckIn
        in: query
        description: If secret is checked out, then force a check in.
        required: false
        schema:
          type: boolean
      - name: id
        in: path
        description: Secret ID
        required: true
        schema:
          type: integer
          format: int32
      - name: secretPath
        in: query
        description: A full path including folder and secret name can be passed as a query string parameter when the secret ID is set to 0.  This will lookup the secret ID by path.
        required: false
        schema:
          type: string
      responses:
        '200':
          description: Secret Preview object
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DashboardViewSecret'
        '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/secrets/{id}/summary:
    get:
      tags:
      - Secrets
      summary: Get Secret Summary
      description: Get the summary for a secret
      operationId: SecretsService_GetSummary
      parameters:
      - name: autoCheckIn
        in: query
        description: Automatically check in a secret after finding or updating.
        required: false
        schema:
          type: boolean
      - name: autoCheckout
        in: query
        description: Automatically check out secret before finding or updating.
        required: false
        schema:
          type: boolean
      - name: autoComment
        in: query
        description: Leave a comment when checking in or out.
        required: false
        schema:
          type: string
      - name: forceCheckIn
        in: query
        description: If secret is checked out, then force a check in.
        required: false
        schema:
          type: boolean
      - name: id
        in: path
        description: Secret ID
        required: true
        schema:
          type: integer
          format: int32
      - name: secretPath
        in: query
        description: A full path including folder and secret name can be passed as a query string parameter when the secret ID is set to 0.  This will lookup the secret ID by path.
        required: false
        schema:
          type: string
      responses:
        '200':
          description: Secret summary object
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SecretSummary'
        '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/secrets/{id}/fields/{slug}:
    get:
      tags:
      - Secrets
      summary: Get Secret Field
      description: Get a secret data field
      operationId: SecretsService_GetField
      parameters:
      - name: includeInactive
        in: query
        description: Whether to include inactive secrets in the results
        required: false
        schema:
          type: boolean
      - name: noAutoCheckout
        in: query
        description: Don't check out the secret if needed
        required: false
        schema:
          type: boolean
      - name: autoCheckIn
        in: query
        description: Automatically check in a secret after finding or updating.
        required: false
        schema:
          type: boolean
      - name: autoCheckout
        in: query
        description: Automatically check out secret before finding or updating.
        required: false
        schema:
          type: boolean
      - name: autoComment
        in: query
        description: Leave a comment when checking in or out.
        required: false
        schema:
          type: string
      - name: forceCheckIn
        in: query
        description: If secret is checked out, then force a check in.
        required: false
        schema:
          type: boolean
      - name: id
        in: path
        description: Secret ID
        required: true
        schema:
          type: integer
          format: int32
      - name: secretPath
        in: query
        description: A full path including folder and secret name can be passed as a query string parameter when the secret ID is set to 0.  This will lookup the secret ID by path.
        required: false
        schema:
          type: string
      - name: slug
        in: path
        description: Secret field name
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Secret field value. If the field is a file attachment, the content type will be `application/octet-stream` and the response body will be the file contents.
          content:
            application/json:
              schema:
                description: String
                type: string
            application/octet-stream:
              schema:
                description: String
                type: string
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BadRequestResponse'
            application/octet-stream:
              schema:
                $ref: '#/components/schemas/BadRequestResponse'
        '403':
          description: Authentication failed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AuthenticationFailedResponse'
            application/octet-stream:
              schema:
                $ref: '#/components/schemas/AuthenticationFailedResponse'
        '500':
          description: Internal server error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServerErrorResponse'
            application/octet-stream:
              schema:
                $ref: '#/components/schemas/InternalServerErrorResponse'
      deprecated: false
    put:
      tags:
      - Secrets
      summary: Update Secret Field
      description: Update a secret data field
      operationId: SecretsService_PutField
      parameters:
      - name: autoCheckIn
        in: query
        description: Automatically check in a secret after finding or updating.
        required: false
        schema:
          type: boolean
      - name: autoCheckout
        in: query
        description: Automatically check out secret before finding or updating.
        required: false
        schema:
          type: boolean
      - name: autoComment
        in: query
        description: Leave a comment when checking in or out.
        required: false
        schema:
          type: string
      - name: forceCheckIn
        in: query
        description: If secret is checked out, then force a check in.
        required: false
        schema:
          type: boolean
      - name: id
        in: path
        description: Secret ID
        required: true
        schema:
          type: integer
          format: int32
      - name: secretPath
        in: query
        description: A full path including folder and secret name can be passed as a query string parameter when the secret ID is set to 0.  This will lookup the secret ID by path.
        required: false
        schema:
          type: string
      - name: slug
        in: path
        description: Secret field name
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SecretItemUpdateArgs'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/SecretItemUpdateArgs'
        description: Secret options
      responses:
        '200':
          description: The updated value, or 'true' if the field is a file attachment
          content:
            application/json:
              schema:
                description: String
                type: string
        '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/secrets/{id}/fields/{slug}/list:
    get:
      tags:
      - Secrets
      summary: Get Secret List Field
      description: Get the items associated to a secret list data field
      operationId: SecretsService_GetListField
      parameters:
      - name: autoCheckIn
        in: query
        description: Automatically check in a secret after finding or updating.
        required: false
        schema:
          type: boolean
      - name: autoCheckout
        in: query
        description: Automatically check out secret before finding or updating.
        required: false
        schema:
          type: boolean
      - name: autoComment
        in: query
        description: Leave a comment when checking in or out.
        required: false
        schema:
          type: string
      - name: forceCheckIn
        in: query
        description: If secret is checked out, then force a check in.
        required: false
        schema:
          type: boolean
      - name: id
        in: path
        description: Secret ID
        required: true
        schema:
          type: integer
          format: int32
      - name: slug
        in: path
        description: Secret field name
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Combined contents of all lists assigned to the secret field.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CategorizedListItemValueResult'
        '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/secrets/favorite:
    get:
      tags:
      - Secrets
      summary: List a User's Favorite Secrets
      description: Returns a list of secrets which the user has favorited.
      operationId: SecretsService_GetFavorites
      responses:
        '200':
          description: Identifying information for each secret favorited
          content:
            application/json:
              schema:
                description: Identifying information for each secret favorited
                items:
                  $ref: '#/components/schemas/WidgetSecretModel'
                type: array
        '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/secrets/{secretId}/transition-history:
    get:
      tags:
      - Secrets
      summary: Get secret password transition history
      description: Returns the secret password that will be used next during an actual rotation.
      operationId: SecretsService_GetSecretTransitionHistory
      parameters:
      - 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
      - name: secretId
        in: path
        description: secretId
        required: true
        schema:
          type: integer
          format: int32
      responses:
        '200':
          description: List of transition history passwords
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PagingOfSecretTransitionHistorySummaryModel'
        '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/secrets/{id}/audits:
    get:
      tags:
      - Secrets
      summary: Get Secret Audits by Filter
      description: Get audits for a particular Secret for the given filter.
      operationId: SecretsService_GetSecretAudits
      parameters:
      - name: id
        in: path
        description: id
        required: true
        schema:
          type: integer
          format: int32
      - name: isExporting
        in: query
        description: isExporting
        required: false
        schema:
          type: boolean
      - name: filter.includePasswordChangeLog
        in: query
        description: Whether or not to include password changes in data
        required: false
        schema:
          type: boolean
      - 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
      - name: secretPath
        in: query
        description: A full path including folder and secret name can be passed as a query string parameter when the secret ID is set to 0.  This will lookup the secret ID by path.
        required: false
        schema:
          type: string
      responses:
        '200':
          description: Secret Audit Model
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PagingOfSecretAuditModel'
        '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/secrets/{id}/state:
    get:
      tags:
      - Secrets
      summary: Get Secret State
      description: Retrieve state about a Secret such as whether it requires approval, doublelock, checkout, or other restricted actions to be performed before calling the get the secret.
      operationId: SecretsService_GetSecretState
      parameters:
      - name: autoCheckIn
        in: query
        description: Automatically check in a secret after finding or updating.
        required: false
        schema:
          type: boolean
      - name: autoCheckout
        in: query
        description: Automatically check out secret before finding or updating.
        required: false
        schema:
          type: boolean
      - name: autoComment
        in: query
        description: Leave a comment when checking in or out.
        required: false
        schema:
          type: string
      - name: forceCheckIn
        in: query
        description: If secret is checked out, then force a check in.
        required: false
        schema:
          type: boolean
      - name: id
        in: path
        description: id
        required: true
        schema:
          type: integer
          format: int32
      - name: secretPath
        in: query
        description: A full path including folder and secret name can be passed as a query string parameter when the secret ID is set to 0.  This will lookup the secret ID by path.
        required: false
        schema:
          type: string
      responses:
        '200':
          description: Secret Detail State View Model
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SecretDetailStateViewModel'
        '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/secrets/secret-detail/{id}/general/{isEditMode?}/{loadReadOnlyFlags?}:
    get:
      tags:
      - Secrets
      summary: Get Secret Detail General
      description: Retrieve details about a secret.
      operationId: SecretsService_GetGeneral
      parameters:
      - name: id
        in: path
        description: id
        required: true
        schema:
          type: integer
          format: int32
      - name: isEditMode
        in: query
        description: isEditMode
        required: false
        x-nullable: true
        schema:
          type: boolean
      - name: loadReadOnlyFlags
        in: query
        description: loadReadOnlyFlags
        required: false
        x-nullable: true
        schema:
          type: boolean
      - name: secretPath
        in: query
        description: A full path including folder and secret name can be passed as a query string parameter when the secret ID is set to 0.  This will lookup the secret ID by path.
        required: false
        schema:
          type: string
      responses:
        '200':
          description: Secret Detail State View Model
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SecretDetailGeneralModel'
        '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/secrets/{id}/settings:
    get:
      tags:
      - Secrets
      summary: Get Secret Settings
      description: Get Secret Settings
      operationId: SecretsService_GetSecretSettings
      parameters:
      - name: autoCheckIn
        in: query
        description: Automatically check in a secret after finding or updating.
        required: false
        schema:
          type: boolean
      - name: autoCheckout
        in: query
        description: Automatically check out secret before finding or updating.
        required: false
        schema:
          type: boolean
      - name: autoComment
        in: query
        description: Leave a comment when checking in or out.
        required: false
        schema:
          type: string
      - name: forceCheckIn
        in: query
        description: If secret is checked out, then force a check in.
        required: false
        schema:
          type: boolean
      - name: id
        in: path
        description: id
        required: true
        schema:
          type: integer
          format: int32
      - name: secretPath
        in: query
        description: A full path including folder and secret name can be passed as a query string parameter when the secret ID is set to 0.  This will lookup the secret ID by path.
        required: false
        schema:
          type: string
      responses:
        '200':
          description: Secret Settings
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SecretDetailSettingsModel'
        '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/secrets/launcher-sessions:
    get:
      tags:
      - Secrets
      summary: Get Secret Launcher Sessions By Id
      description: Get secret launcher sessions
      operationId: SecretsService_GetActiveSecretSessions
      parameters:
      - name: filter.secretId
        in: query
        description: The Id of the associated Secret.
        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: Secret Launcher Sessions
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PagingOfSecretLauncherSessionSummary'
        '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:
      - Secrets
      summary: Update Secret Launcher Sessions
      description: Update or Terminate Secret Launcher Sessions
      operationId: SecretsService_UpdateSecretSession
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SecretLauncherSessionArgs'
        description: args
      responses:
        '200':
          description: Result of the update Secret Launcher Session Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SecretLauncherSessionActionResult'
        '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/secrets/{id}/ssh-restricted-commands:
    get:
      tags:
      - Secrets
      summary: Get SSH Command Restrictions on a Secret
      description: Gets the SSH command restrictions for a Secret
      operationId: SecretsService_GetSshRestrictedCommands
      parameters:
      - name: autoCheckIn
        in: query
        description: Automatically check in a secret after finding or updating.
        required: false
        schema:
          type: boolean
      - name: autoCheckout
        in: query
        description: Automatically check out secret before finding or updating.
        required: false
        schema:
          type: boolean
      - name: autoComment
        in: query
        description: Leave a comment when checking in or out.
        required: false
        schema:
          type: string
      - name: forceCheckIn
        in: query
        description: If secret is checked out, then force a check in.
        required: false
        schema:
          type: boolean
      - name: id
        in: path
        description: id
        required: true
        schema:
          type: integer
          format: int32
      responses:
        '200':
          description: List of restricted commands
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SecretDetailRestrictedSshCommandViewModel'
        '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/secrets/export/job/{jobId}:
    get:
      tags:
      - Secrets
      summary: Export Secrets Job Status
      description: Exports secrets Job Status
      operationId: SecretsService_RetrieveSecretJobStatus
      parameters:
      - name: jobId
        in: path
        description: jobId
        required: true
        schema:
          type: string
          format: uuid
      responses:
        '200':
          description: Exported Secrets Job Status
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ExportSecretsJobResultModel'
        '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/secrets/export/{jobId}/details:
    get:
      tags:
      - Secrets
      summary: Export Secrets Job Details
      description: Exports Secret Job Details
      operationId: SecretsService_RetrieveExportSecretsDetails
      parameters:
      - name: jobId
        in: path
        description: jobId
        required: true
        schema:
          type: string
          format: uuid
      responses:
        '200':
          description: Exported Secrets Job Details
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ExportSecretsExportJobDetails'
        '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/secrets/export:
    get:
      tags:
      - Secrets
      summary: Export Bulk Export Secrets
      description: Exports Secrets from Storage
      operationId: SecretsService_RetrieveSecretExport
      parameters:
      - name: jobId
        in: query
        description: jobId
        required: false
        schema:
          type: string
          format: uuid
      responses:
        '200':
          description: Export Bulk Export Secrets
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ExportSecretsResultModelV2'
        '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/secrets/{id}/general:
    patch:
      tags:
      - Secrets
      summary: Update Secret General Information
      description: Update Secret General Information
      operationId: SecretsService_UpdateGeneral
      parameters:
      - name: autoCheckIn
        in: query
        description: Automatically check in a secret after finding or updating.
        required: false
        schema:
          type: boolean
      - name: autoCheckout
        in: query
        description: Automatically check out secret before finding or updating.
        required: false
        schema:
          type: boolean
      - name: autoComment
        in: query
        description: Leave a comment when checking in or out.
        required: false
        schema:
          type: string
      - name: forceCheckIn
        in: query
        description: If secret is checked out, then force a check in.
        required: false
        schema:
          type: boolean
      - name: id
        in: path
        description: id
        required: true
        schema:
          type: integer
          format: int32
      - name: secretPath
        in: query
        description: A full path including folder and secret name can be passed as a query string parameter when the secret ID is set to 0.  This will lookup the secret ID by path.
        required: false
        schema:
          type: string
      requestBody:
        $ref: '#/components/requestBodies/SecretDetailUpdateGeneralArgs'
      responses:
        '200':
          description: Secret General Information
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SecretDetailGeneralViewModel'
        '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/secrets/{id}/email:
    patch:
      tags:
      - Secrets
      summary: Update User Secret Email Settings
      description: Update User Secret Email Settings
      operationId: SecretsService_UpdateEmail
      parameters:
      - name: autoCheckIn
        in: query
        description: Automatically check in a secret after finding or updating.
        required: false
        schema:
          type: boolean
      - name: autoCheckout
        in: query
        description: Automatically check out secret before finding or updating.
        required: false
        schema:
          type: boolean
      - name: autoComment
        in: query
        description: Leave a comment when checking in or out.
        required: false
        schema:
          type: string
      - name: forceCheckIn
        in: query
        description: If secret is checked out, then force a check in.
        required: false
        schema:
          type: boolean
      - name: id
        in: path
        description: id
        required: true
        schema:
          type: integer
          format: int32
      - name: secretPath
        in: query
        description: A full path including folder and secret name can be passed as a query string parameter when the secret ID is set to 0.  This will lookup the secret ID by path.
        required: false
        schema:
          type: string
      requestBody:
        $ref: '#/components/requestBodies/SecretDetailUpdateEmailArgs'
      responses:
        '200':
          description: SecretDetailSettingsViewModel
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SecretDetailSettingsModel'
        '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/secrets/{id}/security-general:
    patch:
      tags:
      - Secrets
      summary: Update Secret Security General Options
      description: Update Secret Security General Options
      operationId: SecretsService_UpdateSecurity
      parameters:
      - name: autoCheckIn
        in: query
        description: Automatically check in a secret after finding or updating.
        required: false
        schema:
          type: boolean
      - name: autoCheckout
        in: query
        description: Automatically check out secret before finding or updating.
        required: false
        schema:
          type: boolean
      - name: autoComment
        in: query
        description: Leave a comment when checking in or out.
        required: false
        schema:
          type: string
      - name: forceCheckIn
        in: query
        description: If secret is checked out, then force a check in.
        required: false
        schema:
          type: boolean
      - name: id
        in: path
        description: id
        required: true
        schema:
          type: integer
          format: int32
      - name: secretPath
        in: query
        description: A full path including folder and secret name can be passed as a query string parameter when the secret ID is set to 0.  This will lookup the secret ID by path.
        required: false
        schema:
          type: string
      requestBody:
        $ref: '#/components/requestBodies/SecretDetailUpdateSecurityGeneralArgs'
      responses:
        '200':
          description: SecretDetailSecurityViewModel
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SecretDetailSecurityViewModel'
        '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/secrets/{id}/general:
    patch:
      tags:
      - Secrets
      summary: Update Secret General Information
      description: Update Secret General Information
      operationId: SecretsService_UpdateGeneralV2
      parameters:
      - name: autoCheckIn
        in: query
        description: Automatically check in a secret after finding or updating.
        required: false
        schema:
          type: boolean
      - name: autoCheckout
        in: query
        description: Automatically check out secret before finding or updating.
        required: false
        schema:
          type: boolean
      - name: autoComment
        in: query
        description: Leave a comment when checking in or out.
        required: false
        schema:
          type: string
      - name: forceCheckIn
        in: query
        description: If secret is checked out, then force a check in.
        required: false
        schema:
          type: boolean
      - name: id
        in: path
        description: id
        required: true
        schema:
          type: integer
          format: int32
      - name: secretPath
        in: query
        description: A full path including folder and secret name can be passed as a query string parameter when the secret ID is set to 0.  This will lookup the secret ID by path.
        required: false
        schema:
          type: string
      requestBody:
        $ref: '#/components/requestBodies/SecretDetailUpdateGeneralArgs'
      responses:
        '200':
          description: Secret General Information
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SecretDetailGeneralModel'
        '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/secrets/{id}/email:
    patch:
      tags:
      - Secrets
      summary: Update User Secret Email Settings
      description: Update User Secret Email Settings
      operationId: SecretsService_UpdateEmailV2
      parameters:
      - name: autoCheckIn
        in: query
        description: Automatically check in a secret after finding or updating.
        required: false
        schema:
          type: boolean
      - name: autoCheckout
        in: query
        description: Automatically check out secret before finding or updating.
        required: false
        schema:
          type: boolean
      - name: autoComment
        in: query
        description: Leave a comment when checking in or out.
        required: false
        schema:
          type: string
      - name: forceCheckIn
        in: query
        description: If secret is checked out, then force a check in.
        required: false
        schema:
          type: boolean
      - name: id
        in: path
        description: id
        required: true
        schema:
          type: integer
          format: int32
      - name: secretPath
        in: query
        description: A full path including folder and secret name can be passed as a query string parameter when the secret ID is set to 0.  This will lookup the secret ID by path.
        required: false
        schema:
          type: string
      requestBody:
        $ref: '#/components/requestBodies/SecretDetailUpdateEmailArgs'
      responses:
        '200':
          description: SecretDetailSettingsViewModel
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SecretDetailSettingsModel'
        '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
  /v3/secrets/{id}/security-checkout:
    patch:
      tags:
      - Secrets
      summary: Update Secret Security Checkout Options
      description: Update Secret Security Checkout Options
      operationId: SecretsService_UpdateSecurityCheckoutV3
      parameters:
      - name: autoCheckIn
        in: query
        description: Automatically check in a secret after finding or updating.
        required: false
        schema:
          type: boolean
      - name: autoCheckout
        in: query
        description: Automatically check out secret before finding or updating.
        required: false
        schema:
          type: boolean
      - name: autoComment
        in: query
        description: Leave a comment when checking in or out.
        required: false
        schema:
          type: string
      - name: forceCheckIn
        in: query
        description: If secret is checked out, then force a check in.
        required: false
        schema:
          type: boolean
      - name: id
        in: path
        description: id
        required: true
        schema:
          type: integer
          format: int32
      - name: secretPath
        in: query
        description: A full path including folder and secret name can be passed as a query string parameter when the secret ID is set to 0.  This will lookup the secret ID by path.
        required: false
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SecretDetailUpdateSecurityCheckoutArgs'
        description: args
      responses:
        '200':
          description: A model with the updated security options if available and a success code
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SecretSecurityUpdateResponse'
        '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/secrets/{id}/security-multifactor-authentication:
    patch:
      tags:
      - Secrets
      summary: Update Secret Security Multifactor Authentication Options
      description: Update Secret Security Multifactor Authentication Options
      operationId: SecretsService_UpdateSecurityMultifactorAuthentication
      parameters:
      - name: autoCheckIn
        in: query
        description: Automatically check in a secret after finding or updating.
        required: false
        schema:
          type: boolean
      - name: autoCheckout
        in: query
        description: Automatically check out secret before finding or updating.
        required: false
        schema:
          type: boolean
      - name: autoComment
        in: query
        description: Leave a comment when checking in or out.
        required: false
        schema:
          type: string
      - name: forceCheckIn
        in: query
        description: If secret is checked out, then force a check in.
        required: false
        schema:
          type: boolean
      - name: id
        in: path
        description: id
        required: true
        schema:
          type: integer
          format: int32
      - name: secretPath
        in: query
        description: A full path including folder and secret name can be passed as a query string parameter when the secret ID is set to 0.  This will lookup the secret ID by path.
        required: false
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SecretDetailUpdateSecurityMultifactorArgs'
        description: args
      responses:
        '200':
          description: SecretDetailSecurityViewModel
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SecretDetailSecurityModel'
        '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/secrets/{id}/security-general:
    patch:
      tags:
      - Secrets
      summary: Update Secret Security General Options
      description: Update Secret Security General Options
      operationId: SecretsService_UpdateSecurityV2
      parameters:
      - name: autoCheckIn
        in: query
        description: Automatically check in a secret after finding or updating.
        required: false
        schema:
          type: boolean
      - name: autoCheckout
        in: query
        description: Automatically check out secret before finding or updating.
        required: false
        schema:
          type: boolean
      - name: autoComment
        in: query
        description: Leave a comment when checking in or out.
        required: false
        schema:
          type: string
      - name: forceCheckIn
        in: query
        description: If secret is checked out, then force a check in.
        required: false
        schema:
          type: boolean
      - name: id
        in: path
        description: id
        required: true
        schema:
          type: integer
          format: int32
      - name: secretPath
        in: query
        description: A full path including folder and secret name can be passed as a query string parameter when the secret ID is set to 0.  This will lookup the secret ID by path.
        required: false
        schema:
          type: string
      requestBody:
        $ref: '#/components/requestBodies/SecretDetailUpdateSecurityGeneralArgs'
      responses:
        '200':
          description: SecretDetailSecurityViewModel
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SecretDetailSecurityModel'
        '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/secrets/extended-search-details:
    post:
      tags:
      - Secrets
      summary: Secret Search Extended Details
      description: Pass an array of secret IDs, presumably the results of a secret search and get extended details such as has launchers or is favorite.
      operationId: SecretsService_GetSecretExtendedSearchDetails
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SecretSearchExtendedArgs'
        description: args
      responses:
        '200':
          description: Secret search extended details
          content:
            application/json:
              schema:
                description: Secret search extended details
                items:
                  $ref: '#/components/schemas/SecretSearchExtendedSummary'
                type: array
        '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/secrets/{id}/restricted:
    post:
      tags:
      - Secrets
      summary: Get Restricted Secret
      description: Get a restricted secret
      operationId: SecretsService_GetRestricted
      parameters:
      - name: autoCheckIn
        in: query
        description: Automatically check in a secret after finding or updating.
        required: false
        schema:
          type: boolean
      - name: autoCheckout
        in: query
        description: Automatically check out secret before finding or updating.
        required: false
        schema:
          type: boolean
      - name: autoComment
        in: query
        description: Leave a comment when checking in or out.
        required: false
        schema:
          type: string
      - name: forceCheckIn
        in: query
        description: If secret is checked out, then force a check in.
        required: false
        schema:
          type: boolean
      - name: id
        in: path
        description: Secret ID
        required: true
        schema:
          type: integer
          format: int32
      - name: secretPath
        in: query
        description: A full path including folder and secret name can be passed as a query string parameter when the secret ID is set to 0.  This will lookup the secret ID by path.
        required: false
        schema:
          type: string
      requestBody:
        $ref: '#/components/requestBodies/SecretRestrictedArgs'
      responses:
        '200':
          description: Secret object
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SecretModel'
        '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/secrets:
    post:
      tags:
      - Secrets
      summary: Create Secret
      description: Create a new secret
      operationId: SecretsService_CreateSecret
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SecretCreateArgs'
        description: Secret creation options
      responses:
        '200':
          description: Secret object
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SecretModel'
        '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/secrets/{id}/heartbeat:
    post:
      tags:
      - Secrets
      summary: Run Secret Heartbeat
      description: Check if secret is still valid
      operationId: SecretsService_RunHeartBeat
      parameters:
      - name: autoCheckIn
        in: query
        description: Automatically check in a secret after finding or updating.
        required: false
        schema:
          type: boolean
      - name: autoCheckout
        in: query
        description: Automatically check out secret before finding or updating.
        required: false
        schema:
          type: boolean
      - name: autoComment
        in: query
        description: Leave a comment when checking in or out.
        required: false
        schema:
          type: string
      - name: forceCheckIn
        in: query
        description: If secret is checked out, then force a check in.
        required: false
        schema:
          type: boolean
      - name: id
        in: path
        description: Secret ID
        required: true
        schema:
          type: integer
          format: int32
      - name: secretPath
        in: query
        description: A full path including folder and secret name can be passed as a query string parameter when the secret ID is set to 0.  This will lookup the secret ID by path.
        required: false
        schema:
          type: string
      responses:
        '200':
          description: Secret summary object
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SecretSummary'
        '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/secrets/{id}/expire:
    post:
      tags:
      - Secrets
      summary: Expire Secret
      description: Expire a secret
      operationId: SecretsService_Expire
      parameters:
      - name: autoCheckIn
        in: query
        description: Automatically check in a secret after finding or updating.
        required: false
        schema:
          type: boolean
      - name: autoCheckout
        in: query
        description: Automatically check out secret before finding or updating.
        required: false
        schema:
          type: boolean
      - name: autoComment
        in: query
        description: Leave a comment when checking in or out.
        required: false
        schema:
          type: string
      - name: forceCheckIn
        in: query
        description: If secret is checked out, then force a check in.
        required: false
        schema:
          type: boolean
      - name: id
        in: path
        description: Secret ID
        required: true
        schema:
          type: integer
          format: int32
      - name: secretPath
        in: query
        description: A full path including folder and secret name can be passed as a query string parameter when the secret ID is set to 0.  This will lookup the secret ID by path.
        required: false
        schema:
          type: string
      requestBody:
        $ref: '#/components/requestBodies/SecretRestrictedArgs'
      responses:
        '200':
          description: Secret summary object
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SecretSummary'
        '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/secrets/{id}/change-password:
    post:
      tags:
      - Secrets
      summary: Change Secret Password
      description: Change a secret's password
      operationId: SecretsService_ChangePassword
      parameters:
      - name: autoCheckIn
        in: query
        description: Automatically check in a secret after finding or updating.
        required: false
        schema:
          type: boolean
      - name: autoCheckout
        in: query
        description: Automatically check out secret before finding or updating.
        required: false
        schema:
          type: boolean
      - name: autoComment
        in: query
        description: Leave a comment when checking in or out.
        required: false
        schema:
          type: string
      - name: forceCheckIn
        in: query
        description: If secret is checked out, then force a check in.
        required: false
        schema:
          type: boolean
      - name: id
        in: path
        description: Secret ID
        required: true
        schema:
          type: integer
          format: int32
      - name: secretPath
        in: query
        description: A full path including folder and secret name can be passed as a query string parameter when the secret ID is set to 0.  This will lookup the secret ID by path.
        required: false
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SecretChangePasswordArgs'
        description: Secret options
      responses:
        '200':
          description: Secret summary object
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SecretSummary'
        '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/secrets/{id}/check-in:
    post:
      tags:
      - Secrets
      summary: Check In Secret
      description: Check in a secret. Checking a secret ends exclusive access to the secret and allows other users to check-out and view or edit it.
      operationId: SecretsService_CheckIn
      parameters:
      - name: id
        in: path
        description: Secret ID
        required: true
        schema:
          type: integer
          format: int32
      - name: secretPath
        in: query
        description: A full path including folder and secret name can be passed as a query string parameter when the secret ID is set to 0.  This will lookup the secret ID by path.
        required: false
        schema:
          type: string
      requestBody:
        $ref: '#/components/requestBodies/SecretRestrictedArgs'
      responses:
        '200':
          description: Secret summary object
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SecretSummary'
        '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/secrets/{id}/check-out:
    post:
      tags:
      - Secrets
      summary: Check Out Secret
      description: Check Out a secret
      operationId: SecretsService_CheckOut
      parameters:
      - name: id
        in: path
        description: Secret ID
        required: true
        schema:
          type: integer
          format: int32
      - name: secretPath
        in: query
        description: A full path including folder and secret name can be passed as a query string parameter when the secret ID is set to 0.  This will lookup the secret ID by path.
        required: false
        schema:
          type: string
      responses:
        '200':
          description: Secret Response Code Model object
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SecretResponseCodeModel'
        '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/secrets/{id}/extend-check-out:
    post:
      tags:
      - Secrets
      summary: Extend Check Out
      description: Extend remaining check out time.
      operationId: SecretsService_ExtendCheckOut
      parameters:
      - name: id
        in: path
        description: id
        required: true
        schema:
          type: integer
          format: int32
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SecretCheckOutExtensionArgs'
        description: args
      responses:
        '200':
          description: Secret Check Out Extension Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SecretCheckOutExtensionResponseModel'
        '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/secrets/{id}/restricted/fields/{slug}:
    post:
      tags:
      - Secrets
      summary: Get Restricted Secret Field
      description: Get a restricted secret data field
      operationId: SecretsService_RestrictedField
      parameters:
      - name: autoCheckIn
        in: query
        description: Automatically check in a secret after finding or updating.
        required: false
        schema:
          type: boolean
      - name: autoCheckout
        in: query
        description: Automatically check out secret before finding or updating.
        required: false
        schema:
          type: boolean
      - name: autoComment
        in: query
        description: Leave a comment when checking in or out.
        required: false
        schema:
          type: string
      - name: forceCheckIn
        in: query
        description: If secret is checked out, then force a check in.
        required: false
        schema:
          type: boolean
      - name: id
        in: path
        description: Secret ID
        required: true
        schema:
          type: integer
          format: int32
      - name: secretPath
        in: query
        description: A full path including folder and secret name can be passed as a query string parameter when the secret ID is set to 0.  This will lookup the secret ID by path.
        required: false
        schema:
          type: string
      - name: slug
        in: path
        description: Secret field name
        required: true
        schema:
          type: string
      requestBody:
        $ref: '#/components/requestBodies/SecretRestrictedArgs'
      responses:
        '200':
          description: Secret field value. If the field is a file attachment, the content type will be `application/octet-stream` and the response body will be the file contents.
          content:
            application/json:
              schema:
                description: String
                type: string
            application/octet-stream:
              schema:
                description: String
                type: string
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BadRequestResponse'
            application/octet-stream:
              schema:
                $ref: '#/components/schemas/BadRequestResponse'
        '403':
          description: Authentication failed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AuthenticationFailedResponse'
            application/octet-stream:
              schema:
                $ref: '#/components/schemas/AuthenticationFailedResponse'
        '500':
          description: Internal server error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServerErrorResponse'
            application/octet-stream:
              schema:
                $ref: '#/components/schemas/InternalServerErrorResponse'
      deprecated: false
  /v1/secrets/rdpproxy:
    post:
      tags:
      - Secrets
      summary: Get RDP Proxy Information
      description: Get RDP Proxy Information
      operationId: SecretsService_GetSecretRdpProxyInfo
      parameters:
      - name: autoCheckIn
        in: query
        description: Automatically check in a secret after finding or updating.
        required: false
        schema:
          type: boolean
      - name: autoCheckout
        in: query
        description: Automatically check out secret before finding or updating.
        required: false
        schema:
          type: boolean
      - name: autoComment
        in: query
        description: Leave a comment when checking in or out.
        required: false
        schema:
          type: string
      - name: forceCheckIn
        in: query
        description: If secret is checked out, then force a check in.
        required: false
        schema:
          type: boolean
      requestBody:
        $ref: '#/components/requestBodies/SecretProxyArgs'
      responses:
        '200':
          description: RDP Proxy Information
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SecretRdpProxyModel'
        '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/secrets/sshproxy:
    post:
      tags:
      - Secrets
      summary: Get SSH Proxy Information
      description: Get SSH Proxy Information
      operationId: SecretsService_GetSecretSshProxyInfo
      parameters:
      - name: autoCheckIn
        in: query
        description: Automatically check in a secret after finding or updating.
        required: false
        schema:
          type: boolean
      - name: autoCheckout
        in: query
        description: Automatically check out secret before finding or updating.
        required: false
        schema:
          type: boolean
      - name: autoComment
        in: query
        description: Leave a comment when checking in or out.
        required: false
        schema:
          type: string
      - name: forceCheckIn
        in: query
        description: If secret is checked out, then force a check in.
        required: false
        schema:
          type: boolean
      requestBody:
        $ref: '#/components/requestBodies/SecretProxyArgs'
      responses:
        '200':
          description: SSH Proxy Information
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SecretSshProxyModel'
        '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/secrets/sshterminal:
    post:
      tags:
      - Secrets
      summary: Get SSH Terminal Details
      description: Get SSH Terminal Details
      operationId: SecretsService_GetSecretSshTerminalDetails
      parameters:
      - name: autoCheckIn
        in: query
        description: Automatically check in a secret after finding or updating.
        required: false
        schema:
          type: boolean
      - name: autoCheckout
        in: query
        description: Automatically check out secret before finding or updating.
        required: false
        schema:
          type: boolean
      - name: autoComment
        in: query
        description: Leave a comment when checking in or out.
        required: false
        schema:
          type: string
      - name: forceCheckIn
        in: query
        description: If secret is checked out, then force a check in.
        required: false
        schema:
          type: boolean
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SecretSshTerminalArgs'
        description: args
      responses:
        '200':
          description: SSH Terminal Details
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SecretSshTerminalModel'
        '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/secrets/{secretId}/favorite:
    post:
      tags:
      - Secrets
      summary: Favorite a Secret
      description: Used to favorite or unfavorite an individual Secret
      operationId: SecretsService_Favorite
      parameters:
      - name: secretId
        in: path
        description: The secret to favorite or unfavorite.
        required: true
        schema:
          type: integer
          format: int32
      - name: secretPath
        in: query
        description: A full path including folder and secret name can be passed as a query string parameter when the secret ID is set to 0.  This will lookup the secret ID by path.
        required: false
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/FavoriteSecretArgs'
        description: args
      responses:
        '200':
          description: Whether or not the secret is now favorited by the user.
          content:
            application/json:
              schema:
                description: Boolean
                type: boolean
        '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/secrets/{id}/stop-password-change:
    post:
      tags:
      - Secrets
      summary: Attempt to stop a password change
      description: Attempt to stop a password change
      operationId: SecretsService_StopPasswordChange
      parameters:
      - name: id
        in: path
        description: id
        required: true
        schema:
          type: integer
          format: int32
      - name: secretPath
        in: query
        description: A full path including folder and secret name can be passed as a query string parameter when the secret ID is set to 0.  This will lookup the secret ID by path.
        required: false
        schema:
          type: string
      responses:
        '200':
          description: Attempt to stop a password change
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SecretDetailStopPasswordResultModel'
        '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/secrets/convert-template:
    post:
      tags:
      - Secrets
      summary: Convert Secret Template
      description: Convert the specificed Secrets to a different Secret Template
      operationId: SecretsService_ConvertTemplate
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SecretDetailConvertTemplateArgs'
        description: args
      responses:
        '200':
          description: Convert template result
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SecretDetailConvertTemplateModel'
        '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/secrets/get-convert-info:
    post:
      tags:
      - Secrets
      summary: Get Convert Template Information
      description: Retrieve information about the requested conversion such as which fields exist on the target template.
      operationId: SecretsService_GetConvertInfo
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SecretDetailConvertTemplateInfoArgs'
        description: args
      responses:
        '200':
          description: Convert template info result
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConvertTemplateDetailsModel'
        '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/secrets/export:
    post:
      tags:
      - Secrets
      summary: Export Secrets
      description: Exports secrets
      operationId: SecretsService_ExportSecrets
      requestBody:
        $ref: '#/components/requestBodies/ExportSecretsArgs'
      responses:
        '200':
          description: Exported secrets
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SecretsExportResultModel'
        '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/secrets/export/job:
    post:
      tags:
      - Secrets
      summary: Export Secrets File Job Creation
      description: Export Secrets File Job Creation
      operationId: SecretsService_ExportSecretJob
      requestBody:
        $ref: '#/components/requestBodies/ExportSecretsArgs'
      responses:
        '200':
          description: Export Secrets File Job Created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ExportSecretsJobResultModel'
        '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/secrets/{id}/rpc-script-secrets:
    put:
      tags:
      - Secrets
      summary: Update which Secrets are available for RPC scripts
      description: Update which Secrets are available for RPC scripts
      operationId: SecretsService_UpdateRpcScriptSecrets
      parameters:
      - name: autoCheckIn
        in: query
        description: Automatically check in a secret after finding or updating.
        required: false
        schema:
          type: boolean
      - name: autoCheckout
        in: query
        description: Automatically check out secret before finding or updating.
        required: false
        schema:
          type: boolean
      - name: autoComment
        in: query
        description: Leave a comment when checking in or out.
        required: false
        schema:
          type: string
      - name: forceCheckIn
        in: query
        description: If secret is checked out, then force a check in.
        required: false
        schema:
          type: boolean
      - name: id
        in: path
        description: id
        required: true
        schema:
          type: integer
          format: int32
      - name: secretPath
        in: query
        description: A full path including folder and secret name can be passed as a query string parameter when the secret ID is set to 0.  This will lookup the secret ID by path.
        required: false
        schema:
          type: string
      requestBody:
        $ref: '#/components/requestBodies/SecretDetailUpdateRpcScriptSecretsArgs'
      responses:
        '200':
          description: SecretDetailRpcViewModel
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SecretDetailRpcModel'
        '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/secrets/{id}/activate:
    put:
      tags:
      - Secrets
      summary: Undelete a Secret
      description: Undelete a Secret
      operationId: SecretsService_UndeleteSecret
      parameters:
      - name: id
        in: path
        description: id
        required: true
        schema:
          type: integer
          format: int32
      - name: secretPath
        in: query
        description: A full path including folder and secret name can be passed as a query string parameter when the secret ID is set to 0.  This will lookup the secret ID by path.
        required: false
        schema:
          type: string
      responses:
        '200':
          description: Secret
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SecretDetailGeneralModel'
        '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/secrets/{id}/rpc-script-secrets:
    put:
      tags:
      - Secrets
      summary: Update which Secrets are available for RPC scripts
      description: Update which Secrets are available for RPC scripts
      operationId: SecretsService_UpdateRpcScriptSecretsV2
      parameters:
      - name: autoCheckIn
        in: query
        description: Automatically check in a secret after finding or updating.
        required: false
        schema:
          type: boolean
      - name: autoCheckout
        in: query
        description: Automatically check out secret before finding or updating.
        required: false
        schema:
          type: boolean
      - name: autoComment
        in: query
        description: Leave a comment when checking in or out.
        required: false
        schema:
          type: string
      - name: forceCheckIn
        in: query
        description: If secret is checked out, then force a check in.
        required: false
        schema:
          type: boolean
      - name: id
        in: path
        description: id
        required: true
        schema:
          type: integer
          format: int32
      - name: secretPath
        in: query
        description: A full path including folder and secret name can be passed as a query string parameter when the secret ID is set to 0.  This will lookup the secret ID by path.
        required: false
        schema:
          type: string
      requestBody:
        $ref: '#/components/requestBodies/SecretDetailUpdateRpcScriptSecretsArgs'
      responses:
        '200':
          description: SecretDetailRpcViewModel
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SecretDetailRpcModel'
        '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
  /v3/secrets/{id}/security-approval:
    put:
      tags:
      - Secrets
      summary: Update Secret Security Approval Options
      description: Update Secret Security Approval Options
      operationId: SecretsService_UpdateSecurityApprovalV3
      parameters:
      - name: autoCheckIn
        in: query
        description: Automatically check in a secret after finding or updating.
        required: false
        schema:
          type: boolean
      - name: autoCheckout
        in: query
        description: Automatically check out secret before finding or updating.
        required: false
        schema:
          type: boolean
      - name: autoComment
        in: query
        description: Leave a comment when checking in or out.
        required: false
        schema:
          type: string
      - name: forceCheckIn
        in: query
        description: If secret is checked out, then force a check in.
        required: false
        schema:
          type: boolean
      - name: id
        in: path
        description: id
        required: true
        schema:
          type: integer
          format: int32
      - name: secretPath
        in: query
        description: A full path including folder and secret name can be passed as a query string parameter when the secret ID is set to 0.  This will lookup the secret ID by path.
        required: false
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SecretDetailUpdateSecurityApprovalArgs'
        description: args
      responses:
        '200':
          description: SecretDetailSecurityViewModel
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SecretSecurityUpdateResponse'
        '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/secrets/{id}/activate:
    put:
      tags:
      - Secrets
      summary: Undelete a Secret
      description: Undelete a Secret
      operationId: SecretsService_UndeleteSecretV2
      parameters:
      - name: id
        in: path
        description: id
        required: true
        schema:
          type: integer
          format: int32
      - name: secretPath
        in: query
        description: A full path including folder and secret name can be passed as a query string parameter when the secret ID is set to 0.  This will lookup the secret ID by path.
        required: false
        schema:
          type: string
      responses:
        '200':
          description: Secret
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SecretDetailGeneralModel'
        '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/secrets/{id}/expiration:
    put:
      tags:
      - Secrets
      summary: Update a Secret expiration
      description: Update a Secret expiration
      operationId: SecretsService_UpdateExpiration
      parameters:
      - name: autoCheckIn
        in: query
        description: Automatically check in a secret after finding or updating.
        required: false
        schema:
          type: boolean
      - name: autoCheckout
        in: query
        description: Automatically check out secret before finding or updating.
        required: false
        schema:
          type: boolean
      - name: autoComment
        in: query
        description: Leave a comment when checking in or out.
        required: false
        schema:
          type: string
      - name: forceCheckIn
        in: query
        description: If secret is checked out, then force a check in.
        required: false
        schema:
          type: boolean
      - name: id
        in: path
        description: id
        required: true
        schema:
          type: integer
          format: int32
      - name: secretPath
        in: query
        description: A full path including folder and secret name can be passed as a query string parameter when the secret ID is set to 0.  This will lookup the secret ID by path.
        required: false
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SecretDetailUpdateExpirationArgs'
        description: args
      responses:
        '200':
          description: Updated secret settings
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SecretDetailSettingsModel'
        '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/secrets/{secretId}/update-ssh-restricted-commands:
    put:
      tags:
      - Secrets
      summary: Update Restricted SSH Commands on a Secret
      description: Update the restricted SSH commands configured on a Secret
      operationId: SecretsService_UpdateSshRestrictedCommands
      parameters:
      - name: autoCheckIn
        in: query
        description: Automatically check in a secret after finding or updating.
        required: false
        schema:
          type: boolean
      - name: autoCheckout
        in: query
        description: Automatically check out secret before finding or updating.
        required: false
        schema:
          type: boolean
      - name: autoComment
        in: query
        description: Leave a comment when checking in or out.
        required: false
        schema:
          type: string
      - name: forceCheckIn
        in: query
        description: If secret is checked out, then force a check in.
        required: false
        schema:
          type: boolean
      - name: secretId
        in: path
        description: secretId
        required: true
        schema:
          type: integer
          format: int32
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SecretDetailSshRestrictedCommandUpdateArgs'
        description: args
      responses:
        '200':
          description: Success / Fail
          content:
            application/json:
              schema:
                description: Boolean
                type: boolean
        '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/secret-detail/{secretId}/jumpbox-route-selection:
    put:
      tags:
      - Secrets
      summary: Update Jumpbox Route Selection
      description: Update Jumpbox Route Selection
      operationId: SecretsService_UpdateJumpboxRouteSelection
      parameters:
      - name: secretId
        in: path
        description: secretId
        required: true
        schema:
          type: integer
          format: int32
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SecretDetailJumpboxUpdateArgs'
        description: args
      responses:
        '200':
          description: Jumpbox Route View Model
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/JumpboxRouteSummaryModel'
        '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:
    SecretDetailSecurityMultifactorUpdateModel:
      description: Secret Security Multifactor Authentication Update
      properties:
        isMultifactorAuthenticationRequired:
          $ref: '#/components/schemas/UpdateFieldValueOfBoolean'
      type: object
    SecretDetailSettingsModel:
      description: Secret Detail Settings
      properties:
        expirationDate:
          description: Expiration Date
          type: string
          format: date-time
          nullable: true
        expirationDayInterval:
          description: Expiration Day Interval
          type: integer
          format: int32
          nullable: true
        expirationTemplateText:
          description: Expiration Template Text
          type: string
        expirationType:
          $ref: '#/components/schemas/SecretDetailExpirationType'
        jumpboxRouteSelection:
          $ref: '#/components/schemas/JumpboxRouteSummaryModel'
        oneTimePasswordSettings:
          $ref: '#/components/schemas/OneTimePasswordSettingsModel'
        rdpLauncherSettings:
          $ref: '#/components/schemas/RdpLauncherSettingsModel'
        sendEmailWhenChanged:
          description: Send Email When Changed
          type: boolean
        sendEmailWhenHeartbeatFails:
          description: Send Email When Heartbeat Fails
          type: boolean
        sendEmailWhenViewed:
          description: Send Email When Viewed
          type: boolean
        sshLauncherSettings:
          $ref: '#/components/schemas/SshLauncherSettingsModel'
      type: object
    HeartbeatStatus:
      description: Current status of heartbeat
      properties: {}
      type: string
      enum:
      - Failed
      - Success
      - Pending
      - Disabled
      - UnableToConnect
      - UnknownError
      - IncompatibleHost
      - AccountLockedOut
      - DnsMismatch
      - UnableToValidateServerPublicKey
      - Processing
      - ArgumentError
      - AccessDenied
      - NeedsImmediateRetry
    SortDirection:
      description: Sort direction
      properties: {}
      type: string
      enum:
      - None
      - Asc
      - Desc
    SecretSshProxyModel:
      description: SecretSshProxyModel
      properties:
        host:
          description: The host for the SSH Proxy
          type: string
        password:
          description: The password for the SSH Proxy
          type: string
        port:
          description: The port for the SSH Proxy
          type: integer
          format: int32
        username:
          description: The username for the SSH Proxy
          type: string
      type: object
    ConvertTemplateFieldModel:
      description: A secret field mapping for conversion
      properties:
        destinationFieldId:
          description: The destination field ID
          type: integer
          format: int32
          nullable: true
        sourceFieldId:
          description: The original source field ID
          type: integer
          format: int32
        sourceFieldValue:
          description: A value for the source field
          type: string
      type: object
    SecretResponseCodeModel:
      description: SecretResponseCodeModel
      properties:
        responseCodes:
          description: ResponseCodes
          items:
            type: string
          type: array
      type: object
    UpdateFieldValueOfOptionalDateTime:
      description: Update when the pinned folder was last viewed
      properties:
        dirty:
          description: Dirty
          type: boolean
        value:
          description: Value
          type: string
          format: date-time
          nullable: true
      type: object
    UpdateFieldValueOfInt32Array:
      description: FolderIds
      properties:
        dirty:
          description: Dirty
          type: boolean
        value:
          description: Value
          items:
            type: integer
            format: int32
          type: array
      type: object
    SecretDetailPasswordStatus:
      description: Password Status
      properties:
        failedAttempts:
          description: FailedAttempts
          type: integer
          format: int32
        failedDependency:
          description: FailedDependency
          type: boolean
          nullable: true
        lastRpcDate:
          description: LastRpcDate
          type: string
          format: date-time
          nullable: true
        nextRpcDate:
          description: NextRpcDate
          type: string
          format: date-time
          nullable: true
        rpcMessage:
          description: RpcMessage
          type: string
        status:
          $ref: '#/components/schemas/PasswordChangeResult'
      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
    SecretDetailRpcScriptSecretsUpdateModel:
      description: Secrets available for RPC Scripts
      properties:
        resetSecretIds:
          $ref: '#/components/schemas/UpdateFieldValueOfInt32Array'
      type: object
    SecretDetailSshCommandUpdateData:
      description: Secret SSH Command Data
      properties:
        allowOwnersUnrestrictedCommands:
          description: AllowOwnersUnrestrictedCommands
          type: boolean
        commandRestrictionType:
          $ref: '#/components/schemas/CommandRestrictionType'
        restrictSshCommands:
          description: RestrictSshCommands
          type: boolean
        sshCommandBlocklists:
          description: SshCommandBlocklists
          items:
            $ref: '#/components/schemas/SecretDetailRestrictedSshCommandBlocklistPermissionUpdateModel'
          type: array
        sshCommandMenus:
          description: SshCommandMenus
          items:
            $ref: '#/components/schemas/SecretDetailRestrictedSshCommandMenuPermissionUpdateModel'
          type: array
      type: object
    ViewFieldValueOfOptionalDateTime:
      description: Time of last heartbeat check
      properties:
        additionalLinks:
          description: AdditionalLinks
          items:
            $ref: '#/components/schemas/ViewFieldLink'
          type: array
        description:
          description: Description
          type: string
        fieldInputType:
          description: FieldInputType
          type: string
          nullable: true
        hasHistory:
          description: HasHistory
          type: boolean
          nullable: true
        helpLink:
          description: HelpLink
          type: string
        helpLinkText:
          description: HelpLinkText
          type: string
        hidden:
          description: Hidden
          type: boolean
          nullable: true
        hideOnView:
          description: HideOnView
          type: boolean
          nullable: true
        isRequired:
          description: IsRequired
          type: boolean
          nullable: true
        label:
          description: Label
          type: string
        maxLength:
          description: MaxLength
          type: integer
          format: int32
          nullable: true
        name:
          description: Name
          type: string
        placeholder:
          description: Placeholder
          type: string
        readOnly:
          description: ReadOnly
          type: boolean
          nullable: true
        readOnlyReason:
          description: ReadOnlyReason
          type: string
        sortOrder:
          description: SortOrder
          type: integer
          format: int32
          nullable: true
        value:
          description: Value
          type: string
          format: date-time
          nullable: true
      type: object
    SecretDetailRpcModel:
      description: Secret Detail RPC
      properties:
        autoChangeEnabled:
          description: AutoChange Enabled
          type: boolean
        autoChangeSchedule:
          $ref: '#/components/schemas/SecretDetailScheduleModel'
        canEnterNextPassword:
          description: Can Enter Next Password
          type: boolean
        expireText:
          description: Expire Text
          type: string
        hasNextPassphrase:
          description: Has Next Passphrase
          type: boolean
        hasNextPassword:
          description: Has Next Password
          type: boolean
        hasNextPrivateKey:
          description: Has Next Private Key
          type: boolean
        isValidForSshKeyRpc:
          description: is Valid For SSH Key RPC
          type: boolean
        passwordStatus:
          $ref: '#/components/schemas/SecretDetailPasswordStatus'
        passwordTypeId:
          description: Password Type Id
          type: integer
          format: int32
        passwordTypeName:
          description: Password Type Name
          type: string
        passwordTypeWebScriptId:
          description: Password Type WebScript Id
          type: integer
          format: int32
          nullable: true
        privilegedAccountSecretId:
          description: Priviliged Account Secret Id
          type: integer
          format: int32
          nullable: true
        privilegedAccountSecretName:
          description: Priviliged Account Secret Name
          type: string
        resetSecrets:
          description: Reset Secrets
          items:
            $ref: '#/components/schemas/SecretDetailRpcSecrets'
          type: array
      type: object
    ConvertTemplateDetailsModel:
      description: ConvertTemplateDetailsModel
      properties:
        destination:
          $ref: '#/components/schemas/ConvertTemplateDestinationModel'
        source:
          $ref: '#/components/schemas/ConvertTemplateSourceModel'
      type: object
    SecretDetailRestrictedSshCommandViewModel:
      description: SecretDetailRestrictedSshCommandViewModel
      properties:
        commandRestrictionType:
          $ref: '#/components/schemas/CommandRestrictionType'
        sshCommandBlocklists:
          description: Blocklists
          items:
            $ref: '#/components/schemas/SecretDetailRestrictedSshCommandBlocklistViewModel'
          type: array
        sshCommandMenus:
          description: Allowed menus
          items:
            $ref: '#/components/schemas/SecretDetailRestrictedSshCommandMenuViewModel'
          type: array
      type: object
    ViewFieldLink:
      description: AdditionalLinks
      properties:
        isExternal:
          description: IsExternal
          type: boolean
        linkText:
          description: LinkText
          type: string
        url:
          description: Url
          type: string
      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
    SecretRdpProxyModel:
      description: SecretRdpProxyModel
      properties:
        domain:
          description: The domain for the RDP Proxy
          type: string
        host:
          description: The host and port for the RDP Proxy
          type: string
        password:
          description: The password for the SSH Proxy
          type: string
        username:
          description: The username for the SSH Proxy
          type: string
      type: object
    SecretModel:
      description: Secret
      properties:
        accessRequestWorkflowMapId:
          description: AccessRequestWorkflowMapId
          type: integer
          format: int32
          nullable: true
        active:
          description: Whether the secret is active
          type: boolean
        allowOwnersUnrestrictedSshCommands:
          description: AllowOwnersUnrestrictedSshCommands
          type: boolean
        autoChangeEnabled:
          description: AutoChangeEnabled
          type: boolean
        autoChangeNextPassword:
          description: AutoChangeNextPassword
          type: string
        checkedOut:
          description: Whether the secret is currently checked out
          type: boolean
        checkOutChangePasswordEnabled:
          description: CheckOutChangePasswordEnabled
          type: boolean
        checkOutEnabled:
          description: Whether secret checkout is enabled
          type: boolean
        checkOutIntervalMinutes:
          description: Checkout interval, in minutes
          type: integer
          format: int32
        checkOutMinutesRemaining:
          description: Minutes remaining in current checkout interval
          type: integer
          format: int32
        checkOutUserDisplayName:
          description: Name of user who has checked out the secret
          type: string
        checkOutUserId:
          description: ID of user who has checked out the secret
          type: integer
          format: int32
        doubleLockId:
          description: DoubleLockId
          type: integer
          format: int32
        enableInheritPermissions:
          description: EnableInheritPermissions
          type: boolean
        enableInheritSecretPolicy:
          description: Whether the secret policy is inherited from the containing folder
          type: boolean
        failedPasswordChangeAttempts:
          description: Number of failed password change attempts
          type: integer
          format: int32
        folderId:
          description: Containing folder ID
          type: integer
          format: int32
        id:
          description: Secret ID
          type: integer
          format: int32
        isDoubleLock:
          description: Whether double lock is enabled
          type: boolean
        isOutOfSync:
          description: Out of sync indicates that a Password is setup for autochange and has failed its last password change attempt or has exceeded the maximum RPC attempts
          type: boolean
        isRestricted:
          description: Whether the secret is restricted
          type: boolean
        items:
          description: Secret data fields
          items:
            $ref: '#/components/schemas/RestSecretItem'
          type: array
        jumpboxRouteId:
          description: JumpboxRouteId
          type: string
          format: uuid
          nullable: true
        lastHeartBeatCheck:
          description: Time of last heartbeat check
          type: string
          format: date-time
        lastHeartBeatStatus:
          $ref: '#/components/schemas/HeartbeatStatus'
        lastPasswordChangeAttempt:
          description: Time of most recent password change attempt
          type: string
          format: date-time
        launcherConnectAsSecretId:
          description: LauncherConnectAsSecretId
          type: integer
          format: int32
          nullable: true
        name:
          description: Secret name
          type: string
        outOfSyncReason:
          description: Reason message if the secret is out of sync
          type: string
        passwordTypeWebScriptId:
          description: PasswordTypeWebScriptId
          type: integer
          format: int32
        proxyEnabled:
          description: ProxyEnabled
          type: boolean
        requiresApprovalForAccess:
          description: RequiresApprovalForAccess
          type: boolean
        requiresComment:
          description: RequiresComment
          type: boolean
        responseCodes:
          description: ResponseCodes
          items:
            type: string
          type: array
        restrictSshCommands:
          description: RestrictSshCommands
          type: boolean
        secretPolicyId:
          description: SecretPolicyId
          type: integer
          format: int32
        secretTemplateId:
          description: Secret template ID
          type: integer
          format: int32
        secretTemplateName:
          description: Name of secret template
          type: string
        sessionRecordingEnabled:
          description: Whether session recording is enabled
          type: boolean
        siteId:
          description: SiteId
          type: integer
          format: int32
        webLauncherRequiresIncognitoMode:
          description: WebLauncherRequiresIncognitoMode
          type: boolean
      type: object
    ViewFieldValueReadOnlyOfViewTemplateFieldDropDownOptionArray:
      description: AvailableDoubleLocks
      properties:
        additionalLinks:
          description: AdditionalLinks
          items:
            $ref: '#/components/schemas/ViewFieldLink'
          type: array
        description:
          description: Description
          type: string
        fieldInputType:
          description: FieldInputType
          type: string
          nullable: true
        hasHistory:
          description: HasHistory
          type: boolean
          nullable: true
        helpLink:
          description: HelpLink
          type: string
        helpLinkText:
          description: HelpLinkText
          type: string
        hidden:
          description: Hidden
          type: boolean
          nullable: true
        hideOnView:
          description: HideOnView
          type: boolean
          nullable: true
        isRequired:
          description: IsRequired
          type: boolean
          nullable: true
        label:
          description: Label
          type: string
        maxLength:
          description: MaxLength
          type: integer
          format: int32
          nullable: true
        name:
          description: Name
          type: string
        placeholder:
          description: Placeholder
          type: string
        readOnly:
          description: ReadOnly
          type: boolean
          nullable: true
        readOnlyReason:
          description: ReadOnlyReason
          type: string
        sortOrder:
          description: SortOrder
          type: integer
          format: int32
          nullable: true
        value:
          description: Value
          items:
            $ref: '#/components/schemas/ViewTemplateFieldDropDownOption'
          type: array
      type: object
    ExportSecretsModel:
      description: Data
      properties:
        doubleLockPassword:
          description: The DoubleLock password of the current user.
          type: string
        exportChildFolders:
          description: Export Child Folders
          type: boolean
          nullable: true
        exportFileType:
          $ref: '#/components/schemas/ExportFileType'
        exportFolderPath:
          description: Export Folder Path
          type: boolean
          nullable: true
        exportTotp:
          description: Export Totp Settings
          type: boolean
          nullable: true
        folderId:
          description: The folder Id of the specific folder being exported.
          type: integer
          format: int32
          nullable: true
        notes:
          description: Notes
          type: string
        password:
          description: The password of the current user.
          type: string
        requireMultifactorAuthenticationToExport:
          description: Is authentication type MFA?
          type: boolean
          nullable: true
      type: object
    ViewFieldValueOfBoolean:
      description: When enabled, the log will be able to be viewed online
      properties:
        additionalLinks:
          description: AdditionalLinks
          items:
            $ref: '#/components/schemas/ViewFieldLink'
          type: array
        description:
          description: Description
          type: string
        fieldInputType:
          description: FieldInputType
          type: string
          nullable: true
        hasHistory:
          description: HasHistory
          type: boolean
          nullable: true
        helpLink:
          description: HelpLink
          type: string
        helpLinkText:
          description: HelpLinkText
          type: string
        hidden:
          description: Hidden
          type: boolean
          nullable: true
        hideOnView:
          description: HideOnView
          type: boolean
          nullable: true
        isRequired:
          description: IsRequired
          type: boolean
          nullable: true
        label:
          description: Label
          type: string
        maxLength:
          description: MaxLength
          type: integer
          format: int32
          nullable: true
        name:
          description: Name
          type: string
        placeholder:
          description: Placeholder
          type: string
        readOnly:
          description: ReadOnly
          type: boolean
          nullable: true
        readOnlyReason:
          description: ReadOnlyReason
          type: string
        sortOrder:
          description: SortOrder
          type: integer
          format: int32
          nullable: true
        value:
          description: Value
          type: boolean
      type: object
    SecretDetailGeneralModel:
      description: Secret Detail General
      properties:
        active:
          description: Whether the secret is active
          type: boolean
        autoChangePassword:
          description: Whether the password should automatically change upon expiration.
          type: boolean
        canGenerateSshKey:
          description: Can Generate SSH Key
          type: boolean
        enableInheritSecretPolicy:
          description: Whether the secret policy is inherited from the containing folder
          type: boolean
        expiration:
          description: Expiration
          type: string
        fields:
          description: Secret Fields
          items:
            type: string
          type: array
        folder:
          description: Containing folder ID
          type: integer
          format: int32
          nullable: true
        heartbeatEnabled:
          description: Heartbeat Enabled
          type: boolean
        id:
          description: Secret Detail General Id
          type: integer
          format: int32
        isFavorite:
          description: Is Favorite
          type: boolean
        isOutOfSync:
          description: Whether the secret is out of sync
          type: boolean
        isTotpEnabled:
          description: Is One Time Password Enabled
          type: boolean
        lastHeartBeatCheck:
          description: Time of last heartbeat check
          type: string
          format: date-time
          nullable: true
        lastHeartBeatStatus:
          $ref: '#/components/schemas/SecretDetailHeartbeatStatus'
        launchers:
          description: Launchers
          items:
            $ref: '#/components/schemas/SecretDetailLauncher'
          type: array
        name:
          description: Secret Detail General Name
          type: string
        outOfSyncReason:
          description: Reason message if the secret is out of sync
          type: string
        passwordCompliance:
          $ref: '#/components/schemas/SecretPasswordComplianceCode'
        secretPolicy:
          description: Secret Policy
          type: integer
          format: int32
          nullable: true
        site:
          description: Site
          type: integer
          format: int32
          nullable: true
        slugPrivateKey:
          description: Private Key Field Slug
          type: string
        slugPublicKey:
          description: Public Key Field Slug
          type: string
        template:
          description: Secret template
          type: integer
          format: int32
          nullable: true
        totpPasswordSlug:
          description: One Time Password Field Slug
          type: string
      type: object
    SecretDetailStateActionsModel:
      description: Available Secret Detail State Actions
      properties:
        extendCheckOut:
          description: The user may extend the remaining check out time of the secret.
          type: boolean
      type: object
    SecretDetailSshRestrictedCommandUpdateArgs:
      description: Update Secret SSH Command Arguments
      properties:
        data:
          $ref: '#/components/schemas/SecretDetailSshCommandUpdateData'
      type: object
    UpdateFieldValueOfOptionalSecretDetailApprovalType:
      description: Approval Type
      properties:
        dirty:
          description: Dirty
          type: boolean
        value:
          description: Value
          type: string
          nullable: true
      type: object
    SecretRestrictedArgs:
      description: Restricted secret update options
      properties:
        comment:
          description: If the secret requires a comment to view or requires approval to view, a reason for accessing the secret must be provided.
          type: string
        doubleLockPassword:
          description: If the secret is DoubleLocked, this is the DoubleLock password needed to access the secret.
          type: string
        forceCheckIn:
          description: Force the secret to be checked in, even if checked out by someone else. The user must have the "Force Check In" permission.
          type: boolean
        includeInactive:
          description: If the secret is deactivated, this must be set to true in order to access the secret. The user must also have the "View Inactive Secrets" permission.
          type: boolean
        newPassword:
          description: New secret password.
          type: string
        noAutoCheckout:
          description: Don't check out the secret automatically.
          type: boolean
        ticketNumber:
          description: If the secret requires a comment to view or requires approval and a user must provide a help desk a ticket number, this is the ticket number to the help desk request.
          type: string
        ticketSystemId:
          description: If the secret requires a comment to view or requires approval and a user must provide a help desk a ticket number, this is the id of the help desk system configured in Secret Server that should be used to validate the ticket number.
          type: integer
          format: int32
          nullable: true
      type: object
    SecretDetailRestrictedSshCommandMenuViewModel:
      description: Allowed menus
      properties:
        displayName:
          description: DisplayName
          type: string
        groupId:
          description: GroupId
          type: integer
          format: int32
        sshCommandMenuId:
          description: SshCommandMenuId
          type: integer
          format: int32
          nullable: true
        sshCommandMenuName:
          description: SshCommandMenuName
          type: string
      type: object
    SecretDetailConvertTemplateArgs:
      description: Wrapper around secret template conversion arguments
      properties:
        data:
          $ref: '#/components/schemas/ConvertTemplateActionModel'
      type: object
    FavoriteSecretArgs:
      description: Arguments to favorite a secret.
      properties:
        isFavorite:
          description: Whether or not the secret is a favorite. This is an optional argument.
          type: boolean
          nullable: true
      type: object
    CommandRestrictionType:
      description: Command restriction type (AllowedMenu, Blocklist)
      properties: {}
      type: string
      enum:
      - AllowedMenu
      - BlockedList
    SecretDetailJumpboxUpdateArgs:
      description: SecretDetailJumpboxUpdateArgs
      properties:
        jumpboxRouteId:
          description: JumpboxRouteId
          type: string
          format: uuid
          nullable: true
      type: object
    PagingOfSecretTransitionHistorySummaryModel:
      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/SecretTransitionHistorySummaryModel'
          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
    SshKeyArgs:
      description: SSH key options
      properties:
        generatePassphrase:
          description: Whether to generate an SSH private key passphrase.  Only applicable when the Secret template has a password changer with the Private Key Passphrase field mapped.  If it is not mapped, this setting is ignored.
          type: boolean
        generateSshKeys:
          description: Whether to generate an SSH private key
          type: boolean
      type: object
    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
    SecretSearchExtendedSummary:
      description: SecretSearchExtendedSummary[]
      properties:
        hasLaunchers:
          description: Does this Secret have launchers the current user can use
          type: boolean
        isFavorite:
          description: Is this a favorite secret for the current user
          type: boolean
        lastAccessed:
          description: Does this Secret have launchers the current user can use
          type: string
          format: date-time
          nullable: true
        secretId:
          description: Secret ID
          type: integer
          format: int32
        secretName:
          description: Secret Name
          type: string
        totalSecretViews:
          description: Does this Secret have launchers the current user can use
          type: integer
          format: int32
      type: object
    UpdateFieldValueOfBoolean:
      description: Active
      properties:
        dirty:
          description: Dirty
          type: boolean
        value:
          description: Value
          type: boolean
      type: object
    SshRunLauncherType:
      description: Launcher Type
      properties: {}
      type: string
      enum:
      - ConnectAsSecret
      - ConnectAsDifferentSecret
      - UseSshKeyOnSecret
    SecretDetailRestrictedSshCommandBlocklistViewModel:
      description: Blocklists
      properties:
        displayName:
          description: DisplayName
          type: string
        rolePermissionId:
          description: RolePermissionId
          type: integer
          format: int32
        sshCommandBlocklistId:
          description: SshCommandBlocklistId
          type: string
          format: uuid
          nullable: true
        sshCommandBlocklistName:
          description: SshCommandBlocklistName
          type: string
      type: object
    SecretLauncherSessionSummary:
      description: Secret Launcher Session Summary
      properties:
        active:
          description: Is the session currently Active?
          type: boolean
        endDate:
          description: The date the session ended
          type: string
          format: date-time
          nullable: true
        launcherTypeId:
          description: The type code for the launcher for the session
          type: integer
          format: int32
          nullable: true
        secretId:
          description: The Id of the Secret
          type: integer
          format: int32
        secretSessionId:
          description: The Id of the Secret Session
          type: integer
          format: int32
          nullable: true
        startDate:
          description: The date the session started
          type: string
          format: date-time
        userName:
          description: The display user name of the person in the Secret Session
          type: string
      type: object
    SecretPasswordComplianceCode:
      description: Indicates if the password meets the password compliance rules setup for the secret template.
      properties: {}
      type: string
      enum:
      - Pending
      - Pass
      - Fail
    ConvertTemplateSourceModel:
      description: Source
      properties:
        fields:
          description: Fields
          items:
            $ref: '#/components/schemas/ConvertTemplateDetailFieldModel'
          type: array
        templateId:
          description: TemplateId
          type: integer
          format: int32
        templateName:
          description: TemplateName
          type: string
      type: object
    SiteModel:
      description: Site Model
      properties:
        active:
          description: Active flag
          type: boolean
        siteId:
          description: Site Id
          type: integer
          format: int32
        siteName:
          description: Site Name
          type: string
      type: object
    ViewFieldValueOfString:
      description: GeneratedToken
      properties:
        additionalLinks:
          description: AdditionalLinks
          items:
            $ref: '#/components/schemas/ViewFieldLink'
          type: array
        description:
          description: Description
          type: string
        fieldInputType:
          description: FieldInputType
          type: string
          nullable: true
        hasHistory:
          description: HasHistory
          type: boolean
          nullable: true
        helpLink:
          description: HelpLink
          type: string
        helpLinkText:
          description: HelpLinkText
          type: string
        hidden:
          description: Hidden
          type: boolean
          nullable: true
        hideOnView:
          description: HideOnView
          type: boolean
          nullable: true
        isRequired:
          description: IsRequired
          type: boolean
          nullable: true
        label:
          description: Label
          type: string
        maxLength:
          description: MaxLength
          type: integer
          format: int32
          nullable: true
        name:
          description: Name
          type: string
        placeholder:
          description: Placeholder
          type: string
        readOnly:
          description: ReadOnly
          type: boolean
          nullable: true
        readOnlyReason:
          description: ReadOnlyReason
          type: string
        sortOrder:
          description: SortOrder
          type: integer
          format: int32
          nullable: true
        value:
          description: Value
          type: string
      type: object
    PagingOfSecretSummary:
      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/SecretSummary'
          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
    SecretSecurityUpdateResponse:
      description: Response to indicate if the Secret security settings saved properly.  If you still have access to the model the updated model will be returned.  If checkout is now enabled then model will be null.
      properties:
        model:
          $ref: '#/components/schemas/SecretDetailSecurityModel'
        success:
          description: Returns as true if the update was successful.  Note that any failures should throw an error
          type: boolean
      type: object
    SecretLauncherSessionActionResult:
      description: Secret Launcher Session Action Result
      properties:
        success:
          description: Was the operation a Success?
          type: boolean
      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
    SecretItemUpdateArgs:
      description: Secret field update options
      properties:
        comment:
          description: If the secret requires a comment to view or requires approval to view, a reason for accessing the secret must be provided.
          type: string
        doubleLockPassword:
          description: If the secret is DoubleLocked, this is the DoubleLock password needed to access the secret.
          type: string
        file:
          description: 'Uploaded file (used for file attachment fields with "Content-Type: multipart/form-data")'
          type: string
          format: binary
        fileAttachment:
          description: 'Binary file data (used for file attachment fields with "Content-Type: application/json")'
          type: string
          format: binary
        fileName:
          description: 'File name (used for file attachment fields with "Content-Type: application/json"))'
          type: string
        forceCheckIn:
          description: Force the secret to be checked in, even if checked out by someone else. The user must have the "Force Check In" permission.
          type: boolean
        includeInactive:
          description: If the secret is deactivated, this must be set to true in order to access the secret. The user must also have the "View Inactive Secrets" permission.
          type: boolean
        newPassword:
          description: New secret password.
          type: string
        noAutoCheckout:
          description: Don't check out the secret automatically.
          type: boolean
        ticketNumber:
          description: If the secret requires a comment to view or requires approval and a user must provide a help desk a ticket number, this is the ticket number to the help desk request.
          type: string
        ticketSystemId:
          description: If the secret requires a comment to view or requires approval and a user must provide a help desk a ticket number, this is the id of the help desk system configured in Secret Server that should be used to validate the ticket number.
          type: integer
          format: int32
          nullable: true
        value:
          description: New value to assign to the secret field.
          type: string
      type: object
    SecretDetailSecurityGeneralUpdateModel:
      description: Secret General Information Update
      properties:
        doubleLockId:
          $ref: '#/components/schemas/UpdateFieldValueOfInt32'
        enableDoubleLock:
          $ref: '#/components/schemas/UpdateFieldValueOfBoolean'
        hideLauncherPassword:
          $ref: '#/components/schemas/UpdateFieldValueOfBoolean'
        proxyEnabled:
          $ref: '#/components/schemas/UpdateFieldValueOfBoolean'
        requiresComment:
          $ref: '#/components/schemas/UpdateFieldValueOfBoolean'
        sessionRecordingEnabled:
          $ref: '#/components/schemas/UpdateFieldValueOfBoolean'
        webLauncherRequiresIncognitoMode:
          $ref: '#/components/schemas/UpdateFieldValueOfBoolean'
      type: object
    SecretDetailGeneralViewModel:
      description: Secret Detail General View Model
      properties:
        active:
          $ref: '#/components/schemas/ViewFieldValueOfBoolean'
        autoChangePassword:
          $ref: '#/components/schemas/ViewFieldValueOfBoolean'
        canGenerateSshKey:
          description: CanGenerateSshKey
          type: boolean
        enableInheritSecretPolicy:
          $ref: '#/components/schemas/ViewFieldValueOfBoolean'
        expiration:
          $ref: '#/components/schemas/ViewFieldValueOfString'
        fields:
          description: Fields
          items:
            $ref: '#/components/schemas/ViewTemplateFieldOfString'
          type: array
        folder:
          $ref: '#/components/schemas/ViewFieldValueOfOptionalInt32'
        heartbeatEnabled:
          $ref: '#/components/schemas/ViewFieldValueOfBoolean'
        id:
          description: Id
          type: integer
          format: int32
        isFavorite:
          description: IsFavorite
          type: boolean
        isOutOfSync:
          $ref: '#/components/schemas/ViewFieldValueOfBoolean'
        isTotpEnabled:
          description: IsTotpEnabled
          type: boolean
        lastHeartBeatCheck:
          $ref: '#/components/schemas/ViewFieldValueOfOptionalDateTime'
        lastHeartBeatStatus:
          $ref: '#/components/schemas/ViewFieldValueOfSecretDetailHeartbeatStatus'
        launchers:
          description: Launchers
          items:
            $ref: '#/components/schemas/SecretDetailLauncher'
          type: array
        name:
          $ref: '#/components/schemas/ViewFieldValueOfString'
        outOfSyncReason:
          $ref: '#/components/schemas/ViewFieldValueOfString'
        passwordCompliance:
          $ref: '#/components/schemas/SecretPasswordComplianceCode'
        secretPolicy:
          $ref: '#/components/schemas/ViewFieldValueOfOptionalInt32'
        site:
          $ref: '#/components/schemas/ViewFieldValueOfOptionalInt32'
        slugPrivateKey:
          description: SlugPrivateKey
          type: string
        slugPublicKey:
          description: SlugPublicKey
          type: string
        template:
          $ref: '#/components/schemas/ViewFieldValueOfOptionalInt32'
        totpPasswordSlug:
          description: TotpPasswordSlug
          type: string
      type: object
    ExportSecretsArgs:
      description: ExportSecretsArgs
      properties:
        data:
          $ref: '#/components/schemas/ExportSecretsModel'
      type: object
    SecretFieldType:
      description: Type
      properties: {}
      type: string
      enum:
      - Text
      - Notes
      - Url
      - Password
      - File
      - DropDown
      - List
    SecretLauncherSessionArgs:
      description: Secret Launcher Session Args
      properties:
        action:
          $ref: '#/components/schemas/SessionActions'
        message:
          description: Message To Send
          type: string
        secretId:
          description: Secret Associated To Session
          type: integer
          format: int32
        secretSessionId:
          description: Secret Session Id, either the ID, Session Key, or Session GUID must be supplied
          type: integer
          format: int32
          nullable: true
        secretSessionKey:
          description: Secret Session Key, either the ID, Session Key, or Session GUID must be supplied
          type: string
        sessionGuid:
          description: Secret Session Guid, this can be either the secret sessino key or launcher GUID, the ID, Session Key, or Session GUID must be supplied
          type: string
      type: object
    DashboardViewSecretItem:
      description: items
      properties:
        fileAttachmentId:
          description: fileAttachmentId
          type: integer
          format: int32
        fileName:
          description: fileName
          type: string
        isAllowedToViewPassword:
          description: isAllowedToViewPassword
          type: boolean
        isFile:
          description: isFile
          type: boolean
        isNotes:
          description: isNotes
          type: boolean
        isPassword:
          description: isPassword
          type: boolean
        isUrl:
          description: isUrl
          type: boolean
        label:
          description: label
          type: string
        neverShowPassword:
          description: neverShowPassword
          type: boolean
        passwordIsMaskedByDefault:
          description: passwordIsMaskedByDefault
          type: boolean
        secretFieldId:
          description: secretFieldId
          type: integer
          format: int32
        secretItemId:
          description: secretItemId
          type: integer
          format: int32
        slug:
          description: slug
          type: string
        value:
          description: value
          type: string
      type: object
    ConvertTemplateDetailFieldModel:
      description: Fields
      properties:
        id:
          description: Id
          type: integer
          format: int32
        name:
          description: Name
          type: string
        type:
          $ref: '#/components/schemas/SecretFieldType'
      type: object
    ViewFieldValueOfCommandRestrictionType:
      description: CommandRestrictionType
      properties:
        additionalLinks:
          description: AdditionalLinks
          items:
            $ref: '#/components/schemas/ViewFieldLink'
          type: array
        description:
          description: Description
          type: string
        fieldInputType:
          description: FieldInputType
          type: string
          nullable: true
        hasHistory:
          description: HasHistory
          type: boolean
          nullable: true
        helpLink:
          description: HelpLink
          type: string
        helpLinkText:
          description: HelpLinkText
          type: string
        hidden:
          description: Hidden
          type: boolean
          nullable: true
        hideOnView:
          description: HideOnView
          type: boolean
          nullable: true
        isRequired:
          description: IsRequired
          type: boolean
          nullable: true
        label:
          description: Label
          type: string
        maxLength:
          description: MaxLength
          type: integer
          format: int32
          nullable: true
        name:
          description: Name
          type: string
        placeholder:
          description: Placeholder
          type: string
        readOnly:
          description: ReadOnly
          type: boolean
          nullable: true
        readOnlyReason:
          description: ReadOnlyReason
          type: string
        sortOrder:
          description: SortOrder
          type: integer
          format: int32
          nullable: true
        value:
          $ref: '#/components/schemas/CommandRestrictionType'
      type: object
    SecretListFieldListArgs:
      description: Secret List Field List Args
      properties:
        listGuids:
          description: Array of List GUIDs
          items:
            type: string
            format: uuid
          type: array
      type: object
    ExportSecretsJobResultModel:
      description: ExportSecretsJobResultModel
      properties:
        exportJobId:
          description: Unique Guid identifier for the job
          type: string
          format: uuid
        fileType:
          $ref: '#/components/schemas/ExportFileType'
        status:
          $ref: '#/components/schemas/ExportSecretJobStatus'
        tracking:
          description: Tracking URL for the Job
          type: string
      type: object
    ExportSecretsExportJobDetails:
      description: ExportSecretsExportJobDetails
      properties:
        errors:
          description: Secret Export Errors
          items:
            $ref: '#/components/schemas/SecretExportErrorModel'
          type: array
        exportJobId:
          description: Unique Guid identifier for the job
          type: string
          format: uuid
        secretsCount:
          description: Count of Exported Secrets
          type: integer
          format: int32
      type: object
    AuthenticationFailedResponse:
      description: Response object for authentication failures
      required:
      - message
      properties:
        message:
          description: Error message
          type: string
      type: object
    SecretDetailGeneralUpdateModel:
      description: Secret General Settings Update
      properties:
        active:
          $ref: '#/components/schemas/UpdateFieldValueOfBoolean'
        enableInheritSecretPolicy:
          $ref: '#/components/schemas/UpdateFieldValueOfBoolean'
        folder:
          $ref: '#/components/schemas/UpdateFieldValueOfOptionalInt32'
        generateSshKeys:
          description: When true autogenerate new SSH keys
          type: boolean
          nullable: true
        heartbeatEnabled:
          $ref: '#/components/schemas/UpdateFieldValueOfBoolean'
        isOutOfSync:
          $ref: '#/components/schemas/UpdateFieldValueOfOptionalBoolean'
        name:
          $ref: '#/components/schemas/UpdateFieldValueOfString'
        secretFields:
          description: Secret Fields
          items:
            $ref: '#/components/schemas/UpdateTemplateFieldOfString'
          type: array
        secretPolicy:
          $ref: '#/components/schemas/UpdateFieldValueOfOptionalInt32'
        site:
          $ref: '#/components/schemas/UpdateFieldValueOfOptionalInt32'
        template:
          $ref: '#/components/schemas/UpdateFieldValueOfOptionalInt32'
      type: object
    SecretDetailUpdateSecurityCheckoutArgs:
      description: Secret Security Checkout Message
      properties:
        data:
          $ref: '#/components/schemas/SecretDetailSecurityCheckoutUpdateModel'
      type: object
    SecretDetailActionType:
      description: Secret Detail Action Type
      properties: {}
      type: string
      enum:
      - ChangePasswordNow
      - ConvertTemplate
      - Copy
      - Delete
      - Edit
      - EditExpiration
      - EditRpc
      - EditSecurity
      - Expire
      - Heartbeat
      - EditShare
      - ShowSshProxyCredentials
      - StopChangePasswordNow
      - ViewAudit
      - ViewDependencies
      - ViewLaunchers
      - ViewExpiration
      - ViewHooks
      - ViewRpc
      - ViewSecurity
      - ViewSettings
      - Undelete
      - ForceCheckin
      - ViewShare
      - EditHooks
      - EditDependencies
      - ViewGeneralDetails
      - ViewHeartbeatStatus
      - Checkin
      - Checkout
      - GenerateOneTimePassword
      - ShowSshTerminalDetails
      - ShowRdpProxyCredentials
      - ViewMetadata
      - ViewSecretExposure
      - ViewCheckOut
      - ViewApproval
      - ViewListFields
      - Erase
      - ViewMfa
    ViewFieldValueOfWorkflowTemplate:
      description: ApprovalWorkflow
      properties:
        additionalLinks:
          description: AdditionalLinks
          items:
            $ref: '#/components/schemas/ViewFieldLink'
          type: array
        description:
          description: Description
          type: string
        fieldInputType:
          description: FieldInputType
          type: string
          nullable: true
        hasHistory:
          description: HasHistory
          type: boolean
          nullable: true
        helpLink:
          description: HelpLink
          type: string
        helpLinkText:
          description: HelpLinkText
          type: string
        hidden:
          description: Hidden
          type: boolean
          nullable: true
        hideOnView:
          description: HideOnView
          type: boolean
          nullable: true
        isRequired:
          description: IsRequired
          type: boolean
          nullable: true
        label:
          description: Label
          type: string
        maxLength:
          description: MaxLength
          type: integer
          format: int32
          nullable: true
        name:
          description: Name
          type: string
        placeholder:
          description: Placeholder
          type: string
        readOnly:
          description: ReadOnly
          type: boolean
          nullable: true
        readOnlyReason:
          description: ReadOnlyReason
          type: string
        sortOrder:
          description: SortOrder
          type: integer
          format: int32
          nullable: true
        value:
          $ref: '#/components/schemas/WorkflowTemplate'
      type: object
    ViewFieldValueOfWorkflowTemplateArray:
      description: ApprovalWorkflowOptions
      properties:
        additionalLinks:
          description: AdditionalLinks
          items:
            $ref: '#/components/schemas/ViewFieldLink'
          type: array
        description:
          description: Description
          type: string
        fieldInputType:
          description: FieldInputType
          type: string
          nullable: true
        hasHistory:
          description: HasHistory
          type: boolean
          nullable: true
        helpLink:
          description: HelpLink
          type: string
        helpLinkText:
          description: HelpLinkText
          type: string
        hidden:
          description: Hidden
          type: boolean
          nullable: true
        hideOnView:
          description: HideOnView
          type: boolean
          nullable: true
        isRequired:
          description: IsRequired
          type: boolean
          nullable: true
        label:
          description: Label
          type: string
        maxLength:
          description: MaxLength
          type: integer
          format: int32
          nullable: true
        name:
          description: Name
          type: string
        placeholder:
          description: Placeholder
          type: string
        readOnly:
          description: ReadOnly
          type: boolean
          nullable: true
        readOnlyReason:
          description: ReadOnlyReason
          type: string
        sortOrder:
          description: SortOrder
          type: integer
          format: int32
          nullable: true
        value:
          description: Value
          items:
            $ref: '#/components/schemas/WorkflowTemplate'
          type: array
      type: object
    SecretDetailUpdateGeneralArgs:
      description: Secret General Settings Update Message
      properties:
        data:
          $ref: '#/components/schemas/SecretDetailGeneralUpdateModel'
      type: object
    SecretDetailUpdateSecurityApprovalArgs:
      description: Secret Update Security Approval Message
      properties:
        data:
          $ref: '#/components/schemas/SecretDetailSecurityApprovalUpdateModel'
      type: object
    WorkflowType:
      description: WorkflowType
      properties: {}
      type: string
      enum:
      - AccessRequest
      - SecretEraseRequest
    PagingOfCategorizedListSummary:
      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/CategorizedListSummary'
          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
    UpdateFieldValueOfString:
      description: Description
      properties:
        dirty:
          description: Dirty
          type: boolean
        value:
          description: Value
          type: string
      type: object
    ViewFieldValueOfSecretDetailApprovalType:
      description: RequireApprovalType
      properties:
        additionalLinks:
          description: AdditionalLinks
          items:
            $ref: '#/components/schemas/ViewFieldLink'
          type: array
        description:
          description: Description
          type: string
        fieldInputType:
          description: FieldInputType
          type: string
          nullable: true
        hasHistory:
          description: HasHistory
          type: boolean
          nullable: true
        helpLink:
          description: HelpLink
          type: string
        helpLinkText:
          description: HelpLinkText
          type: string
        hidden:
          description: Hidden
          type: boolean
          nullable: true
        hideOnView:
          description: HideOnView
          type: boolean
          nullable: true
        isRequired:
          description: IsRequired
          type: boolean
          nullable: true
        label:
          description: Label
          type: string
        maxLength:
          description: MaxLength
          type: integer
          format: int32
          nullable: true
        name:
          description: Name
          type: string
        placeholder:
          description: Placeholder
          type: string
        readOnly:
          description: ReadOnly
          type: boolean
          nullable: true
        readOnlyReason:
          description: ReadOnlyReason
          type: string
        sortOrder:
          description: SortOrder
          type: integer
          format: int32
          nullable: true
        value:
          $ref: '#/components/schemas/SecretDetailApprovalType'
      type: object
    SecretCheckOutExtensionResponseModel:
      description: SecretCheckOutExtensionResponseModel
      properties:
        checkOutEndTime:
          description: CheckOutEndTime
          type: string
          format: date-time
      type: object
    SecretAuditModel:
      description: Secret Audit Model
      properties:
        action:
          description: Action of Audit
          type: string
        actionForDisplay:
          description: Action For Display
          type: string
        application:
          description: Application
          type: string
        byUserDisplayName:
          description: User that performed action
          type: string
        databaseName:
          description: Database Name
          type: string
        dateRecorded:
          description: Date Audit was Recorded
          type: string
          format: date-time
        hasProxySessionData:
          description: Has Proxy Session Data
          type: boolean
          nullable: true
        id:
          description: Id of Audit
          type: integer
          format: int32
        notes:
          description: Notes of Audit
          type: string
        recordingMessage:
          description: Recording Message
          type: string
        recordingSessionId:
          description: Recording Session Id
          type: string
        recordingStatus:
          description: Status of Recording
          type: integer
          format: int32
        status:
          description: Status
          type: string
        ticketNumber:
          description: Ticket Number of Audit
          type: string
        username:
          description: Username
          type: string
      type: object
    JumpboxRouteSummaryModel:
      description: Query results
      properties:
        active:
          description: Active
          type: boolean
        description:
          description: Description
          type: string
        jumpboxRouteId:
          description: JumpboxRouteId
          type: string
          format: uuid
          nullable: true
        name:
          description: Name
          type: string
      type: object
    Severity:
      description: Error severity level
      properties: {}
      type: string
      enum:
      - None
      - Retry
      - Warn
      - Critical
      - Fatal
    SecretCreateArgs:
      description: Secret create options
      required:
      - name
      - secretTemplateId
      - items
      properties:
        autoChangeEnabled:
          description: Whether the secret’s password is automatically rotated on a schedule.
          type: boolean
        changePasswordNow:
          description: Whether the Secret should be immediately queued for Remote Password Change upon successful import.
          type: boolean
        checkOutChangePasswordEnabled:
          description: Whether the secret’s password is automatically changed when a secret is checked in. This is a security feature that prevents a use of the password retrieved from check-out after the secret is checked in.
          type: boolean
        checkOutEnabled:
          description: Whether the user must check-out the secret to view it. Checking out gives the user exclusive access to the secret for a specified period or until the secret is checked in.
          type: boolean
        checkOutIntervalMinutes:
          description: The number of minutes that a secret will remain checked out.
          type: integer
          format: int32
          nullable: true
        delayIndexing:
          description: Whether the search indexing should be delayed to the background process. This can speed up bulk secret creation scripts by offloading the task of indexing the new secrets to the background task at the trade-off of not having search indexes immediately available.
          type: boolean
          nullable: true
        enableInheritPermissions:
          description: Whether the secret inherits permissions from the containing folder.
          type: boolean
          nullable: true
        enableInheritSecretPolicy:
          description: Whether the secret policy is inherited from the containing folder.
          type: boolean
        folderId:
          description: If the secret is contained in a folder, the id of the containing folder. Set to null or -1 for secrets that are in the root folder.
          type: integer
          format: int32
          nullable: true
        items:
          description: An array of values for the secret fields defined in the secret template.
          items:
            $ref: '#/components/schemas/RestSecretItem'
          type: array
        launcherConnectAsSecretId:
          description: When an SSH secret is proxied, you can choose to connect as another user and then do an su to the current secret’s user. This is a common practice for connecting with a lower privileged account and then switching to the root user.
          type: integer
          format: int32
          nullable: true
        name:
          description: The name to display for the secret.
          type: string
        passwordTypeWebScriptId:
          description: The id of the password change script to use on applicable web password secrets.
          type: integer
          format: int32
          nullable: true
        proxyEnabled:
          description: Whether sessions launched on this secret use Secret Server’s proxying or connect directly.
          type: boolean
        requiresComment:
          description: Whether the user must enter a comment to view the secret.
          type: boolean
        secretPolicyId:
          description: The id of the secret policy that controls the security and other settings of the secret. Set to null to not assign a secret policy.
          type: integer
          format: int32
          nullable: true
        secretTemplateId:
          description: The id of the secret template that defines the fields and properties of the secret.
          type: integer
          format: int32
          minimum: 1
        sessionRecordingEnabled:
          description: Whether session recording is enabled.
          type: boolean
        siteId:
          description: The id of the distributed engine site that is used by this secret for operations such as password changing.
          type: integer
          format: int32
          minimum: 1
        sshKeyArgs:
          $ref: '#/components/schemas/SshKeyArgs'
        webLauncherRequiresIncognitoMode:
          description: Whether the web launcher will require the browser to run in incognito mode.
          type: boolean
      type: object
    SecretDetailStateViewModel:
      description: Secret Detail State View Model
      properties:
        actions:
          description: Allowed action for current user
          items:
            $ref: '#/components/schemas/SecretDetailActionType'
          type: array
        approvalEnd:
          description: Date when the current approval expires, or null if there is no open approval
          type: string
          format: date-time
          nullable: true
        availableActions:
          $ref: '#/components/schemas/SecretDetailStateActionsModel'
        checkedOutUserDisplayName:
          description: Display Name of User that has the secret checked out
          type: string
        checkedOutUserId:
          description: User Secret is checked out to
          type: integer
          format: int32
          nullable: true
        checkOutIntervalMinutes:
          description: 'Number of minutes before checkout '
          type: integer
          format: int32
          nullable: true
        checkOutMinutesRemaining:
          description: Minutes remaining in check out
          type: integer
          format: int32
          nullable: true
        folderId:
          description: Folder Id
          type: integer
          format: int32
          nullable: true
        folderName:
          description: Folder Name
          type: string
        id:
          description: Secret Id
          type: integer
          format: int32
          nullable: true
        inheritPermissions:
          description: Is this secret inheriting permissions from its folder
          type: boolean
        isActive:
          description: Active indicator
          type: boolean
          nullable: true
        isCheckedOut:
          description: Is the Secret checked out
          type: boolean
          nullable: true
        isCheckedOutByCurrentUser:
          description: Indicates whether the Secret is checked out by the current user
          type: boolean
          nullable: true
        passwordChangeFailed:
          description: The last password change failed when true
          type: boolean
          nullable: true
        passwordChangePending:
          description: Pending Password change on secret indicator
          type: boolean
          nullable: true
        remainingTimeWarningMinuteMarker:
          description: Minute mark to show check out warning
          type: integer
          format: int32
          nullable: true
        role:
          description: Role that current user has on Secret
          type: string
          nullable: true
        secretName:
          description: Secret Name
          type: string
        secretState:
          $ref: '#/components/schemas/SecretAccessRequired'
        warningMinutesRemaining:
          description: Minutes remaining before showing check in warning
          type: integer
          format: int32
          nullable: true
      type: object
    PagingOfSecretLauncherSessionSummary:
      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/SecretLauncherSessionSummary'
          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
    ConvertTemplateDestinationModel:
      description: Destination
      properties:
        fields:
          description: Fields
          items:
            $ref: '#/components/schemas/ConvertTemplateDetailFieldModel'
          type: array
      type: object
    SecretUpdateArgs:
      description: Secret update options
      required:
      - id
      - name
      - items
      properties:
        accessRequestWorkflowMapId:
          description: The id of the mapping entity that associates this secret to a specific access request workflow.
          type: integer
          format: int32
          nullable: true
        active:
          description: Whether the secret is in an active or deleted state.
          type: boolean
        autoChangeEnabled:
          description: Whether the secret’s password is automatically rotated on a schedule.
          type: boolean
        autoChangeNextPassword:
          description: Whether the secret should be flagged for immediate password change.
          type: string
        checkOutChangePasswordEnabled:
          description: Whether the secret’s password is automatically changed when a secret is checked in. This is a security feature that prevents a use of the password retrieved from check-out after the secret is checked in.
          type: boolean
        checkOutEnabled:
          description: Whether the user must check-out the secret to view it. Checking out gives the user exclusive access to the secret for a specified period or until the secret is checked in.
          type: boolean
        checkOutIntervalMinutes:
          description: The number of minutes that a secret will remain checked out.
          type: integer
          format: int32
          nullable: true
        comment:
          description: If the secret requires a comment to view or requires approval to view, a reason for accessing the secret must be provided.
          type: string
        doubleLockPassword:
          description: If the secret is DoubleLocked, this is the DoubleLock password needed to access the secret.
          type: string
        enableInheritPermissions:
          description: Whether the secret inherits permissions from the containing folder.
          type: boolean
          nullable: true
        enableInheritSecretPolicy:
          description: Whether the secret policy is inherited from the containing folder.
          type: boolean
        folderId:
          description: If the secret is contained in a folder, the id of the containing folder. Set to null or -1 for secrets that are in the root folder.
          type: integer
          format: int32
          nullable: true
        forceCheckIn:
          description: Force the secret to be checked in, even if checked out by someone else. The user must have the "Force Check In" permission.
          type: boolean
        id:
          description: The id of the Secret to update. Must match the {id} in the path.
          type: integer
          format: int32
          minimum: 1
        includeInactive:
          description: If the secret is deactivated, this must be set to true in order to access the secret. The user must also have the "View Inactive Secrets" permission.
          type: boolean
        items:
          description: A list of secret item field values.
          items:
            $ref: '#/components/schemas/RestSecretItem'
          type: array
        launcherConnectAsSecretId:
          description: When an SSH secret is proxied, you can choose to connect as another user and then do an su to the current secret’s user. This is a common practice for connecting with a lower privileged account and then switching to the root user.
          type: integer
          format: int32
          nullable: true
        name:
          description: The name to display for the secret.
          type: string
        newPassword:
          description: New secret password.
          type: string
        noAutoCheckout:
          description: Don't check out the secret automatically.
          type: boolean
        passwordTypeWebScriptId:
          description: The id of the password change script to use on applicable web password secrets.
          type: integer
          format: int32
          nullable: true
        proxyEnabled:
          description: Whether sessions launched on this secret use Secret Server’s proxying or connect directly.
          type: boolean
        requiresComment:
          description: Whether the user must enter a comment to view the secret.
          type: boolean
        secretPolicyId:
          description: The id of the secret policy that controls the security and other settings of the secret. Set to null to not assign a secret policy.
          type: integer
          format: int32
          nullable: true
        sessionRecordingEnabled:
          description: Whether session recording is enabled.
          type: boolean
        siteId:
          description: The id of the distributed engine site that is used by this secret for operations such as password changing.
          type: integer
          format: int32
          minimum: 1
        sshKeyArgs:
          $ref: '#/components/schemas/SshKeyArgs'
        ticketNumber:
          description: If the secret requires a comment to view or requires approval and a user must provide a help desk a ticket number, this is the ticket number to the help desk request.
          type: string
        ticketSystemId:
          description: If the secret requires a comment to view or requires approval and a user must provide a help desk a ticket number, this is the id of the help desk system configured in Secret Server that should be used to validate the ticket number.
          type: integer
          format: int32
          nullable: true
        webLauncherRequiresIncognitoMode:
          description: Whether the web launcher will require the browser to run in incognito mode.
          type: boolean
          nullable: true
      type: object
    UpdateFieldValueOfInt32:
      description: How many days until the password expires.
      properties:
        dirty:
          description: Dirty
          type: boolean
        value:
          description: Value
          type: integer
          format: int32
      type: object
    SecretDetailSecurityViewModel:
      description: SecretDetailSecurityViewModel
      properties:
        allowOwnersUnrestrictedSshCommands:
          $ref: '#/components/schemas/ViewFieldValueOfBoolean'
        approvalWorkflow:
          $ref: '#/components/schemas/ViewFieldValueOfWorkflowTemplate'
        approvalWorkflowOptions:
          $ref: '#/components/schemas/ViewFieldValueOfWorkflowTemplateArray'
        approvers:
          $ref: '#/components/schemas/ViewFieldValueOfSecretDetailUserViewModelArray'
        availableDoubleLocks:
          $ref: '#/components/schemas/ViewFieldValueReadOnlyOfViewTemplateFieldDropDownOptionArray'
        availableRequireApprovalTypes:
          $ref: '#/components/schemas/ViewFieldValueOfSecretDetailApprovalTypeArray'
        checkOutChangePasswordEnabled:
          $ref: '#/components/schemas/ViewFieldValueOfBoolean'
        checkOutDefaultIntervalDisplay:
          $ref: '#/components/schemas/ViewFieldValueReadOnlyOfString'
        checkOutEnabled:
          $ref: '#/components/schemas/ViewFieldValueOfBoolean'
        checkOutIntervalDisplay:
          $ref: '#/components/schemas/ViewFieldValueReadOnlyOfString'
        checkOutIntervalMinutes:
          $ref: '#/components/schemas/ViewFieldValueOfOptionalInt32'
        commandRestrictionType:
          $ref: '#/components/schemas/ViewFieldValueOfCommandRestrictionType'
        doubleLockId:
          $ref: '#/components/schemas/ViewFieldValueOfInt32'
        doubleLockName:
          $ref: '#/components/schemas/ViewFieldValueReadOnlyOfString'
        hideLauncherPassword:
          $ref: '#/components/schemas/ViewFieldValueOfBoolean'
        isDoubleLock:
          $ref: '#/components/schemas/ViewFieldValueOfBoolean'
        isMultiFactorAuthenticationRequired:
          $ref: '#/components/schemas/ViewFieldValueOfBoolean'
        passwordRequirements:
          $ref: '#/components/schemas/SecretDetailSecurityPasswordRequirements'
        proxyEnabled:
          $ref: '#/components/schemas/ViewFieldValueOfBoolean'
        requireApprovalType:
          $ref: '#/components/schemas/ViewFieldValueOfSecretDetailApprovalType'
        requiresComment:
          $ref: '#/components/schemas/ViewFieldValueOfBoolean'
        restrictedSshCommandCount:
          description: RestrictedSshCommandCount
          type: integer
          format: int32
        restrictSshCommands:
          $ref: '#/components/schemas/ViewFieldValueOfBoolean'
        sessionRecordingEnabled:
          $ref: '#/components/schemas/ViewFieldValueOfBoolean'
        shouldDisplayMultifactorAuthenticationDisasterRecoveryWarning:
          description: Whether additional messaging about the interaction between multifactor authentication and Disaster Recovery should be displayed
          type: boolean
        webLauncherRequiresIncognitoMode:
          $ref: '#/components/schemas/ViewFieldValueOfBoolean'
      type: object
    SecretDetailStopPasswordResultModel:
      description: SecretDetailStopPasswordResultModel
      properties:
        success:
          description: Success
          type: boolean
      type: object
    SecretSshTerminalModel:
      description: SecretSshTerminalModel
      properties:
        host:
          description: The host for the SSH Proxy
          type: string
        port:
          description: The port for the SSH Proxy
          type: integer
          format: int32
        secretId:
          description: The secret id to launch
          type: integer
          format: int32
        username:
          description: The username for the SSH Proxy
          type: string
      type: object
    SshLauncherSettingsModel:
      description: SSH Launcher Settings
      properties:
        canConnectAsCredentials:
          description: Can Connect As Credentials
          type: boolean
        launcherType:
          $ref: '#/components/schemas/SshRunLauncherType'
        secretId:
          description: Secret Id
          type: integer
          format: int32
          nullable: true
        secretName:
          description: Secret Name
          type: string
        sshKeyExtendedTypeId:
          description: SSH Key Extended Type Id
          type: integer
          format: int32
      type: object
    OneTimePasswordSettingsModel:
      description: One Time Password Settings
      properties:
        backupCodes:
          description: Backup Codes
          type: string
        dateChanged:
          description: Date Changed
          type: string
          format: date-time
        enabled:
          description: Enabled
          type: boolean
        enabledOnTemplate:
          description: Enabled On Template
          type: boolean
        key:
          description: Key
          type: string
      type: object
    SecretDetailExpirationType:
      description: Expiration Type
      properties: {}
      type: string
      enum:
      - Template
      - DayInterval
      - SpecificDate
      - Disabled
    SecretDetailUpdateRpcScriptSecretsArgs:
      description: RPC Script Update Message
      properties:
        data:
          $ref: '#/components/schemas/SecretDetailRpcScriptSecretsUpdateModel'
      type: object
    DashboardViewLauncherInfo:
      description: launchers
      properties:
        defaultSiteId:
          description: defaultSiteId
          type: integer
          format: int32
        hasProxyCredentials:
          description: hasProxyCredentials
          type: boolean
        launcherClientClick:
          description: launcherClientClick
          type: string
        launcherDisplayName:
          description: launcherDisplayName
          type: string
        launcherImage:
          description: launcherImage
          type: string
        launcherPromptName:
          description: launcherPromptName
          type: string
        launcherTooltip:
          description: launcherTooltip
          type: string
        launcherTypeId:
          description: launcherTypeId
          type: integer
          format: int32
        restrictedHosts:
          description: restrictedHosts
          items:
            type: string
          type: array
        restrictHost:
          description: restrictHost
          type: boolean
        restrictHostType:
          description: restrictHostType
          type: integer
          format: int32
        showLauncher:
          description: showLauncher
          type: boolean
        sitePrompt:
          description: sitePrompt
          type: string
        siteSelection:
          description: siteSelection
          items:
            $ref: '#/components/schemas/SiteModel'
          type: array
        useProtocolHandler:
          description: useProtocolHandler
          type: boolean
      type: object
    ViewTemplateFieldOfString:
      description: Fields
      properties:
        additionalLinks:
          description: AdditionalLinks
          items:
            $ref: '#/components/schemas/ViewFieldLink'
          type: array
        description:
          description: Description
          type: string
        dropDownOptions:
          description: DropDownOptions
          items:
            $ref: '#/components/schemas/ViewTemplateFieldDropDownOption'
          type: array
        fieldInputType:
          description: FieldInputType
          type: string
          nullable: true
        hasHistory:
          description: HasHistory
          type: boolean
          nullable: true
        helpLink:
          description: HelpLink
          type: string
        helpLinkText:
          description: HelpLinkText
          type: string
        hidden:
          description: Hidden
          type: boolean
          nullable: true
        hideOnView:
          description: HideOnView
          type: boolean
          nullable: true
        isRequired:
          description: IsRequired
          type: boolean
          nullable: true
        label:
          description: Label
          type: string
        listType:
          $ref: '#/components/schemas/SecretFieldListType'
        maxLength:
          description: MaxLength
          type: integer
          format: int32
          nullable: true
        name:
          description: Name
          type: string
        passwordRequirementId:
          description: PasswordRequirementId
          type: integer
          format: int32
          nullable: true
        placeholder:
          description: Placeholder
          type: string
        readOnly:
          description: ReadOnly
          type: boolean
          nullable: true
        readOnlyReason:
          description: ReadOnlyReason
          type: string
        slug:
          description: Slug
          type: string
        sortOrder:
          description: SortOrder
          type: integer
          format: int32
          nullable: true
        type:
          $ref: '#/components/schemas/SecretFieldType'
        value:
          description: Value
          type: string
      type: object
    ConvertTemplateInfoModel:
      description: Define which secrets are being converted to what template type
      properties:
        destinationTemplateId:
          description: What secret template are you converting to
          type: integer
          format: int32
        secretIds:
          description: Which secret IDs are being converted
          items:
            type: integer
            format: int32
          type: array
      type: object
    SecretDetailLauncher:
      description: Launchers
      properties:
        hasProxyCredentials:
          description: HasProxyCredentials
          type: boolean
        imagePath:
          description: ImagePath
          type: string
        isRecorded:
          description: IsRecorded
          type: boolean
        name:
          description: Name
          type: string
        showLauncher:
          description: ShowLauncher
          type: boolean
        typeId:
          description: TypeId
          type: integer
          format: int32
      type: object
    SecretDetailExpirationUpdateModel:
      description: Data
      properties:
        expirationDate:
          $ref: '#/components/schemas/UpdateFieldValueOfOptionalDateTime'
        expirationDayInterval:
          $ref: '#/components/schemas/UpdateFieldValueOfOptionalInt32'
        expirationType:
          $ref: '#/components/schemas/UpdateFieldValueOfSecretDetailExpirationUpdateType'
      type: object
    SecretModelV2:
      description: Secret V2
      properties:
        accessRequestWorkflowMapId:
          description: Access Request Workflow Map Id
          type: integer
          format: int32
          nullable: true
        active:
          description: Whether the secret is active
          type: boolean
        allowOwnersUnrestrictedSshCommands:
          description: Allow Owners Unrestricted SSH Commands
          type: boolean
        autoChangeEnabled:
          description: Auto Change Enabled
          type: boolean
        autoChangeNextPassword:
          description: Auto Change Next Password
          type: string
        checkedOut:
          description: Whether the secret is currently checked out
          type: boolean
        checkOutChangePasswordEnabled:
          description: Check Out Change Password Enabled
          type: boolean
        checkOutEnabled:
          description: Whether secret checkout is enabled
          type: boolean
        checkOutIntervalMinutes:
          description: Checkout interval, in minutes
          type: integer
          format: int32
        checkOutMinutesRemaining:
          description: Minutes remaining in current checkout interval
          type: integer
          format: int32
        checkOutUserDisplayName:
          description: Name of user who has checked out the secret
          type: string
        checkOutUserId:
          description: ID of user who has checked out the secret
          type: integer
          format: int32
        doubleLockId:
          description: DoubleLock Id
          type: integer
          format: int32
        enableInheritPermissions:
          description: Enable Inherit Permissions
          type: boolean
        enableInheritSecretPolicy:
          description: Whether the secret policy is inherited from the containing folder
          type: boolean
        failedPasswordChangeAttempts:
          description: Number of failed password change attempts
          type: integer
          format: int32
        folderId:
          description: Containing folder ID
          type: integer
          format: int32
        id:
          description: Secret ID
          type: integer
          format: int32
        isDoubleLock:
          description: Whether double lock is enabled
          type: boolean
        isOutOfSync:
          description: Out of sync indicates that a Password is setup for autochange and has failed its last password change attempt or has exceeded the maximum RPC attempts
          type: boolean
        isRestricted:
          description: Whether the secret is restricted
          type: boolean
        items:
          description: Secret data fields
          items:
            $ref: '#/components/schemas/RestSecretItem'
          type: array
        jumpboxRouteId:
          description: Jumpbox Route Id
          type: string
          format: uuid
          nullable: true
        lastHeartBeatCheck:
          description: Time of last heartbeat check
          type: string
          format: date-time
          nullable: true
        lastHeartBeatStatus:
          $ref: '#/components/schemas/HeartbeatStatus'
        lastPasswordChangeAttempt:
          description: Time of most recent password change attempt
          type: string
          format: date-time
          nullable: true
        launcherConnectAsSecretId:
          description: LauncherConnectAsSecretId
          type: integer
          format: int32
          nullable: true
        name:
          description: Secret name
          type: string
        outOfSyncReason:
          description: Reason message if the secret is out of sync
          type: string
        passwordTypeWebScriptId:
          description: Password Type Web Script Id
          type: integer
          format: int32
        proxyEnabled:
          description: Proxy Enabled
          type: boolean
        requiresApprovalForAccess:
          description: Requires Approval For Access
          type: boolean
        requiresComment:
          description: Requires Comment
          type: boolean
        responseCodes:
          description: Response Codes
          items:
            type: string
          type: array
        restrictSshCommands:
          description: Restrict SSH Commands
          type: boolean
        secretPolicyId:
          description: Secret Policy Id
          type: integer
          format: int32
        secretTemplateId:
          description: Secret template ID
          type: integer
          format: int32
        secretTemplateName:
          description: Name of secret template
          type: string
        sessionRecordingEnabled:
          description: Whether session recording is enabled
          type: boolean
        siteId:
          description: Site Id
          type: integer
          format: int32
        webLauncherRequiresIncognitoMode:
          description: Web Launcher Requires Incognito Mode
          type: boolean
      type: object
    ViewTemplateFieldDropDownOption:
      description: DropDownOptions
      properties:
        fieldValue:
          description: FieldValue
          type: string
        id:
          description: Id
          type: integer
          format: int32
        text:
          description: Text
          type: string
      type: object
    SecretDetailSecurityCheckoutUpdateModel:
      description: Secret Security Checkout Update
      properties:
        checkOutChangePasswordEnabled:
          $ref: '#/components/schemas/UpdateFieldValueOfBoolean'
        checkOutEnabled:
          $ref: '#/components/schemas/UpdateFieldValueOfBoolean'
        checkOutIntervalMinutes:
          $ref: '#/components/schemas/UpdateFieldValueOfOptionalInt32'
      type: object
    PagingOfSecretAuditModel:
      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/SecretAuditModel'
          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
    SecretChangePasswordArgs:
      description: Secret password change options
      properties:
        comment:
          description: If the secret requires a comment to view or requires approval to view, a reason for accessing the secret must be provided.
          type: string
        doubleLockPassword:
          description: If the secret is DoubleLocked, this is the DoubleLock password needed to access the secret.
          type: string
        forceCheckIn:
          description: Force the secret to be checked in, even if checked out by someone else. The user must have the "Force Check In" permission.
          type: boolean
        includeInactive:
          description: If the secret is deactivated, this must be set to true in order to access the secret. The user must also have the "View Inactive Secrets" permission.
          type: boolean
        newPassword:
          description: New secret password.
          type: string
        noAutoCheckout:
          description: Don't check out the secret automatically.
          type: boolean
        sshKeyArgs:
          $ref: '#/components/schemas/RotateSshKeyArgs'
        ticketNumber:
          description: If the secret requires a comment to view or requires approval and a user must provide a help desk a ticket number, this is the ticket number to the help desk request.
          type: string
        ticketSystemId:
          description: If the secret requires a comment to view or requires approval and a user must provide a help desk a ticket number, this is the id of the help desk system configured in Secret Server that should be used to validate the ticket number.
          type: integer
          format: int32
          nullable: true
      type: object
    SecretSearchExtendedArgs:
      description: SecretSearchExtendedArgs
      properties:
        data:
          $ref: '#/components/schemas/SecretSearchExtendedData'
      type: object
    ExportSecretsResultModelV2:
      description: ExportSecretsResultModelV2
      properties:
        exportedSecretsFileText:
          description: Export File Text
          type: string
          format: binary
        fileType:
          $ref: '#/components/schemas/ExportFileType'
      type: object
    WidgetSecretModel:
      description: WidgetSecretModel[]
      properties:
        folderId:
          description: FolderId
          type: integer
          format: int32
        folderPath:
          description: FolderPath
          type: string
        id:
          description: Id
          type: integer
          format: int32
        secretName:
          description: SecretName
          type: string
      type: object
    SecretFieldListType:
      description: The type of list. Valid values are “None”, “Generic”, and “URL”.
      properties: {}
      type: string
      enum:
      - Generic
      - URL
      - None
    CategorizedListSummary:
      description: Query results
      properties:
        active:
          description: Whether or not the list is active
          type: boolean
        categorizedListId:
          description: List Id
          type: string
        description:
          description: Description of the list
          type: string
        name:
          description: Name of the list
          type: string
        numOptions:
          description: The number of options in the list
          type: integer
          format: int32
      type: object
    SecretsExportResultModel:
      description: SecretsExportResultModel
      properties:
        errors:
          description: Secret Export Errors
          items:
            $ref: '#/components/schemas/SecretExportErrorModel'
          type: array
        exportedSecretsFileText:
          description: Export File Text
          type: string
        fileType:
          $ref: '#/components/schemas/ExportFileType'
        secretsCount:
          description: Count of Exported Secrets
          type: integer
          format: int32
      type: object
    SecretDetailUpdateExpirationArgs:
      description: SecretDetailUpdateExpirationArgs
      properties:
        data:
          $ref: '#/components/schemas/SecretDetailExpirationUpdateModel'
      type: object
    SecretDetailScheduleModel:
      description: Secret Detail Autochange Schedule
      properties:
        changeEveryMonths:
          description: Change Every Months
          type: integer
          format: int32
          nullable: true
        changeEveryMonthsDayNumber:
          description: Change Every Months Day Number
          type: integer
          format: int32
          nullable: true
        changeEveryMonthsInstance:
          description: Change Every Months Instance
          type: string
        changeEveryMonthsInstanceTarget:
          description: Change Every MOnths Instance Target
          type: string
        days:
          description: Days
          type: integer
          format: int32
          nullable: true
        friday:
          description: Friday
          type: boolean
          nullable: true
        monday:
          description: Monday
          type: boolean
          nullable: true
        monthScheduleType:
          description: Month Schedule Type
          type: string
          nullable: true
        numberMonthlyDay:
          description: Number Monthly Day
          type: integer
          format: int32
          nullable: true
        onlyChangeIfExpired:
          description: Only Change If Expired
          type: boolean
          nullable: true
        saturday:
          description: Saturday
          type: boolean
          nullable: true
        scheduleType:
          description: Schedule Type
          type: string
          nullable: true
        startingOn:
          description: Starting On
          type: string
          format: date-time
          nullable: true
        sunday:
          description: Sunday
          type: boolean
          nullable: true
        thursday:
          description: Thursday
          type: boolean
          nullable: true
        tuesday:
          description: Tuesday
          type: boolean
          nullable: true
        wednesday:
          description: Wednesday
          type: boolean
          nullable: true
        weeks:
          description: Weeks
          type: integer
          format: int32
          nullable: true
      type: object
    ViewFieldValueOfInt32:
      description: OrganizationId
      properties:
        additionalLinks:
          description: AdditionalLinks
          items:
            $ref: '#/components/schemas/ViewFieldLink'
          type: array
        description:
          description: Description
          type: string
        fieldInputType:
          description: FieldInputType
          type: string
          nullable: true
        hasHistory:
          description: HasHistory
          type: boolean
          nullable: true
        helpLink:
          description: HelpLink
          type: string
        helpLinkText:
          description: HelpLinkText
          type: string
        hidden:
          description: Hidden
          type: boolean
          nullable: true
        hideOnView:
          description: HideOnView
          type: boolean
          nullable: true
        isRequired:
          description: IsRequired
          type: boolean
          nullable: true
        label:
          description: Label
          type: string
        maxLength:
          description: MaxLength
          type: integer
          format: int32
          nullable: true
        name:
          description: Name
          type: string
        placeholder:
          description: Placeholder
          type: string
        readOnly:
          description: ReadOnly
          type: boolean
          nullable: true
        readOnlyReason:
          description: ReadOnlyReason
          type: string
        sortOrder:
          description: SortOrder
          type: integer
          format: int32
          nullable: true
        value:
          description: Value
          type: integer
          format: int32
      type: object
    SecretDetailUpdateSecurityGeneralArgs:
      description: Secret General Information Update Message
      properties:
        data:
          $ref: '#/components/schemas/SecretDetailSecurityGeneralUpdateModel'
      type: object
    SecretSearchExtendedData:
      description: Data
      properties:
        secretIds:
          description: Pass an array of secret IDs to get back settings on these secrets for the current user
          items:
            type: integer
            format: int32
          type: array
      type: object
    SecretSshTerminalArgs:
      description: Arguments to load the SSH proxy credentials
      properties:
        secretId:
          description: Secret ID
          type: integer
          format: int32
      type: object
    SecretExportErrorModel:
      description: Secret Export Errors
      properties:
        errorMessage:
          description: Error Message
          type: string
        secretName:
          description: Secret Name
          type: string
      type: object
    UpdateTemplateFieldOfString:
      description: Update Secret Template Field
      properties:
        dirty:
          description: Whether or not the field is dirty.  If false, the field value will not be updated.  If true, the field value will be updated.
          type: boolean
        slug:
          description: Secret template slug name
          type: string
        value:
          description: Secret field vlaue
          type: string
      type: object
    ExportSecretJobStatus:
      description: Export Job Status
      properties: {}
      type: string
      enum:
      - Pending
      - Completed
      - Failed
    SecretDetailEmailUpdateModel:
      description: Secret Email User Settings
      properties:
        sendEmailWhenChanged:
          $ref: '#/components/schemas/UpdateFieldValueOfBoolean'
        sendEmailWhenHeartbeatFails:
          $ref: '#/components/schemas/UpdateFieldValueOfBoolean'
        sendEmailWhenViewed:
          $ref: '#/components/schemas/UpdateFieldValueOfBoolean'
      type: object
    SecretDetailUpdateSecurityMultifactorArgs:
      description: Secret Security Multifactor Authentication Options
      properties:
        data:
          $ref: '#/components/schemas/SecretDetailSecurityMultifactorUpdateModel'
      type: object
    CategorizedListItemValueResult:
      description: CategorizedListItemValueResult
      properties:
        value:
          description: Value
          items:
            $ref: '#/components/schemas/ICategorizedListItemValue'
          type: array
      type: object
    SecretDetailExpirationUpdateType:
      description: Value
      properties: {}
      type: string
      enum:
      - Template
      - DayInterval
      - SpecificDate
    ViewFieldValueOfOptionalInt32:
      description: Maximum number of messages to keep in log. When null, it is unlimited
      properties:
        additionalLinks:
          description: AdditionalLinks
          items:
            $ref: '#/components/schemas/ViewFieldLink'
          type: array
        description:
          description: Description
          type: string
        fieldInputType:
          description: FieldInputType
          type: string
          nullable: true
        hasHistory:
          description: HasHistory
          type: boolean
          nullable: true
        helpLink:
          description: HelpLink
          type: string
        helpLinkText:
          description: HelpLinkText
          type: string
        hidden:
          description: Hidden
          type: boolean
          nullable: true
        hideOnView:
          description: HideOnView
          type: boolean
          nullable: true
        isRequired:
          description: IsRequired
          type: boolean
          nullable: true
        label:
          description: Label
          type: string
        maxLength:
          description: MaxLength
          type: integer
          format: int32
          nullable: true
        name:
          description: Name
          type: string
        placeholder:
          description: Placeholder
          type: string
        readOnly:
          description: ReadOnly
          type: boolean
          nullable: true
        readOnlyReason:
          description: ReadOnlyReason
          type: string
        sortOrder:
          description: SortOrder
          type: integer
          format: int32
          nullable: true
        value:
          description: Value
          type: integer
          format: int32
          nullable: true
      type: object
    SecretCheckOutExtensionModel:
      description: Secret Check Out Extension Model
      properties:
        minutesToAdd:
          description: Extend Check Out To This Duration
          type: integer
          format: int32
          nullable: true
        notes:
          description: Notes To Add To Audit
          type: string
      type: object
    YesNoPreferenceOption:
      description: Allow Clipboard
      properties: {}
      type: string
      enum:
      - 'No'
      - 'Yes'
      - UsePreferenceNo
      - UsePreferenceYes
    ConvertTemplateActionModel:
      description: Secret template conversion model
      properties:
        fieldMapping:
          description: Which source fields should map to which destination fields
          items:
            $ref: '#/components/schemas/ConvertTemplateFieldModel'
          type: array
        folderId:
          description: The target folder ID
          type: integer
          format: int32
          nullable: true
        isBulk:
          description: Whether or not this is a bulk operation or a single secret
          type: boolean
        newSecretName:
          description: The new name for the secret
          type: string
        secretIds:
          description: A list of Secret IDs that will be converted
          items:
            type: integer
            format: int32
          type: array
        secretTemplateId:
          description: The new secret template ID that will be applied to all secrets
          type: integer
          format: int32
      type: object
    SecretDetailConvertTemplateInfoArgs:
      description: Get information used to convert a secret to a different template
      properties:
        data:
          $ref: '#/components/schemas/ConvertTemplateInfoModel'
      type: object
    SecretDetailSecurityModel:
      description: Secret Detail Security
      properties:
        allowOwnersUnrestrictedSshCommands:
          description: Allow Owners Unrestricted SSH Commands
          type: boolean
        approvalWorkflow:
          $ref: '#/components/schemas/WorkflowTemplate'
        approvers:
          description: Approvers
          items:
            $ref: '#/components/schemas/SecretDetailUserViewModel'
          type: array
        checkOutChangePasswordEnabled:
          description: Check Out Change Password Enabled
          type: boolean
        checkOutDefaultIntervalDisplay:
          description: Check Out Default Interval Display
          type: string
        checkOutEnabled:
          description: Whether secret checkout is enabled
          type: boolean
        checkOutIntervalDisplay:
          description: Check Out Interval Display
          type: string
        checkOutIntervalMinutes:
          description: Checkout interval, in minutes
          type: integer
          format: int32
          nullable: true
        commandRestrictionType:
          $ref: '#/components/schemas/CommandRestrictionType'
        doubleLockId:
          description: DoubleLock Id
          type: integer
          format: int32
        doubleLockName:
          description: DoubleLock Name
          type: string
        hideLauncherPassword:
          description: Hide Launcher Password
          type: boolean
        isDoubleLock:
          description: Whether double lock is enabled
          type: boolean
        isMultiFactorAuthenticationRequired:
          description: Whether secret access requires Multifactor authentication
          type: boolean
        passwordRequirements:
          $ref: '#/components/schemas/SecretDetailSecurityPasswordRequirements'
        proxyEnabled:
          description: Proxy Enabled
          type: boolean
        requireApprovalType:
          $ref: '#/components/schemas/SecretDetailApprovalType'
        requiresComment:
          description: Requires Comment
          type: boolean
        restrictedSshCommandCount:
          description: Restricted SSH Command Count
          type: integer
          format: int32
        restrictSshCommands:
          description: Restrict SSH Commands
          type: boolean
        sessionRecordingEnabled:
          description: Whether session recording is enabled
          type: boolean
        shouldDisplayMultifactorAuthenticationDisasterRecoveryWarning:
          description: Whether additional messaging about the interaction between multifactor authentication and Disaster Recovery should be displayed
          type: boolean
      type: object
    ICategorizedListItemValue:
      description: The restricted hosts.
      properties:
        category:
          description: Category
          type: string
        value:
          description: Value
          type: string
      type: object
    SecretProxyArgs:
      description: Arguments to load the proxy credentials
      properties:
        launcherType:
          description: The type of the launcher to proxy
          type: integer
          format: int32
        machine:
          description: The machine name
          type: string
        secretId:
          description: Secret ID
          type: integer
          format: int32
        siteId:
          description: The site ID to use (RDP proxy only)
          type: integer
          format: int32
          nullable: true
      type: object
    SessionActions:
      description: Action To Take
      properties: {}
      type: string
      enum:
      - Terminate
      - LimitSession
      - MessageOnly
    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
    SecretDetailSecurityPasswordRequirements:
      description: PasswordRequirements
      properties:
        requirements:
          description: Requirements
          items:
            $ref: '#/components/schemas/SecretDetailSecurityPasswordRequirement'
          type: array
        validateOnCreate:
          description: ValidateOnCreate
          type: boolean
        validateOnEdit:
          description: ValidateOnEdit
          type: boolean
      type: object
    SecretDetailHeartbeatStatus:
      description: Current status of heartbeat
      properties: {}
      type: string
      enum:
      - Failed
      - Success
      - Pending
      - Disabled
      - UnableToConnect
      - UnknownError
      - IncompatibleHost
      - AccountLockedOut
      - DnsMismatch
      - UnableToValidateServerPublicKey
      - Processing
      - ArgumentError
      - AccessDenied
      - NeedsImmediateRetry
    SecretDetailApprovalType:
      description: Secret Security Approval Type
      properties: {}
      type: string
      enum:
      - None
      - RequireApproval
      - RequireEditorsApproval
      - RequireEveryoneApproval
    ViewFieldValueOfSecretDetailHeartbeatStatus:
      description: Current status of heartbeat
      properties:
        additionalLinks:
          description: AdditionalLinks
          items:
            $ref: '#/components/schemas/ViewFieldLink'
          type: array
        description:
          description: Description
          type: string
        fieldInputType:
          description: FieldInputType
          type: string
          nullable: true
        hasHistory:
          description: HasHistory
          type: boolean
          nullable: true
        helpLink:
          description: HelpLink
          type: string
        helpLinkText:
          description: HelpLinkText
          type: string
        hidden:
          description: Hidden
          type: boolean
          nullable: true
        hideOnView:
          description: HideOnView
          type: boolean
          nullable: true
        isRequired:
          description: IsRequired
          type: boolean
          nullable: true
        label:
          description: Label
          type: string
        maxLength:
          description: MaxLength
          type: integer
          format: int32
          nullable: true
        name:
          description: Name
          type: string
        placeholder:
          description: Placeholder
          type: string
        readOnly:
          description: ReadOnly
          type: boolean
          nullable: true
        readOnlyReason:
          description: ReadOnlyReason
          type: string
        sortOrder:
          description: SortOrder
          type: integer
          format: int32
          nullable: true
        value:
          $ref: '#/components/schemas/SecretDetailHeartbeatStatus'
      type: object
    SecretDetailRestrictedSshCommandBlocklistPermissionUpdateModel:
      description: Secret Detail SSH Command Blocklist Permission Update Model
      properties:
        rolePermissionId:
          description: "Role Permission Id (10064\tView, 10065\tEdit, 10066\tOwner)"
          type: integer
          format: int32
        sshCommandBlocklistId:
          description: SSH Command Blocklist Id
          type: string
          format: uuid
          nullable: true
      type: object
    ISecretSummaryExtendedField:
      description: Any requested extended fields from a lookup request
      properties:
        name:
          description: Name
          type: string
        value:
          description: Value
          type: string
      type: object
    SecretCheckOutExtensionArgs:
      description: Secret Check Out Extension Args
      properties:
        data:
          $ref: '#/components/schemas/SecretCheckOutExtensionModel'
      type: object
    ExportFileType:
      description: Export Job File Type
      properties: {}
      type: string
      enum:
      - Csv
      - Xml
      - Json
    ViewFieldValueReadOnlyOfString:
      description: Name of the Secret.
      properties:
        additionalLinks:
          description: AdditionalLinks
          items:
            $ref: '#/components/schemas/ViewFieldLink'
          type: array
        description:
          description: Description
          type: string
        fieldInputType:
          description: FieldInputType
          type: string
          nullable: true
        hasHistory:
          description: HasHistory
          type: boolean
          nullable: true
        helpLink:
          description: HelpLink
          type: string
        helpLinkText:
          description: HelpLinkText
          type: string
        hidden:
          description: Hidden
          type: boolean
          nullable: true
        hideOnView:
          description: HideOnView
          type: boolean
          nullable: true
        isRequired:
          description: IsRequired
          type: boolean
          nullable: true
        label:
          description: Label
          type: string
        maxLength:
          description: MaxLength
          type: integer
          format: int32
          nullable: true
        name:
          description: Name
          type: string
        placeholder:
          description: Placeholder
          type: string
        readOnly:
          description: ReadOnly
          type: boolean
          nullable: true
        readOnlyReason:
          description: ReadOnlyReason
          type: string
        sortOrder:
          description: SortOrder
          type: integer
          format: int32
          nullable: true
        value:
          description: Value
          type: string
      type: object
    SecretDetailSecurityApprovalUpdateModel:
      description: Secret Security Approval Update
      properties:
        approvers:
          $ref: '#/components/schemas/UpdateFieldValueOfInt32Array'
        requireApprovalType:
          $ref: '#/components/schemas/UpdateFieldValueOfOptionalSecretDetailApprovalType'
        workflowTemplateId:
          $ref: '#/components/schemas/UpdateFieldValueOfInt32'
      type: object
    UpdateFieldValueOfOptionalBoolean:
      description: Use RADIUS Username for DUO
      properties:
        dirty:
          description: Dirty
          type: boolean
        value:
          description: Value
          type: boolean
          nullable: true
      type: object
    PasswordChangeResult:
      description: Status
      properties: {}
      type: string
      enum:
      - None
      - Pending
      - Success
      - Fail
    SecretLookup:
      description: Simple secret representation
      properties:
        id:
          description: Secret ID
          type: integer
          format: int32
        value:
          description: Secret name
          type: string
      type: object
    SecretDetailRestrictedSshCommandMenuPermissionUpdateModel:
      description: Secret Detail SSH Command Menu Permission Update Model
      properties:
        groupId:
          description: Group Id
          type: integer
          format: int32
        sshCommandMenuId:
          description: SSH Command Menu Id
          type: integer
          format: int32
          nullable: true
      type: object
    UpdateFieldValueOfSecretDetailExpirationUpdateType:
      description: ExpirationType
      properties:
        dirty:
          description: Dirty
          type: boolean
        value:
          $ref: '#/components/schemas/SecretDetailExpirationUpdateType'
      type: object
    RestSecretItem:
      description: Secret data field item
      properties:
        fieldDescription:
          description: Longer description of the secret field.
          type: string
        fieldId:
          description: The id of the field definition from the secret template.
          type: integer
          format: int32
          nullable: true
        fieldName:
          description: The display name of the secret field.
          type: string
        fileAttachmentId:
          description: If the field is a file attachment field, the id of the file attachment.
          type: integer
          format: int32
          nullable: true
        filename:
          description: If the field is a file attachment field, the name of the attached file.
          type: string
        isFile:
          description: Whether the field is a file attachment.
          type: boolean
        isList:
          description: Whether or not the secret field is a list.
          type: boolean
        isNotes:
          description: Whether the field is represented as a multi-line text box. Used for long-form text fields.
          type: boolean
        isPassword:
          description: Whether the field is a password. Password fields are hidden by default in the UI and their value is not returned in GET calls that return secrets. To retrieve a password field value, make a GET call to /api/secrets/{secretId}/fields/{slug}.
          type: boolean
        itemId:
          description: The id of the secret field item. Leave empty when creating a new secret.
          type: integer
          format: int32
          nullable: true
        itemValue:
          description: The value of the secret field item. For list fields, this is a comma-delimited list of the list id guids that are assigned to this field.
          type: string
        listType:
          $ref: '#/components/schemas/SecretFieldListType'
        slug:
          description: A unique name for the secret field on the template. Slugs cannot contain spaces and are used in many places to easily refer to a secret field without having to know the field id.
          type: string
      type: object
    SecretDetailUserViewModel:
      description: Value
      properties:
        displayName:
          description: DisplayName
          type: string
        groupId:
          description: GroupId
          type: integer
          format: int32
        isGroup:
          description: IsGroup
          type: boolean
      type: object
    SecretTransitionHistorySummaryModel:
      description: Query results
      properties:
        dateRecorded:
          description: DateRecorded
          type: string
          format: date-time
        itemValue:
          description: ItemValue
          type: string
      type: object
    SecretDetailSecurityPasswordRequirement:
      description: Requirements
      properties:
        fieldDisplayName:
          description: FieldDisplayName
          type: string
        fieldName:
          description: FieldName
          type: string
        isCustom:
          description: IsCustom
          type: boolean
        passwordRequirementId:
          description: PasswordRequirementId
          type: integer
          format: int32
        passwordRequirementName:
          description: PasswordRequirementName
          type: string
      type: object
    WorkflowTemplate:
      description: Value
      properties:
        active:
          description: Active
          type: boolean
        configurationJson:
          description: ConfigurationJson
          type: string
        description:
          description: Description
          type: string
        expirationMinutes:
          description: ExpirationMinutes
          type: integer
          format: int32
          nullable: true
        name:
          description: Name
          type: string
        reusable:
          description: Reusable
          type: boolean
        typeName:
          description: TypeName
          type: string
        workflowTemplateId:
          description: WorkflowTemplateId
          type: integer
          format: int32
        workflowType:
          $ref: '#/components/schemas/WorkflowType'
      type: object
    RotateSshKeyArgs:
      description: SSH key rotation options
      properties:
        generatePassphrase:
          description: Whether to generate the next SSH private key passphrase. Must be true if the passphrase is empty.
          type: boolean
        generateSshKeys:
          description: Whether to generate the next SSH private key. Must be true if the private key is empty.
          type: boolean
        passphrase:
          description: Private key passphrase
          type: string
        privateKey:
          description: Private key
          type: string
      type: object
    DashboardViewSecret:
      description: DashboardViewSecret
      properties:
        errorMessage:
          description: errorMessage
          type: string
        favorite:
          description: favorite
          type: boolean
        hasLauncher:
          description: hasLauncher
          type: boolean
        id:
          description: id
          type: integer
          format: int32
        isTotpEnabled:
          description: isTotpEnabled
          type: boolean
        items:
          description: items
          items:
            $ref: '#/components/schemas/DashboardViewSecretItem'
          type: array
        launchers:
          description: launchers
          items:
            $ref: '#/components/schemas/DashboardViewLauncherInfo'
          type: array
        secretName:
          description: secretName
          type: string
        showViewButton:
          description: showViewButton
          type: boolean
        userCanEdit:
          description: userCanEdit
          type: boolean
        userCanShare:
          description: userCanShare
          type: boolean
        userCanViewAudit:
          description: userCanViewAudit
          type: boolean
        usesClickOnce:
          description: usesClickOnce
          type: boolean
      type: object
    SecretSummary:
      description: Secret summary
      properties:
        active:
          description: Whether the secret is active
          type: boolean
        autoChangeEnabled:
          description: Indicates whether or not this Secret an auto changing password
          type: boolean
          nullable: true
        checkedOut:
          description: Whether the secret is currently checked out
          type: boolean
        checkOutEnabled:
          description: Indicates whether or not checkout is enabled for the Secret
          type: boolean
          nullable: true
        checkOutUserId:
          description: Id of the User that has the secret checked out if it is checked out
          type: integer
          format: int32
        checkOutUserName:
          description: The name of the User that has the secret checked out if it is checked out
          type: string
        createDate:
          description: When the Secret was created
          type: string
          format: date-time
          nullable: true
        daysUntilExpiration:
          description: How many days until this Secret expires
          type: integer
          format: int32
          nullable: true
        doubleLockEnabled:
          description: Indicates whether or not DoubleLock is enabled for this password
          type: boolean
          nullable: true
        extendedFields:
          description: Any requested extended fields from a lookup request
          items:
            $ref: '#/components/schemas/ISecretSummaryExtendedField'
          type: array
        folderId:
          description: Containing folder ID
          type: integer
          format: int32
        folderPath:
          description: Containing folder path
          type: string
        hasLauncher:
          description: Indicates if this Secret has any launchers
          type: boolean
        hidePassword:
          description: Indicates if the launcher password is set to be hidden
          type: boolean
          nullable: true
        id:
          description: Secret ID
          type: integer
          format: int32
        inheritsPermissions:
          description: Indicates if this Secret inherits permissions from its folder
          type: boolean
          nullable: true
        isOutOfSync:
          description: Indicates that Heartbeat has failed or a Password is set up for autochange and has failed its last password change attempt or has exceeded the maximum RPC attempts
          type: boolean
        isRestricted:
          description: Whether the secret is restricted
          type: boolean
        lastAccessed:
          description: When the Secret was last viewed by the current User
          type: string
          format: date-time
          nullable: true
        lastHeartBeatStatus:
          $ref: '#/components/schemas/HeartbeatStatus'
        lastPasswordChangeAttempt:
          description: Time of most recent password change attempt
          type: string
          format: date-time
          nullable: true
        name:
          description: Secret name
          type: string
        outOfSyncReason:
          description: Reason message if the secret is out of sync
          type: string
        requiresApproval:
          description: Indicates if this Secret requires approval
          type: boolean
          nullable: true
        requiresComment:
          description: Indicates if this Secret requires comment
          type: boolean
          nullable: true
        responseCodes:
          description: ResponseCodes
          items:
            type: string
          type: array
        secretTemplateId:
          description: Secret template ID
          type: integer
          format: int32
        secretTemplateName:
          description: Name of secret template
          type: string
        siteId:
          description: SiteId
          type: integer
          format: int32
      type: object
    SecretDetailConvertTemplateModel:
      description: SecretDetailConvertTemplateModel
      properties:
        secretId:
          description: SecretId
          type: integer
          format: int32
          nullable: true
        taskId:
          description: TaskId
          type: string
      type: object
    SecretDetailUpdateEmailArgs:
      description: Secret User Email Update Message
      properties:
        data:
          $ref: '#/components/schemas/SecretDetailEmailUpdateModel'
      type: object
    SecretDetailRpcSecrets:
      description: Reset Secrets
      properties:
        folderName:
          description: FolderName
          type: string
        order:
          description: Order
          type: integer
          format: int32
        secretId:
          description: SecretId
          type: integer
          format: int32
        secretName:
          description: SecretName
          type: string
        secretTemplateName:
          description: SecretTemplateName
          type: string
      type: object
    ViewFieldValueOfSecretDetailUserViewModelArray:
      description: Approvers
      properties:
        additionalLinks:
          description: AdditionalLinks
          items:
            $ref: '#/components/schemas/ViewFieldLink'
          type: array
        description:
          description: Description
          type: string
        fieldInputType:
          description: FieldInputType
          type: string
          nullable: true
        hasHistory:
          description: HasHistory
          type: boolean
          nullable: true
        helpLink:
          description: HelpLink
          type: string
        helpLinkText:
          description: HelpLinkText
          type: string
        hidden:
          description: Hidden
          type: boolean
          nullable: true
        hideOnView:
          description: HideOnView
          type: boolean
          nullable: true
        isRequired:
          description: IsRequired
          type: boolean
          nullable: true
        label:
          description: Label
          type: string
        maxLength:
          description: MaxLength
          type: integer
          format: int32
          nullable: true
        name:
          description: Name
          type: string
        placeholder:
          description: Placeholder
          type: string
        readOnly:
          description: ReadOnly
          type: boolean
          nullable: true
        readOnlyReason:
          description: ReadOnlyReason
          type: string
        sortOrder:
          description: SortOrder
          type: integer
          format: int32
          nullable: true
        value:
          description: Value
          items:
            $ref: '#/components/schemas/SecretDetailUserViewModel'
          type: array
      type: object
    RdpLauncherSettingsModel:
      description: RDP Launcher Settings
      properties:
        allowClipboard:
          $ref: '#/components/schemas/YesNoPreferenceOption'
        allowDrives:
          $ref: '#/components/schemas/YesNoPreferenceOption'
        allowPrinters:
          $ref: '#/components/schemas/YesNoPreferenceOption'
        allowSmartCards:
          $ref: '#/components/schemas/YesNoPreferenceOption'
        connectToConsole:
          $ref: '#/components/schemas/YesNoPreferenceOption'
        launcherHeight:
          description: Launcher Height
          type: integer
          format: int32
          nullable: true
        launcherWidth:
          description: Launcher Height
          type: integer
          format: int32
          nullable: true
        useCustomLauncherResolution:
          $ref: '#/components/schemas/YesNoPreferenceOption'
      type: object
    SecretAccessRequired:
      description: Secret Access Required
      properties: {}
      type: string
      enum:
      - None
      - RequiresApproval
      - RequiresCheckout
      - RequiresComment
      - RequiresDoubleLockPassword
      - CreateDoubleLockPassword
      - DoubleLockNoAccess
      - CannotView
      - RequiresUndelete
      - RequiresCheckoutPendingRPC
      - RequiresCheckoutAndComment
      - RequiresMfaChallenge
    PagingOfSecretLookup:
      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/SecretLookup'
          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
    ViewFieldValueOfSecretDetailApprovalTypeArray:
      description: AvailableRequireApprovalTypes
      properties:
        additionalLinks:
          description: AdditionalLinks
          items:
            $ref: '#/components/schemas/ViewFieldLink'
          type: array
        description:
          description: Description
          type: string
        fieldInputType:
          description: FieldInputType
          type: string
          nullable: true
        hasHistory:
          description: HasHistory
          type: boolean
          nullable: true
        helpLink:
          description: HelpLink
          type: string
        helpLinkText:
          description: HelpLinkText
          type: string
        hidden:
          description: Hidden
          type: boolean
          nullable: true
        hideOnView:
          description: HideOnView
          type: boolean
          nullable: true
        isRequired:
          description: IsRequired
          type: boolean
          nullable: true
        label:
          description: Label
          type: string
        maxLength:
          description: MaxLength
          type: integer
          format: int32
          nullable: true
        name:
          description: Name
          type: string
        placeholder:
          description: Placeholder
          type: string
        readOnly:
          description: ReadOnly
          type: boolean
          nullable: true
        readOnlyReason:
          description: ReadOnlyReason
          type: string
        sortOrder:
          description: SortOrder
          type: integer
          format: int32
          nullable: true
        value:
          description: Value
          items:
            $ref: '#/components/schemas/SecretDetailApprovalType'
          type: array
      type: object
  requestBodies:
    SecretDetailUpdateEmailArgs:
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/SecretDetailUpdateEmailArgs'
      description: args
    ExportSecretsArgs:
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ExportSecretsArgs'
      description: args
    SecretRestrictedArgs:
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/SecretRestrictedArgs'
      description: Secret options
    SecretProxyArgs:
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/SecretProxyArgs'
      description: args
    SecretDetailUpdateSecurityGeneralArgs:
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/SecretDetailUpdateSecurityGeneralArgs'
      description: args
    SecretDetailUpdateGeneralArgs:
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/SecretDetailUpdateGeneralArgs'
      description: args
    SecretDetailUpdateRpcScriptSecretsArgs:
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/SecretDetailUpdateRpcScriptSecretsArgs'
      description: args
  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