Package ai.vectros.types

Class UserResponse

java.lang.Object
ai.vectros.types.UserResponse
public final class UserResponse extends Object

  • Method Details

    • getCreated

      public Optional<Boolean> getCreated()
      Returns:
      Whether this call created a new user. True when a new user was created; false when a user with the same externalId already existed and was returned unchanged (idempotent create) or updated (when ?upsert=true). Present only on the create response (POST /v1/users); absent on reads. The HTTP status mirrors it — 201 when created, 200 when an existing user was returned.

    • getId

      public Optional<String> getId()
      Returns:
      The Vectros-assigned UUID for this user. Use this ID when referencing the user in token minting, record ownership, and filters.

    • getExternalId

      public Optional<String> getExternalId()
      Returns:
      Your own identifier for this user, supplied when the user was created.

    • getEmail

      public Optional<String> getEmail()
      Returns:
      The user's email address.

    • getStatus

      public Optional<UserResponseStatus> getStatus()
      Returns:
      The user's lifecycle status. ACTIVE and SUSPENDED apply to normal users; PENDING marks an invited user who has not yet completed acceptance.

    • getType

      public Optional<UserResponseType> getType()
      Returns:
      The kind of user: HUMAN for a real person, or SERVICE for a bot, agent, or automated integration. Users created before this field existed are reported as HUMAN.

    • getPayload

      public Optional<Map<String,Object>> getPayload()
      Returns:
      Arbitrary key-value attributes stored on this user.

    • getSchemaId

      public Optional<String> getSchemaId()
      Returns:
      The ID of the record schema that governs this user's payload validation and lookup indexing, or null if the user is not bound to a schema.

    • getSchemaVersion

      public Optional<Integer> getSchemaVersion()
      Returns:
      The version of the governing schema captured at the time this user was last written. The user keeps the version it was stamped with even after the schema is edited. Null when the user is not bound to a schema.

    • getCreatedAt

      public Optional<String> getCreatedAt()
      Returns:
      When the user was created, as an ISO-8601 UTC timestamp.

    • getExternalSubject

      public Optional<String> getExternalSubject()
      Returns:
      The user's identifier in your own authentication system (for example, a Cognito sub or Auth0 user ID). This is set when an invitation is accepted via PUT /v1/users/{id} with status=ACTIVE, and is null until the user is activated.

    • equals

      public boolean equals(Object other)
      Overrides:
      equals in class Object

    • getAdditionalProperties

      public Map<String,Object> getAdditionalProperties()

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object

    • toString

      public String toString()
      Overrides:
      toString in class Object

    • builder

      public static UserResponse.Builder builder()