Package ai.vectros.types

Interface UserRequest._FinalStage

All Known Implementing Classes:
UserRequest.Builder
Enclosing class:
UserRequest
public static interface UserRequest._FinalStage

  • Method Details

    • build

      UserRequest build()

    • additionalProperty

      UserRequest._FinalStage additionalProperty(String key, Object value)

    • additionalProperties

      UserRequest._FinalStage additionalProperties(Map<String,Object> additionalProperties)

    • email

      UserRequest._FinalStage email(Optional<String> email)

      The user's email address. Used for display and notifications only; it is not used for authentication to the Vectros API.

    • email

      UserRequest._FinalStage email(String email)

    • status

      UserRequest._FinalStage status(Optional<UserRequestStatus> status)

      The user's lifecycle status. ACTIVE users can be used normally; SUSPENDED users are retained but blocked from new operations. PENDING is a server-managed state for invitations awaiting acceptance — you cannot set it directly. (A pending user becomes ACTIVE by sending status=ACTIVE together with inviteToken, externalSubject, and emailVerifiedAttestation=true.) You may set only ACTIVE or SUSPENDED directly.

    • status

      UserRequest._FinalStage status(UserRequestStatus status)

    • type

      UserRequest._FinalStage type(Optional<UserRequestType> type)

      The kind of user. HUMAN (the default) is a real person; SERVICE is a bot, agent, scheduled job, or other named integration with no specific person behind it. Service users may omit email. The type is immutable after creation — to change it, create a new user.

    • type

      UserRequest._FinalStage type(UserRequestType type)

    • payload

      UserRequest._FinalStage payload(Optional<Map<String,Object>> payload)

      Arbitrary key-value attributes to store on the user, useful for carrying additional data from your own system.

    • payload

      UserRequest._FinalStage payload(Map<String,Object> payload)

    • schemaId

      UserRequest._FinalStage schemaId(Optional<String> schemaId)

      Optional ID of a record schema (created via POST /v1/schemas) that drives payload validation and lookup indexing. When set, the schema must belong to your account, the payload is validated against the schema's fields on save, and the schema's lookup fields become queryable via GET /v1/users (using type, field, and a lookup mode). When omitted, the payload is free-form and no lookup rows are written.

    • schemaId

      UserRequest._FinalStage schemaId(String schemaId)

    • inviteToken

      UserRequest._FinalStage inviteToken(Optional<String> inviteToken)

      The raw invite token from the invitation email link. Required to activate a pending invitation (moving the user from PENDING to ACTIVE); ignored otherwise. The token's signature is verified server-side.

    • inviteToken

      UserRequest._FinalStage inviteToken(String inviteToken)

    • externalSubject

      UserRequest._FinalStage externalSubject(Optional<String> externalSubject)

      The user's identifier in your own authentication system (for example, a Cognito sub or Auth0 user ID). Required to activate a pending invitation; ignored on subsequent updates. Treat it as immutable once the user is activated. This is NOT an authentication binding, and setting it here does not enable sign-in anywhere — not the Vectros DevPortal/Admin App/web apps, and not /v1/auth/token/exchange either. Those are granted only by the invitee authenticating themselves (accepting the emailed invitation link, or redeeming inviteToken directly at the token-exchange endpoint with their own credential). It is stored exactly as you send it, with no normalization — it does NOT automatically match or deduplicate against an identity that later authenticates via token exchange, which computes its own internal value from the verified credential rather than reading this field. Use externalId (above) for your own correlation/bookkeeping needs; treat this field as informational unless you have a specific, verified reason to set it.

    • externalSubject

      UserRequest._FinalStage externalSubject(String externalSubject)

    • emailVerifiedAttestation

      UserRequest._FinalStage emailVerifiedAttestation(Optional<Boolean> emailVerifiedAttestation)

      Your attestation that the invitee's email was verified by your authentication system before this call. Must be true to activate a pending invitation. Vectros cannot inspect your authentication system, so asserting this accurately is your responsibility.

    • emailVerifiedAttestation

      UserRequest._FinalStage emailVerifiedAttestation(Boolean emailVerifiedAttestation)