User Management (xbuser.exe)
Xbuser is a command-line tool that adds, removes, signs in or signs out a user on a development kit.
Xbuser provides the subcommands and functions described in the following table.
| Command | Description |
|---|---|
| xbuser add | Add a user to the console. |
| xbuser addsponsored | Add a sponsored user to the console and sign the user in. See Types of Users and Online Status for more information on sponsored users. |
| xbuser delete | Delete the user with the specified ID or email address. |
| xbuser deleteall | Delete all of the users on the console. |
| xbuser list | List all of the users on the console. |
| xbuser signin | Sign in the user with the specified ID or email address. The user will be added to the console if it doesn't already exist on the console. |
| xbuser signout | Signout out the user with the given ID or email address. |
| xbuser addlocalusertoparty | Creates a party for the specified title ID (if one does not exist) and adds the given users to it. |
| xbuser removelocalusersfromparty | Removes the comma delimited list of users from the party belonging to the specified title ID. |
| xbuser getpartyid | Returns the party ID belonging to the specified title ID. |
| xbuser invitetoparty | Invites the comma delimited list of users on behalf of the acting user for the specified title ID's party. |
| xbuser acceptinvitetoparty | Accepts the party invite on behalf of the acting user to the specified party ID. |
| xbuser declineinvitetoparty | Declines the party invite on behalf of the acting user to the specified party ID. |
| xbuser getpartymembers | Lists the Xbox user IDs of both the current members and the reserved members of the party belonging to the current title ID. |
xbuser add
Adds a user to the console.
Added users persist through development kit switches to and from retail. Added users will also persist through a development kit recovery as long as a factory reset is not performed.
Note The add command adds an existing account to the console, it does not create a new account.
xbuser add [/e[:]email address]
|
| Option | Description |
|---|---|
| /e[:]email address | Specifies the email address of the user to add to the console |
Return to the top of this topic.
xbuser addsponsored
Adds a sponsored user to the console and sign the user in. See Types of Users and Online Status for more information on sponsored users.
Guest users are associated with an already signed-in account. A currently signed-in user is picked by the system to be the sponsor and further calls to addsponsored will continue to use that user for all subsequent sponsored users. If the selected user gets signed out, all sponsored users are signed out at that time.
The addsponsored command will fail if there are no users currently signed in.
xbuser addsponsored
|
Return to the top of this topic.
xbuser delete
Deletes a user from the console.
xbuser delete [/i:<userId>|/e:<email address>]
|
| Option | Description |
|---|---|
| /i:<userId>|/e:<email address> | Specifies the ID or email address of the user to delete. |
Return to the top of this topic.
xbuser deleteall
Deletes all users from the console.
xbuser deleteall
|
Return to the top of this topic.
xbuser list
Lists all users on the console.
xbuser list
|
Return to the top of this topic.
xbuser signin
Signs in the user with the specified ID or email adress. The user will be added to the console if it doesn’t already exist on the console.
xbuser signin [/i:<userId>|/e:<email address>] [/p:password]
|
| Option | Description | ||
|---|---|---|---|
| /i:<userId>|/e:<email address> | Specifies the ID or email address of the user to sign in. | ||
| /p:password | The user's password. The password is stored on the console. Password is optional if it has already been stored on the console using this utility or the Sign In app.
|
Note Return to the top of this topic.
xbuser signout
Signs out the user with the specified ID or email adress
xbuser signout [/i:<userId>|/e:<email address>]
|
| Option | Description |
|---|---|
| /i:<userId>|/e:<email address> | Specifies the ID or email address of the user to sign out. |
Return to the top of this topic.
xbuser addlocaluserstoparty
Creates a party for the specified title ID (if one does not exist) and adds the given users to it. An acting user must be provided (the creator of the party) and optionally a comma delimited list of additional local users may be provided to add to the party.
xbuser addlocaluserstoparty [/t:<titleId>] [/au:<actinguserxuid>] [/u:<additionalLocalUserXuids>]
|
| Option | Description |
|---|---|
| /t:<titleId> | Title ID to create the party for. |
| /au:<actinguserxuid> | The Xbox user ID for the creator of the party. |
| /u:<additionalLocalUserXuids> | An optional comma delimited list of additional local users to add to the party. |
Return to the top of this topic.
xbuser removelocalusersfromparty
Removes the comma delimited list of users from the party belonging to the specified title ID.
xbuser removelocalusersfromparty [/t:<titleId>] [/u:<additionalLocalUserXuids>]
|
| Option | Description |
|---|---|
| /t:<titleId> | Title ID to remove party members for. |
| /u:<additionalLocalUserXuids> | A comma delimited list of local users to remove from the party. |
Return to the top of this topic.
xbuser getpartyid
Returns the party ID belonging to the specified title ID.
xbuser getpartyid [/t:<titleId>]
|
| Option | Description |
|---|---|
| /t:<titleId> | Title ID to retrieve the party ID for. |
Return to the top of this topic.
xbuser invitetoparty
Invites the comma delimited list of users on behalf of the acting user for the specified title ID’s party.
xbuser invitetoparty [/t:<titleId>] [/au:<actinguserxuid>] [/u:<userXuidsToInvite>]
|
| Option | Description |
|---|---|
| /t:<titleId> | Title ID for the party. |
| /au:<actinguserxuid> | The Xbox user ID for the user sending the invite. |
| /u:<userXuidsToInvite> | A comma delimited list of users to invite to the party. |
Return to the top of this topic.
xbuser acceptinvitetoparty
Accepts the party invite on behalf of the acting user to the specified party ID.
xbuser acceptinvitetoparty [/au:<actinguserxuid>] [/pid:<partyId>]
|
| Option | Description |
|---|---|
| /au:<actinguserxuid> | The Xbox user ID for the user accepting the invite. |
| /pid:<partyId> | The ID for the party. |
Return to the top of this topic.
xbuser declineinvitetoparty
Declines the party invite on behalf of the acting user to the specified party ID.
xbuser declineinvitetoparty [/au:<actinguserxuid>] [/pid:<partyId>]
|
| Option | Description |
|---|---|
| /au:<actinguserxuid> | The Xbox user ID for the user declining the invite. |
| /pid:<partyId> | The ID for the party. |
Return to the top of this topic.
xbuser getpartymembers
Lists the Xbox user IDs of both the current members and the reserved members of the party belonging to the current title ID.
xbuser getpartymembers [/t:<titleId>]
|
| Option | Description |
|---|---|
| /t:<titleId> | Title ID for the party. |
Return to the top of this topic.
Error codes
Xbuser provides more specific information about some errors by echoing HRESULT values to stdout.
| Error code | Meaning |
|---|---|
| 0x80048823 | The email address is not a valid email address. |
| 0x8004882E | The password for the given user is not stored on the console. You must supply a password as part of the sign in operation. |
| 0x80048821 | The password for the given user is invalid, |
| 0x8015DC16 | The given user is signed in on another console. |