Interface User.Builder

All Superinterfaces:
Buildable, CopyableBuilder<User.Builder,User>, SdkBuilder<User.Builder,User>, SdkPojo
Enclosing class:
User
@Mutable @NotThreadSafe public static interface User.Builder extends SdkPojo, CopyableBuilder<User.Builder,User>

  • Method Details

    • identityStoreId

      User.Builder identityStoreId(String identityStoreId)

      The globally unique identifier for the identity store.

      Parameters:
      identityStoreId - The globally unique identifier for the identity store.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • userId

      User.Builder userId(String userId)

      The identifier for a user in the identity store.

      Parameters:
      userId - The identifier for a user in the identity store.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • userName

      User.Builder userName(String userName)

      A unique string used to identify the user. The length limit is 128 characters. This value can consist of letters, accented characters, symbols, numbers, and punctuation. This value is specified at the time the user is created and stored as an attribute of the user object in the identity store.

      Parameters:
      userName - A unique string used to identify the user. The length limit is 128 characters. This value can consist of letters, accented characters, symbols, numbers, and punctuation. This value is specified at the time the user is created and stored as an attribute of the user object in the identity store.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • externalIds

      User.Builder externalIds(Collection<ExternalId> externalIds)

      A list of ExternalId objects that contains the identifiers issued to this resource by an external identity provider.

      Parameters:
      externalIds - A list of ExternalId objects that contains the identifiers issued to this resource by an external identity provider.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • externalIds

      User.Builder externalIds(ExternalId... externalIds)

      A list of ExternalId objects that contains the identifiers issued to this resource by an external identity provider.

      Parameters:
      externalIds - A list of ExternalId objects that contains the identifiers issued to this resource by an external identity provider.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • externalIds

      User.Builder externalIds(Consumer<ExternalId.Builder>... externalIds)

      A list of ExternalId objects that contains the identifiers issued to this resource by an external identity provider.

      This is a convenience method that creates an instance of the ExternalId.Builder avoiding the need to create one manually via ExternalId.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to externalIds(List<ExternalId>).

      Parameters:
      externalIds - a consumer that will call methods on ExternalId.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • name

      User.Builder name(Name name)

      An object containing the name of the user.

      Parameters:
      name - An object containing the name of the user.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • name

      default User.Builder name(Consumer<Name.Builder> name)

      An object containing the name of the user.

      This is a convenience method that creates an instance of the Name.Builder avoiding the need to create one manually via Name.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to name(Name).

      Parameters:
      name - a consumer that will call methods on Name.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • displayName

      User.Builder displayName(String displayName)

      A string containing the name of the user that is formatted for display when the user is referenced. For example, "John Doe."

      Prefix search supports a maximum of 1,000 characters for the string.

      Parameters:
      displayName - A string containing the name of the user that is formatted for display when the user is referenced. For example, "John Doe."

      Prefix search supports a maximum of 1,000 characters for the string.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • nickName

      User.Builder nickName(String nickName)

      A string containing an alternate name for the user.

      Parameters:
      nickName - A string containing an alternate name for the user.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • profileUrl

      User.Builder profileUrl(String profileUrl)

      A string containing a URL that might be associated with the user.

      Parameters:
      profileUrl - A string containing a URL that might be associated with the user.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • emails

      User.Builder emails(Collection<Email> emails)

      A list of Email objects containing email addresses associated with the user.

      Parameters:
      emails - A list of Email objects containing email addresses associated with the user.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • emails

      User.Builder emails(Email... emails)

      A list of Email objects containing email addresses associated with the user.

      Parameters:
      emails - A list of Email objects containing email addresses associated with the user.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • emails

      User.Builder emails(Consumer<Email.Builder>... emails)

      A list of Email objects containing email addresses associated with the user.

      This is a convenience method that creates an instance of the Email.Builder avoiding the need to create one manually via Email.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to emails(List<Email>).

      Parameters:
      emails - a consumer that will call methods on Email.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • addresses

      User.Builder addresses(Collection<Address> addresses)

      A list of Address objects containing addresses associated with the user.

      Parameters:
      addresses - A list of Address objects containing addresses associated with the user.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • addresses

      User.Builder addresses(Address... addresses)

      A list of Address objects containing addresses associated with the user.

      Parameters:
      addresses - A list of Address objects containing addresses associated with the user.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • addresses

      User.Builder addresses(Consumer<Address.Builder>... addresses)

      A list of Address objects containing addresses associated with the user.

      This is a convenience method that creates an instance of the Address.Builder avoiding the need to create one manually via Address.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to addresses(List<Address>).

      Parameters:
      addresses - a consumer that will call methods on Address.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • phoneNumbers

      User.Builder phoneNumbers(Collection<PhoneNumber> phoneNumbers)

      A list of PhoneNumber objects containing phone numbers associated with the user.

      Parameters:
      phoneNumbers - A list of PhoneNumber objects containing phone numbers associated with the user.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • phoneNumbers

      User.Builder phoneNumbers(PhoneNumber... phoneNumbers)

      A list of PhoneNumber objects containing phone numbers associated with the user.

      Parameters:
      phoneNumbers - A list of PhoneNumber objects containing phone numbers associated with the user.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • phoneNumbers

      User.Builder phoneNumbers(Consumer<PhoneNumber.Builder>... phoneNumbers)

      A list of PhoneNumber objects containing phone numbers associated with the user.

      This is a convenience method that creates an instance of the PhoneNumber.Builder avoiding the need to create one manually via PhoneNumber.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to phoneNumbers(List<PhoneNumber>).

      Parameters:
      phoneNumbers - a consumer that will call methods on PhoneNumber.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • userType

      User.Builder userType(String userType)

      A string indicating the type of user. Possible values are left unspecified. The value can vary based on your specific use case.

      Parameters:
      userType - A string indicating the type of user. Possible values are left unspecified. The value can vary based on your specific use case.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • title

      User.Builder title(String title)

      A string containing the title of the user. Possible values are left unspecified. The value can vary based on your specific use case.

      Parameters:
      title - A string containing the title of the user. Possible values are left unspecified. The value can vary based on your specific use case.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • preferredLanguage

      User.Builder preferredLanguage(String preferredLanguage)

      A string containing the preferred language of the user. For example, "American English" or "en-us."

      Parameters:
      preferredLanguage - A string containing the preferred language of the user. For example, "American English" or "en-us."
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • locale

      User.Builder locale(String locale)

      A string containing the geographical region or location of the user.

      Parameters:
      locale - A string containing the geographical region or location of the user.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • timezone

      User.Builder timezone(String timezone)

      A string containing the time zone of the user.

      Parameters:
      timezone - A string containing the time zone of the user.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • userStatus

      User.Builder userStatus(String userStatus)

      The current status of the user account.

      Parameters:
      userStatus - The current status of the user account.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • userStatus

      User.Builder userStatus(UserStatus userStatus)

      The current status of the user account.

      Parameters:
      userStatus - The current status of the user account.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • photos

      User.Builder photos(Collection<Photo> photos)

      A list of photos associated with the user. Users can have up to 3 photos with metadata including type, display name, and primary designation.

      Parameters:
      photos - A list of photos associated with the user. Users can have up to 3 photos with metadata including type, display name, and primary designation.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • photos

      User.Builder photos(Photo... photos)

      A list of photos associated with the user. Users can have up to 3 photos with metadata including type, display name, and primary designation.

      Parameters:
      photos - A list of photos associated with the user. Users can have up to 3 photos with metadata including type, display name, and primary designation.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • photos

      User.Builder photos(Consumer<Photo.Builder>... photos)

      A list of photos associated with the user. Users can have up to 3 photos with metadata including type, display name, and primary designation.

      This is a convenience method that creates an instance of the Photo.Builder avoiding the need to create one manually via Photo.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to photos(List<Photo>).

      Parameters:
      photos - a consumer that will call methods on Photo.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • website

      User.Builder website(String website)

      The user's personal website or blog URL. This field stores website information for personal or professional use.

      Parameters:
      website - The user's personal website or blog URL. This field stores website information for personal or professional use.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • birthdate

      User.Builder birthdate(String birthdate)

      The user's birthdate in YYYY-MM-DD format. This field stores personal birthdate information for the user.

      Parameters:
      birthdate - The user's birthdate in YYYY-MM-DD format. This field stores personal birthdate information for the user.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • createdAt

      User.Builder createdAt(Instant createdAt)

      The date and time the user was created.

      Parameters:
      createdAt - The date and time the user was created.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • createdBy

      User.Builder createdBy(String createdBy)

      The identifier of the user or system that created the user.

      Parameters:
      createdBy - The identifier of the user or system that created the user.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • updatedAt

      User.Builder updatedAt(Instant updatedAt)

      The date and time the user was last updated.

      Parameters:
      updatedAt - The date and time the user was last updated.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • updatedBy

      User.Builder updatedBy(String updatedBy)

      The identifier of the user or system that last updated the user.

      Parameters:
      updatedBy - The identifier of the user or system that last updated the user.
      Returns:
      Returns a reference to this object so that method calls can be chained together.