User

  • country
    Type: object · HrCountrynullable
    required
    • country_code
      Type: string
      required
  • countryCode
    Type: string nullable
    required
  • createdAt
    Type: string Format: date-time
    required

    The timestamp of when this resource was created. ISO 8601 format.

  • email
    Type: string
    required
  • emails
    Type: array · UserEmail[]
    required
      • email
        Type: string
        required
      • isPrimary
        Type: boolean
        required
      • sourceKind
        const:  
        manual
        required
  • hrStatus
    Type: string · UserHrStatusenumnullable
    required
    values
    • active
    • terminated
    • pending
  • id
    Type: string
    required
  • idpStatus
    Type: string · UserIdpStatusenumnullable
    required
    values
    • active
    • suspended
    • archived
    • deprovisioned
  • job
    Type: object · HrJobEmbednullable
    required
    • display_name
      Type: string
      required
    • key
      Type: string
      required
  • jobKey
    Type: string nullable
    required
  • name
    Type: string
    required
  • personalEmail
    Type: string nullable
    required
  • sources
    Type: array · UserSource[]
    required
      • createdAt
        Type: string Format: date-time
        required

        the date-time notation as defined by RFC 3339, section 5.6, for example, 2017-07-21T17:32:28Z

      • kind
        Type: string · CormaSourceKindenum
        required
        values
        • extension
        • windows_desktop_agent
        • manual
        • manual_provisioning
        • manual_deprovisioning
        • api
      • lastUpdatedAt
        Type: string Format: date-time
        required

        the date-time notation as defined by RFC 3339, section 5.6, for example, 2017-07-21T17:32:28Z

      • type
        const:  
        corma
        required
  • startDate
    Type: string Format: date-timenullable
    required

    the date-time notation as defined by RFC 3339, section 5.6, for example, 2017-07-21T17:32:28Z

  • team
    Type: object · TeamEmbednullable
    required
    • displayName
      Type: string
      required
    • key
      Type: string
      required
  • teamKey
    Type: string nullable
    required
  • terminationDate
    Type: string Format: date-timenullable
    required

    the date-time notation as defined by RFC 3339, section 5.6, for example, 2017-07-21T17:32:28Z

  • type
    Type: string · UserIdentityTypeenum
    required
    values
    • employee
    • external
    • service_account
    • agent
  • updatedAt
    Type: string Format: date-time
    required

    The timestamp of the last update to this resource. ISO 8601 format.