Xbox Live ユーザー管理Xbox Live User Management

RequestRequest

本体のユーザーの一覧を取得したり、一覧を更新したりできます。更新では、既存のユーザーの追加、削除、サインイン、サインアウト、または変更を行うことができます。You can get the list of users on the console, or update the list--adding, removing, signing in, signing out, or modifying existing users.

MethodMethod 要求 URIRequest URI
GETGET /ext/user/ext/user
PUTPUT /ext/user/ext/user

URI パラメーターURI parameters

  • なしNone

要求ヘッダーRequest headers

  • なしNone

要求本文Request body

PUT メソッドの呼び出しには、次の構造の JSON 配列を含める必要があります。Calls to PUT should include a JSON array with the following structure:

  • ユーザーUsers
    • AutoSignIn (省略可能): EmailAddress や UserId で指定されたアカウントの自動サインインを無効または有効にするブール値。AutoSignIn (optional) : bool disabling or enabling automatic signin for the account specified by EmailAddress or UserId.
    • EmailAddress (省略可能。ただし、スポンサー ユーザーにサインインしている場合を除き、UserId が指定されていない場合は必須): 変更、追加、削除を行うユーザーを指定するメール アドレス。EmailAddress (optional - must be provided if UserId is not provided unless signing in a sponsored user) : Email address specifying the user to modify/add/delete.
    • Password (省略可能。ただし、ユーザーが現在本体にサインインしていない場合は必須): 新しいユーザーを本体に追加するために使うパスワード。Password (optional - must be provided if the user isn't currently on the console) : Password used for adding a new user to the console.
    • SignedIn (省略可能): 指定されたアカウントでサインインまたはサインアウトする必要があるかどうかを指定するブール値。SignedIn (optional) : bool specifying whether the provided account should be signed in or out.
    • UserId (省略可能。ただし、スポンサー ユーザーにサインインしている場合を除き、EmailAddress が指定されていない場合は必須): 変更、追加、削除を行うユーザーを指定するユーザー ID。UserId (optional - must be provided if EmailAddress is not provided unless signing in a sponsored user) : UserId specifying the user to modify/add/delete.
    • SponsoredUser (省略可能): スポンサー ユーザーを追加するかどうかを指定するブール値。SponsoredUser (optional) : bool specifying whether to add a sponsored user.
    • Delete (省略可能): ブール値を指定して、コンソールからこのユーザーを削除します。Delete (optional) : bool specifying to delete this user from the console

応答Response

応答本文Response body

GET メソッドの呼び出しでは、次のプロパティが指定された JSON 配列を返します。Calls to GET will return a JSON array with the following properties:

  • ユーザーUsers
    • AutoSignIn (省略可能)AutoSignIn (optional)
    • EmailAddress (省略可能)EmailAddress (optional)
    • GamertagGamertag
    • SignedInSignedIn
    • UserIdUserId
    • XboxUserIdXboxUserId
    • SponsoredUser (省略可能)SponsoredUser (optional)

status codeStatus code

この API では次の状態コードが返される可能性があります。This API has the following expected status codes.

HTTP 状態コードHTTP status code 説明Description
200200 GET メソッドの呼び出しが成功し、ユーザーの JSON 配列が応答本文で返されましたCall to GET was successful and JSON array of users returned in the response body
204204 PUT メソッドの呼び出しが成功し、本体のユーザーが更新されましたCall to PUT was successful and the users on the console have been updated
4XX4XX 無効な要求データまたは形式を示すさまざまなエラーVarious errors for invalid request data or format
5XX5XX 予期しないエラーのエラー コードError codes for unexpected failures