EmbeddedSessionCreateRequest

  • displayName
    Type: string
    min length:  
    1
    max length:  
    200
    required

    Current user name recorded with actions performed through this session. A later session may supply a new name for the same partnerUserId; earlier action records keep the name recorded at the time.

  • origin
    Type: string
    max length:  
    2048    Format: uri
    required

    Exact browser origin where the Partner will mount the component, containing only scheme, host and optional port. It must match an origin registered for the Partner. Production origins use HTTPS; a loopback HTTP origin may be registered for local development.

  • partnerUserId
    Type: string
    min length:  
    1
    max length:  
    200
    required

    Stable, case-sensitive ID for the signed-in user in the Partner product. Use the same value for that user across every Employer they can access. It must identify only one user within the Partner account and cannot be changed.