BungieNet.Platform.UserServices Documentation

This page describes the service operations available at https://www.bungie.net/Platform/User.

Uri	Method	Scope	Description
/ChangeBungieName/	POST	EditUserData	Changes the signed in user's bungie name assuming it passes validation, including the user having available name changes. Duplicates identical functionality in UpdateUser.
/EditBirthdayAndCountry/	POST	EditUserData	Edits a user's birthdate and native country used for age gating.
/EditBirthdayOrCountry/{membershipId}/	POST	EditUserData	Edits a user's birthdate or native country used for age gating. Requires an admin.
/MessageFlags/Success/Update/{flags}/	POST	EditUserData	Updates message flags for the 'success' category of UI messages for a user.
/GetAvailableAvatars/	GET	ReadUserData	Returns a list of all available avatars for the signed-in user.
/GetAvailableThemes/	GET		Returns a list of all available user themes.
/GetBungieNetUserById/{id}/	GET		Loads a bungienet user by membership id.
/GetCredentialTypesForTargetAccount/{membershipId}/	GET		Returns a list of credential types attached to the requested account
/GetCurrentBungieNetUser/	GET	ReadBasicUserProfile	Gets basic profile information for the signed-in user.
/GetBungieNetUser/	GET	ReadUserData	Gets user details of signed-in user.
/GetForumUser/	GET	BnetWrite	Gets user information for the signed-in user specifically for the forum.
/GetMembershipsById/{membershipId}/{membershipType}/	GET		Returns a list of accounts associated with the supplied membership ID and membership type. This will include all linked accounts (even when hidden) if supplied credentials permit it.
/GetMembershipsForCurrentUser/	GET	ReadBasicUserProfile	Returns a list of accounts associated with signed in user. This is useful for OAuth implementations that do not give you access to the token response.
/GetMembershipFromHardLinkedCredential/{crType}/{credential}/	GET		Gets any hard linked membership given a credential. Only works for credentials that are public (just SteamID64 right now). Cross Save aware.
/GetNotificationSettings/	GET	ReadUserData	Returns this users notification settings.
/GetSanitizedPlatformDisplayNames/{membershipId}/	GET		Gets a list of all display names linked to this membership id but sanitized (profanity filtered). Obeys all visibility rules of calling user and is heavily cached.
/GetUserBirthdayAndCountryAdmin/{membershipId}/	GET	ReadUserData	Retrieves a user's birthdate or native country used for age gating. Requires an admin.
/NameChangesAvailable/	GET	EditUserData	Returns the number of name changes available to the signed in user.
/RemoveBirthdayAndCountry/{membershipId}/	POST	EditUserData	Removes a user's birthdate and native country from their user details. Requires an admin.
/Search/GlobalName/{page}/	POST		Given the prefix of a global display name, returns all users who share that name.
/Search/Prefix/{displayNamePrefix}/{page}/	GET		[OBSOLETE] Do not use this to search users, use SearchByGlobalNamePost instead.
/Acknowledged/{ackId}/	POST	EditUserData	Notes an item as acknowledged by the user.
/UpdateDestinyEmblemAvatar/	POST	EditUserData	Updates the user's destiny emblem selection, or clears it if the values are zero'd out. Returns new avatar relative url.
/Notification/Update/	POST	EditUserData	Updates a notification setting for the current user.
/UpdateUser/	POST	EditUserData	Updates a user based on the current logged in user info.
/ValidateBungieName/	POST	EditUserData	Given a bungie name, does every validation step for changing the name, including having available name changes, but doesn't actually commit the change.