Delinea Configuration API

openapi: 3.0.0
info:
  title: Secret Server Rest Activations Configuration 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: Configuration
  description: Secret Server Configuration
paths:
  /v1/configuration/saml/identity-provider/{id}:
    get:
      tags:
      - Configuration
      summary: Get Saml Identity Provider configuration
      description: Get Saml Identity Provider Configuration
      operationId: ConfigurationService_GetSamlIdentityProviderConfiguration
      parameters:
      - name: id
        in: path
        description: Saml Identity Provider Id
        required: true
        schema:
          type: integer
          format: int32
      responses:
        '200':
          description: Saml Identity Provider configuration
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConfigurationSamlIdentityProviderModel'
        '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:
      - Configuration
      summary: Delete Saml Configuration Identity Provider
      description: Delete Saml Configuration Identity Provider
      operationId: ConfigurationService_DeleteSamlConfigurationIdentityProvider
      parameters:
      - name: id
        in: path
        description: id
        required: true
        schema:
          type: integer
          format: int32
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConfigurationSamlIdentityProviderDeleteResultModel'
        '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/configuration/state:
    get:
      tags:
      - Configuration
      summary: The allowed permissions for configuration for the current user
      description: The allowed permissions for configuration for the current user
      operationId: ConfigurationService_GetConfigurationState
      responses:
        '200':
          description: The allowed configuration for the current user
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConfigurationStateModel'
        '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/configuration/audit:
    get:
      tags:
      - Configuration
      summary: Audit of system configuration changes
      description: Audit of system configuration changes
      operationId: ConfigurationService_GetConfigurationAudit
      parameters:
      - name: isExporting
        in: query
        description: isExporting
        required: false
        schema:
          type: boolean
      - name: filter.searchTerm
        in: query
        description: SearchTerm
        required: false
        schema:
          type: string
      - name: skip
        in: query
        description: Number of records to skip before taking results
        required: false
        schema:
          type: integer
          format: int32
      - name: sortBy[0].direction
        in: query
        description: Sort direction
        required: false
        schema:
          type: string
      - name: sortBy[0].name
        in: query
        description: Sort field name
        required: false
        schema:
          type: string
      - name: sortBy[0].priority
        in: query
        description: Priority index. Sorts with lower values are executed earlier
        required: false
        schema:
          type: integer
          format: int32
      - name: take
        in: query
        description: Maximum number of records to include in results
        required: false
        schema:
          type: integer
          format: int32
      responses:
        '200':
          description: Configuration audit items
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PagingOfConfigurationAuditItem'
        '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/configuration/general:
    get:
      tags:
      - Configuration
      summary: Get the general configuration
      description: Get configuration
      operationId: ConfigurationService_GetGeneralConfigurationV3
      parameters:
      - name: loadAll
        in: query
        description: Load all configuration sections
        required: false
        schema:
          type: boolean
      - name: loadApplicationSettings
        in: query
        description: Load application settings section
        required: false
        schema:
          type: boolean
      - name: loadEmail
        in: query
        description: Load email section
        required: false
        schema:
          type: boolean
      - name: loadFolders
        in: query
        description: Load folder configuration section
        required: false
        schema:
          type: boolean
      - name: loadLauncherSettings
        in: query
        description: Load launcher settings section
        required: false
        schema:
          type: boolean
      - name: loadLocalUserPasswords
        in: query
        description: Load local user passwords section
        required: false
        schema:
          type: boolean
      - name: loadLogin
        in: query
        description: Load log in section
        required: false
        schema:
          type: boolean
      - name: loadPermissionOptions
        in: query
        description: Load permission options configuration section
        required: false
        schema:
          type: boolean
      - name: loadProtocolHandlerSettings
        in: query
        description: Load security protocol hander section
        required: false
        schema:
          type: boolean
      - name: loadSecurity
        in: query
        description: Load security section
        required: false
        schema:
          type: boolean
      - name: loadSessionRecording
        in: query
        description: Load the session recording section
        required: false
        schema:
          type: boolean
      - name: loadUnlimitedAdmin
        in: query
        description: Load unlimited admin section
        required: false
        schema:
          type: boolean
      - name: loadUserExperience
        in: query
        description: Load user experience configuration section
        required: false
        schema:
          type: boolean
      - name: loadUserInterface
        in: query
        description: Load user interface section
        required: false
        schema:
          type: boolean
      responses:
        '200':
          description: Configuration
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConfigurationGeneralModelV3'
        '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/configuration/settings-menu:
    get:
      tags:
      - Configuration
      summary: Get settings menu
      description: Get settings needed to build the admin settings menu
      operationId: ConfigurationService_GetSettingsMenu
      responses:
        '200':
          description: Settings menu options
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SettingsMenuModel'
        '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/configuration/local-user-passwords:
    get:
      tags:
      - Configuration
      summary: Get the local user password configuration
      description: Get the local user password configuration.  Password requirements only require an authenticated user.  Extended fields will be null unless you have the View / Administer Configuration role permission.
      operationId: ConfigurationService_GetLocalPasswordConfiguration
      responses:
        '200':
          description: Local User Password Configuration Settings
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConfigurationLocalUserPasswordsModel'
        '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:
      - Configuration
      summary: Update the local user password configuration
      description: Update the local user password configuration
      operationId: ConfigurationService_PatchLocalPasswordConfiguration
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ConfigurationLocalPasswordPatchArgs'
        description: Local user password update args
      responses:
        '200':
          description: Local User Password Configuration Settings
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConfigurationLocalUserPasswordsModel'
        '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/configuration/security:
    get:
      tags:
      - Configuration
      summary: Get Security configuration
      description: Get Security Configuration
      operationId: ConfigurationService_GetSecurityConfiguration
      responses:
        '200':
          description: Security Configuration
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConfigurationSecurityModel'
        '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:
      - Configuration
      summary: Update Security configuration
      description: Update Security Configuration
      operationId: ConfigurationService_PatchSecurityConfiguration
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ConfigurationSecurityPatchArgs'
        description: Security update args
      responses:
        '200':
          description: Security configuration after updates
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConfigurationSecurityModel'
        '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/configuration/login:
    get:
      tags:
      - Configuration
      summary: Get Login configuration
      description: Get Login Configuration
      operationId: ConfigurationService_GetLoginConfigurationV2
      responses:
        '200':
          description: Login Configuration
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConfigurationLoginV2Model'
        '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:
      - Configuration
      summary: Update Login configuration
      description: Update Login Configuration
      operationId: ConfigurationService_PatchLoginConfigurationV2
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ConfigurationLoginV2PatchArgs'
        description: Login update args
      responses:
        '200':
          description: Login configuration after updates
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConfigurationLoginV2Model'
        '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/configuration/login-policy:
    get:
      tags:
      - Configuration
      summary: Get Login Policy configuration
      description: Get Login Policy Configuration
      operationId: ConfigurationService_GetLoginPolicyConfiguration
      responses:
        '200':
          description: Login Policy Configuration
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConfigurationLoginPolicyModel'
        '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:
      - Configuration
      summary: Update Login Policy configuration
      description: Update Login Policy Configuration
      operationId: ConfigurationService_PatchLoginPolicyConfiguration
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ConfigurationLoginPolicyPatchArgs'
        description: Login Policy update args
      responses:
        '200':
          description: Login Policy configuration after updates
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConfigurationLoginPolicyModel'
        '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/configuration/saml:
    get:
      tags:
      - Configuration
      summary: Get Saml configuration
      description: Get Saml Configuration
      operationId: ConfigurationService_GetSamlConfiguration
      responses:
        '200':
          description: Saml Configuration
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConfigurationSamlModel'
        '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:
      - Configuration
      summary: Update Saml configuration
      description: Update Saml Configuration
      operationId: ConfigurationService_PatchSamlConfiguration
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ConfigurationSamlPatchArgs'
        description: Saml update args
      responses:
        '200':
          description: Saml configuration after updates
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConfigurationSamlModel'
        '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/configuration/folder-synchronization:
    get:
      tags:
      - Configuration
      summary: Get folder synchronization configuration
      description: Get the settings for how folders are synchronized with an external system
      operationId: ConfigurationService_GetFolderSyncConfiguration
      responses:
        '200':
          description: Folder synchronization configuration
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FolderSynchronizationModel'
        '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:
      - Configuration
      summary: Update folder synchronization configuration
      description: Update the settings for how folders are synchronized with an external system
      operationId: ConfigurationService_PatchFolderSyncConfiguration
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/FolderSynchronizationUpdateArgs'
        description: Saml update args
      responses:
        '200':
          description: Folder synchronization configuration after updates
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FolderSynchronizationModel'
        '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/configuration/saml/identity-provider/stub:
    get:
      tags:
      - Configuration
      summary: Get Saml Identity Provider configuration stub
      description: Get Saml Identity Provider Configuration stub
      operationId: ConfigurationService_GetSamlIdentityProviderConfigurationStub
      responses:
        '200':
          description: Saml Identity Provider configuration
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConfigurationSamlIdentityProviderModel'
        '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/configuration/rpc:
    get:
      tags:
      - Configuration
      summary: Get RPC configuration
      description: Get Remote Password Configuration
      operationId: ConfigurationService_GetRpcConfiguration
      responses:
        '200':
          description: RPC Configuration
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConfigurationRpcModel'
        '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:
      - Configuration
      summary: Update RPC configuration
      description: Update Remote Password Configuration
      operationId: ConfigurationService_PatchRpcConfiguration
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ConfigurationRpcPatchArgs'
        description: Local user password update args
      responses:
        '200':
          description: RPC configuration after updates
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConfigurationRpcModel'
        '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/configuration/sessionrecording-advanced:
    get:
      tags:
      - Configuration
      summary: Get Session Recording Advanced
      description: Get Session Recording Advanced Configuration
      operationId: ConfigurationService_GetSessionRecordingAdvancedConfiguration
      responses:
        '200':
          description: Session Recording Advanced Configuration
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConfigurationSessionRecordingAdvancedModel'
        '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:
      - Configuration
      summary: Update Session Recording Advanced
      description: Update Session Recording Advanced Configuration
      operationId: ConfigurationService_PatchSessionRecordingAdvancedConfiguration
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ConfigurationSessionRecordingAdvancedPatchArgs'
        description: Session recording advanced update args
      responses:
        '200':
          description: Session Recording Advanced Configuration
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConfigurationSessionRecordingAdvancedModel'
        '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/configuration/site-connector:
    get:
      tags:
      - Configuration
      summary: Site Connectors
      description: Site Connectors
      operationId: ConfigurationService_GetSiteConnectors
      parameters:
      - name: includeInactive
        in: query
        description: includeInactive
        required: false
        schema:
          type: boolean
      responses:
        '200':
          description: Site Connectors
          content:
            application/json:
              schema:
                description: Site Connectors
                items:
                  $ref: '#/components/schemas/SiteConnectorsSummaryModel'
                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/I

# --- truncated at 32 KB (293 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/delinea/refs/heads/main/openapi/delinea-configuration-api-openapi.yml