Delinea PasswordRequirements API

openapi: 3.2.0
info:
  title: Secret Server Rest Password Requirements 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 authentication document for more information. The Swagger specification 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: PasswordRequirements
  description: Password Requirements
paths:
  /v1/password-requirements:
    get:
      tags:
      - PasswordRequirements
      summary: Search Password Requirements
      description: Search, filter, sort, and page password requirements
      operationId: PasswordRequirementsService_SearchPasswordRequirements
      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
      responses:
        '200':
          description: Password requirements collection
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PagingOfPasswordRequirementsSummary'
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BadRequestResponse'
        '403':
          description: Authentication failed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AuthenticationFailedResponse'
        '500':
          description: Internal server error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServerErrorResponse'
      deprecated: false
    post:
      tags:
      - PasswordRequirements
      summary: Create Password Requirement
      operationId: PasswordRequirementsService_Create
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PasswordRequirementCreateArgs'
        description: args
      responses:
        '200':
          description: Password requirement
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PasswordRequirementModel'
        '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/password-requirements/{id}:
    get:
      tags:
      - PasswordRequirements
      summary: Get Password Requirement
      description: Get password requirements
      operationId: PasswordRequirementsService_Get
      parameters:
      - name: id
        in: path
        description: id
        required: true
        schema:
          type: integer
          format: int32
      responses:
        '200':
          description: Password requirement
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PasswordRequirementModel'
        '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:
      - PasswordRequirements
      summary: PatchPasswordRequirement
      description: Patch Password Requirement
      operationId: PasswordRequirementsService_Patch
      parameters:
      - name: id
        in: path
        description: id
        required: true
        schema:
          type: integer
          format: int32
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PasswordRequirementPatchArgs'
        description: args
      responses:
        '200':
          description: Password requirement
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PasswordRequirementModel'
        '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/password-requirements/{id}/audit:
    get:
      tags:
      - PasswordRequirements
      summary: Get Password Requirement Audits
      description: Get audits for a Password Requirement
      operationId: PasswordRequirementsService_GetAuditsAsync
      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: 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: Paged List of Password Requirement Audits
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PagingOfPasswordRequirementAuditModel'
        '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/password-requirements/{id}/rules:
    put:
      tags:
      - PasswordRequirements
      summary: Update Password Requirement Rules
      operationId: PasswordRequirementsService_UpdateRules
      parameters:
      - name: id
        in: path
        description: id
        required: true
        schema:
          type: integer
          format: int32
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PasswordRequirementRuleUpdateArgs'
        description: args
      responses:
        '200':
          description: Password requirement
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PasswordRequirementModel'
        '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:
    PagingOfPasswordRequirementAuditModel:
      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/PasswordRequirementAuditModel'
          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
    PagingOfPasswordRequirementsSummary:
      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/PasswordRequirementsSummary'
          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
    PasswordRequirementModel:
      description: Password Requirement Model
      properties:
        allowedCharacterSet:
          $ref: '#/components/schemas/CharacterSetSummary'
        description:
          description: Description
          type: string
        example:
          description: An example of the password
          type: string
        isDefault:
          description: Is Default
          type: boolean
        maxPasswordLength:
          description: Maximum Password Length
          type: integer
          format: int32
        minPasswordLength:
          description: Minimum Password Length
          type: integer
          format: int32
        name:
          description: Name
          type: string
        passwordDictionaries:
          description: Password Dictionaries
          items:
            $ref: '#/components/schemas/PasswordDictionarySummary'
          type: array
        passwordRequirementId:
          description: Password Requirement Id
          type: integer
          format: int32
        passwordRequirementRules:
          description: Password Requirement Rules
          items:
            $ref: '#/components/schemas/PasswordRequirementRuleSummary'
          type: array
        preventDictionaryWords:
          description: Prevent Dictionary Words
          type: boolean
        preventSequentialPattern:
          description: Prevent Sequential Pattern
          type: boolean
        preventSpatialPattern:
          description: Prevent Spacial Pattern
          type: boolean
        preventUsername:
          description: Prevent Username
          type: boolean
        secretUsage:
          description: A count of secrets using the requirement
          type: integer
          format: int32
        typeUsage:
          description: A list of secret templates using the password requirement
          items:
            type: string
          type: array
      type: object
    PasswordRequirementCreateArgs:
      description: Password Requirement Create Args
      properties:
        data:
          $ref: '#/components/schemas/PasswordRequirementCreateModel'
      type: object
    SortDirection:
      description: Sort direction
      properties: {}
      type: string
      enum:
      - None
      - Asc
      - Desc
    PasswordRequirementCreateModel:
      description: Password Requirement Create Model
      properties:
        allowedCharacterSetId:
          description: Allowed Character Set
          type: integer
          format: int32
        allowMinimumCharacterSets:
          description: Allow Minimum Character Sets
          type: boolean
        description:
          description: Description
          type: string
        isDefault:
          description: Is Default
          type:
          - boolean
          - 'null'
        maxPasswordLength:
          description: Maximum Password Length
          type: integer
          format: int32
        minimumRequiredCharacterSets:
          description: Minimum Required Character Sets
          type:
          - integer
          - 'null'
          format: int32
        minPasswordLength:
          description: Minimum Password Length
          type: integer
          format: int32
        name:
          description: Name
          type: string
        passwordRequirementRules:
          description: Password Requirement Rule Create Models
          items:
            $ref: '#/components/schemas/PasswordRequirementRuleCreateModel'
          type: array
        preventDictionaryWords:
          description: Prevent Dictionary Words
          type:
          - boolean
          - 'null'
        preventSequentialPattern:
          description: Prevent Sequential Pattern
          type:
          - boolean
          - 'null'
        preventSpatialPattern:
          description: Prevent Spacial Pattern
          type:
          - boolean
          - 'null'
        preventUsername:
          description: Prevent Username
          type:
          - boolean
          - 'null'
      type: object
    PasswordRequirementRuleUpdateModel:
      description: Password Requirement Rule Patch Model
      properties:
        characterSetId:
          description: Character Set
          type:
          - integer
          - 'null'
          format: int32
        minCharactersRequired:
          description: Minimum Characters Required
          type: integer
          format: int32
        passwordRequirementRuleId:
          description: Password Requirement Rule Id
          type: integer
          format: int32
        passwordRequirementType:
          $ref: '#/components/schemas/PasswordRequirementType'
      type: object
    PasswordRequirementsSummary:
      description: Query results
      properties:
        description:
          description: Description
          type: string
        isDefault:
          description: Is this the default password requirement
          type: boolean
        name:
          description: Name
          type: string
        passwordRequirementId:
          description: Unique ID for this Password Requirement
          type: integer
          format: int32
      type: object
    PasswordRequirementAuditModel:
      description: Query results
      properties:
        action:
          description: The action that generated the audit.
          type: string
        dateRecorded:
          description: The date the audit occurred.
          type: string
          format: date-time
        displayName:
          description: Display Name of the User who generated the audit.
          type: string
        notes:
          description: Details of the audit.
          type: string
        passwordRequirementAuditId:
          description: Password Requirement Audit Id.
          type: integer
          format: int32
        passwordRequirementId:
          description: Password Requirement Id.
          type: integer
          format: int32
        userId:
          description: Id of the User who generated the audit.
          type: integer
          format: int32
        userName:
          description: Username of the User who generated the audit.
          type: string
      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
    PasswordDictionarySummary:
      description: Password Dictionary Summary
      properties:
        name:
          description: Password Dictionary Name
          type: string
        passwordDictionaryId:
          description: Password Dictionary Id
          type: integer
          format: int32
      type: object
    UpdateFieldValueOfInt32Array:
      description: FolderIds
      properties:
        dirty:
          description: Dirty
          type: boolean
        value:
          description: Value
          items:
            type: integer
            format: int32
          type: array
      type: object
    PasswordRequirementPatchModel:
      description: Password Requirement Patch Model
      properties:
        allowedCharacterSet:
          $ref: '#/components/schemas/UpdateFieldValueOfInt32'
        description:
          $ref: '#/components/schemas/UpdateFieldValueOfString'
        isDefault:
          $ref: '#/components/schemas/UpdateFieldValueOfBoolean'
        maxPasswordLength:
          $ref: '#/components/schemas/UpdateFieldValueOfInt32'
        minimumRequiredCharacterSets:
          $ref: '#/components/schemas/UpdateFieldValueOfOptionalInt32'
        minPasswordLength:
          $ref: '#/components/schemas/UpdateFieldValueOfInt32'
        name:
          $ref: '#/components/schemas/UpdateFieldValueOfString'
        passwordDictionaries:
          $ref: '#/components/schemas/UpdateFieldValueOfInt32Array'
        preventDictionaryWords:
          $ref: '#/components/schemas/UpdateFieldValueOfBoolean'
        preventSequentialPattern:
          $ref: '#/components/schemas/UpdateFieldValueOfBoolean'
        preventSpatialPattern:
          $ref: '#/components/schemas/UpdateFieldValueOfBoolean'
        preventUsername:
          $ref: '#/components/schemas/UpdateFieldValueOfBoolean'
      type: object
    Severity:
      description: Error severity level
      properties: {}
      type: string
      enum:
      - None
      - Retry
      - Warn
      - Critical
      - Fatal
    PasswordRequirementType:
      description: Password Requirement Type
      properties: {}
      type: string
      enum:
      - MinimumOf
      - StartsWith
      - EndsWith
      - MaxConsecutive
      - Repeating
      - RepeatingConsecutive
    CharacterSetSummary:
      description: Character Set that is used in password requirements
      properties:
        abbreviation:
          description: Abbreviated view of the character set
          type: string
        active:
          description: Is this character set active
          type: boolean
        characterSetId:
          description: Sequence ID for character set
          type: integer
          format: int32
        description:
          description: Description
          type: string
        isStandard:
          description: Is this a standard character set
          type: boolean
        name:
          description: Name
          type: string
        value:
          description: The actual characters in the character set
          type: string
      type: object
    UpdateFieldValueOfOptionalInt32:
      description: The minimum length required for local user passwords
      properties:
        dirty:
          description: Dirty
          type: boolean
        value:
          description: Value
          type:
          - integer
          - 'null'
          format: int32
      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
    AuthenticationFailedResponse:
      description: Response object for authentication failures
      required:
      - message
      properties:
        message:
          description: Error message
          type: string
      type: object
    BadRequestResponse:
      description: Response object for invalid requests
      required:
      - message
      properties:
        message:
          description: Error message
          type: string
        messageDetail:
          description: Error message detail
          type: string
        errorCode:
          description: Error message code
          type: string
        modelState:
          description: An object describing validation errors
          type: object
      type: object
    InternalServerErrorResponse:
      description: Response object for internal server errors
      required:
      - message
      - exceptionMessage
      - exceptionType
      - stackTrace
      properties:
        message:
          description: Error message
          type: string
        exceptionMessage:
          description: Error message from exception
          type: string
        exceptionType:
          description: Exception type
          type: string
        stackTrace:
          description: Exception stack trace
          type: string
      type: object
    PasswordRequirementRuleSummary:
      description: Password Requirement Rule Summary
      properties:
        characterSet:
          $ref: '#/components/schemas/CharacterSetSummary'
        minCharactersRequired:
          description: Minimum Characters Required
          type: integer
          format: int32
        passwordRequirementId:
          description: Password Requirement Id
          type: integer
          format: int32
        passwordRequirementRuleId:
          description: Password Requirement Rule Id
          type: integer
          format: int32
        passwordRequirementType:
          $ref: '#/components/schemas/PasswordRequirementType'
      type: object
    PasswordRequirementPatchArgs:
      description: PasswordRequirementPatchArgs
      properties:
        data:
          $ref: '#/components/schemas/PasswordRequirementPatchModel'
      type: object
    PasswordRequirementRuleUpdateArgs:
      description: Password Requirement Rule Patch Args
      properties:
        data:
          description: Password Requirement Rule Patch Args
          items:
            $ref: '#/components/schemas/PasswordRequirementRuleUpdateModel'
          type: array
      type: object
    PasswordRequirementRuleCreateModel:
      description: Password Requirement Rule Create Models
      properties:
        characterSetId:
          description: Character Set
          type:
          - integer
          - 'null'
          format: int32
        minCharactersRequired:
          description: Minimum Characters Required
          type: integer
          format: int32
        passwordRequirementType:
          $ref: '#/components/schemas/PasswordRequirementType'
      type: object
    UpdateFieldValueOfBoolean:
      description: Active
      properties:
        dirty:
          description: Dirty
          type: boolean
        value:
          description: Value
          type: boolean
      type: object
  securitySchemes:
    BearerToken:
      type: apiKey
      description: 'Perform a POST request to `/oauth2/token`. It should include three form data parameters - `username`, `password`, and `grant_type`.The `grant_type` parameter should always have the value `password`.The access token returned should be included in the header of subsequent requests, like ''Authorization: Bearer <em>token</em>''. The token remains valid for a time period returned in the ''expires_in'' property (in seconds). For details, see the <a href="../OAuth/">token request documentation</a>.'
      name: Authorization
      in: header