User

  • country
    Type: object · HrCountry nullable
    required
    • country_code
      Type: string
      required
  • countryCode
    Type: string nullable
    required
  • createdAt
    Type: stringFormat: date-time
    required

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

  • email
    Type: string
    required
  • hrStatus
    Type: string · UserHrStatusenum nullable
    required
    values
    • active
    • terminated
    • pending
  • id
    Type: string
    required
  • idpStatus
    Type: string · UserIdpStatusenum nullable
    required
    values
    • provisioned
    • active
    • suspended
    • archived
    • deprovisioned
  • job
    Type: object · HrJob nullable
    required
    • display_name
      Type: string
      required
    • key
      Type: string
      required
  • jobKey
    Type: string nullable
    required
  • name
    Type: string
    required
  • personalEmail
    Type: string nullable
    required
  • startDate
    Type: stringFormat: date-time nullable
    required

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

  • team
    Type: object · Team nullable
    required
    • displayName
      Type: string
      required
    • key
      Type: string
      required
  • teamKey
    Type: string nullable
    required
  • terminationDate
    Type: stringFormat: date-time nullable
    required

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

  • type
    Type: stringenum
    required
    values
    • employee
    • external
    • service_account
    • agent
  • updatedAt
    Type: stringFormat: date-time
    required

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