Skip to main content

Identity_UpdateUser

Identity_UpdateUser

Path Parameters
  • user string required

    The user id.

Request Body required
  • user object required
    • name string

      The resource name of the user.

    • uuid string

      The uuid that identifies the user during the authentication flow.

    • username string

      The public username of the user.

    • discriminator string

      The public discriminator of the user.

    • primaryEmail string

      The primary email address of the user.

    • primaryEmailVerified boolean

      Whether the primary email address has been verified.

    • givenName string

      The given name of the user.

    • familyName string

      The family name of the user.

    • displayName string

      The name of the user.

    • countryCode string

      The country where the user is located at, must be a valid ISO-3166 code.

    • locale string

      The locale preferred by the user, must be a valid BCP-47 code.

    • localeFallback string

      The fallback locale preferred by the user, must be a valid BCP-47 code. The only allowed values are eng, jpn, and jpn-Latn (romaji).

    • birthday date

      The birthday defined by the user, this value is used to determine whether the user should be allowed to access explicit and sensitive content.

    • gender enum

      Possible values: [GENDER_UNSPECIFIED, MALE, FEMALE, OTHER]

      The gender of the user.

    • profileImage string

      The profile image of the user.

    • bannerImage string

      The banner image of the user.

  • updateMask field-mask

    The field mask to determine which fields are to be updated. If empty, the server will assume all fields are to be updated.

Responses

OK

Schema
  • name string

    The resource name of the user.

  • uuid string

    The uuid that identifies the user during the authentication flow.

  • username string

    The public username of the user.

  • discriminator string

    The public discriminator of the user.

  • primaryEmail string

    The primary email address of the user.

  • primaryEmailVerified boolean

    Whether the primary email address has been verified.

  • givenName string

    The given name of the user.

  • familyName string

    The family name of the user.

  • displayName string

    The name of the user.

  • countryCode string

    The country where the user is located at, must be a valid ISO-3166 code.

  • locale string

    The locale preferred by the user, must be a valid BCP-47 code.

  • localeFallback string

    The fallback locale preferred by the user, must be a valid BCP-47 code. The only allowed values are eng, jpn, and jpn-Latn (romaji).

  • birthday date

    The birthday defined by the user, this value is used to determine whether the user should be allowed to access explicit and sensitive content.

  • gender enum

    Possible values: [GENDER_UNSPECIFIED, MALE, FEMALE, OTHER]

    The gender of the user.

  • profileImage string

    The profile image of the user.

  • bannerImage string

    The banner image of the user.