# The Identity DTO returned by the v3 identities APIs
allOf:
  - $ref: './BaseCommonDto.yaml'
  - type: object
    title: IdentityDto
    properties:
      alias:
        type: string
        description: Alternate unique identifier for the identity
        example: 'walter.white'
      emailAddress:
        type: string
        description: The email address of the identity
        example: 'sender@example.com'
      processingState:
        type: string
        nullable: true
        description: The processing state of the identity
        enum:
          - ERROR
          - OK
        example: ERROR
      identityStatus:
        type: string
        description: The identity's status in the system
        enum:
          - UNREGISTERED
          - REGISTERED
          - PENDING
          - WARNING
          - DISABLED
          - ACTIVE
          - DEACTIVATED
          - TERMINATED
          - ERROR
          - LOCKED
        example: LOCKED
      managerRef:
        $ref: '../../v3/schemas/BaseReferenceDto.yaml'
      isManager:
        type: boolean
        description: Whether this identity is a manager of another identity
        default: false
        example: true
      lastRefresh:
        type: string
        format: date-time
        description: The last time the identity was refreshed by the system
        example: '2020-11-22T15:42:31.123Z'
      attributes:
        type: object
        description: A map with the identity attributes for the identity
        example: '{"uid":"Walter White","firstname":"walter","cloudStatus":"UNREGISTERED","displayName":"Walter White","identificationNumber":"942","lastSyncDate":1470348809380,"email":"walter@gmail.com","lastname":"white"}'
      lifecycleState:
        $ref: '../../v3/schemas/LifecycleStateDto.yaml'
        description: Lifecycle state details that include lifecycle state name and whether this lifecycle state has been set manually
