Tessell Password Policy API

The Password Policy API from Tessell — 1 operation(s) for password policy.

OpenAPI Specification

tessell-password-policy-api-openapi.yml Raw ↑
openapi: 3.0.3
info:
  title: Tessell APIs activity-center Password Policy API
  contact:
    email: support@tessell.com
    name: Tessell Inc
    url: https://www.tessell.com
  description: Tessell API Documentation
  termsOfService: https://www.tessell.com/terms
  version: '1.0'
servers:
- url: '{server}'
  variables:
    server:
      default: console.tessell.com
tags:
- name: Password Policy
paths:
  /security/password-policies:
    patch:
      operationId: updatePasswordPolicy
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PasswordPolicyDTO'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PasswordPolicyResponseDTO'
          description: OK
        default:
          description: API error response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
      summary: Update Tenant Password Policies
      tags:
      - Password Policy
      parameters:
      - name: Authorization
        in: header
        description: Authorization Token
        required: true
        style: simple
        schema:
          type: string
    get:
      operationId: getPasswordPolicyByID
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PasswordPolicyDTO'
          description: OK
        default:
          description: API error response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
      summary: Get Tenant Password Policies
      tags:
      - Password Policy
      parameters:
      - name: Authorization
        in: header
        description: Authorization Token
        required: true
        style: simple
        schema:
          type: string
components:
  schemas:
    ApiError:
      type: object
      description: Common error response object for non 2xx responses
      properties:
        code:
          type: string
          description: Status code for the error response
        message:
          type: string
          description: Error message for API response
        resolution:
          type: string
        timestamp:
          type: string
          format: date-time
        contextId:
          type: string
          description: ContextId of API request
        sessionId:
          type: string
          description: SessionId of API request
        tessellErrorCode:
          type: string
          description: Unique error code specific to Tessell
    PasswordPolicyResponseDTO:
      type: object
      properties:
        status:
          type: string
        message:
          type: array
          items:
            type: string
    PasswordPolicyDTO:
      title: PasswordPolicyDTO
      type: object
      properties:
        expiryTimeInDays:
          type: integer
        minLength:
          type: integer
        noInvalidAttempts:
          type: integer
        isUpperCase:
          type: boolean
        isLowerCase:
          type: boolean
        isNumber:
          type: boolean
          description: Should password contain a Number
        isSpecialCharacter:
          type: boolean
          description: Should password contain an Special character
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer