openapi: 3.1.0
info:
  title: Internal Proxy WS admin
  description: Proxy admin API for managing password delay configurations
  version: 25R1.1
paths:
  /proxy/admin/configurations/password-delay:
    get:
      tags:
        - passwordDelay
      summary: Get password delay configurations
      description: Get password delay configurations, filterable by customer (hierarchy) and configuration name.
      parameters:
        - in: query
          name: service
          schema:
            type: string
          description: Service code
          example: 'ACS_U0X'
        - in: query
          name: issuer
          schema:
            type: string
            format: 5 digits
          description: Issuer code
          example: '00000'
        - in: query
          name: subIssuer
          schema:
            type: string
            format: 5 digits
          description: Sub-issuer code
          example: '00000'
        - in: query
          name: name
          schema:
            type: string
            enum: [ 'DELAY_PWD_BLOCKED_AFTER_CREATE', 'DELAY_PWD_BLOCKED_AFTER_UPDATE' ]
          description: Configuration name. If not provided, both configurations are returned.
        - in: query
          name: getBelow
          schema:
            type: boolean
          description: |
            If true, return configurations corresponding or below the requested hierarchy.
            If false or not provided, return configuration corresponding or above the requested hierarchy.
      responses:
        '200':
          description: Configurations matching the filters are returned, as a map
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConfigurationMap'
        '500':
          description: Unexpected server error
    put:
      tags:
        - passwordDelay
      summary: Create or update a password delay configuration
      description: Create or update a password delay configuration for a specific customer.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                service:
                  type: string
                  description: Service code
                  example: 'ACS_U0X'
                issuer:
                  type: string
                  format: 5 digits
                  description: Issuer code
                  example: '00000'
                subIssuer:
                  type: string
                  format: 5 digits
                  description: Sub-issuer code
                  example: '00000'
                name:
                  type: string
                  enum: [ 'DELAY_PWD_BLOCKED_AFTER_CREATE', 'DELAY_PWD_BLOCKED_AFTER_UPDATE' ]
                  description: Configuration name
                  example: 'DELAY_PWD_BLOCKED_AFTER_CREATE'
                value:
                  type: integer
                  enum: [ 0, 48, 72 ]
                  description: Delay in hours. 0 means no delay.
                  example: 48
              required:
                - name
                - value
      responses:
        '200':
          description: |
            Configuration correctly created or updated.
            Updated configuration and below configurations (which can overwrite it) are returned, as a map.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConfigurationMap'
        '400':
          description: Invalid request body (wrong name or value for the configuration)
        '500':
          description: Unexpected server error
    delete:
      tags:
        - passwordDelay
      summary: Remove a password delay configuration
      description: Remove a password delay configuration for a specific customer.
      parameters:
        - in: query
          name: service
          schema:
            type: string
          description: Service code
          example: 'ACS_U0X'
        - in: query
          name: issuer
          schema:
            type: string
            format: 5 digits
          description: Issuer code
          example: '00000'
        - in: query
          name: subIssuer
          schema:
            type: string
            format: 5 digits
          description: Sub-issuer code
          example: '00000'
        - in: query
          name: name
          required: true
          schema:
            type: string
            enum: [ 'DELAY_PWD_BLOCKED_AFTER_CREATE', 'DELAY_PWD_BLOCKED_AFTER_UPDATE' ]
          description: Configuration name to remove
      responses:
        '204':
          description: Configuration correctly removed
        '400':
          description: Invalid request body (wrong name for the configuration)
        '500':
          description: Unexpected server error
components:
  schemas:
    ConfigurationMap:
      type: object
      additionalProperties:
        type: array
        items:
          type: integer
      example: { "ACS_U0X-00000-00000-DELAY_PWD_BLOCKED_AFTER_CREATE": [ 72 ], "ACS_U0X-00000-00000-DELAY_PWD_BLOCKED_AFTER_UPDATE": [ 48 ] }