Administración de usuarios de Xbox LiveXbox Live User Management

SolicitudRequest

Puedes obtener la lista de los usuarios en la consola o actualizar la lista al agregar, quitar, iniciar sesión, cerrar sesión o modificar los usuarios existentes.You can get the list of users on the console, or update the list--adding, removing, signing in, signing out, or modifying existing users.

MétodoMethod URI de solicitudRequest URI
GETGET /ext/user/ext/user
PUTPUT /ext/user/ext/user

Parámetros de URIURI parameters

  • NoneNone

Encabezados de solicitudRequest headers

  • NoneNone

Cuerpo de la solicitudRequest body

Las llamadas a PUT deben incluir una matriz JSON con la estructura siguiente:Calls to PUT should include a JSON array with the following structure:

  • UsuariosUsers
    • AutoSignIn (opcional): bool que habilita o deshabilita el inicio de sesión automático para la cuenta que especifica EmailAddress o UserId.AutoSignIn (optional) : bool disabling or enabling automatic signin for the account specified by EmailAddress or UserId.
    • EmailAddress (opcional: debe proporcionarse si el UserId no se proporciona a menos que inicie sesión un usuario patrocinado): dirección de correo electrónico que especifica el usuario que se debe modificar, agregar o eliminar.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.
    • Contraseña (opcional: debe proporcionarse si el usuario no está actualmente en la consola): contraseña que se usa para agregar un nuevo usuario a la consola.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 (opcional): bool que especifica si la cuenta proporcionada debe iniciar o cerrar sesión.SignedIn (optional) : bool specifying whether the provided account should be signed in or out.
    • UserId (opcional: debe proporcionarse si el EmailAddress no se proporciona a menos que inicie sesión un usuario patrocinado): UserId que especifica el usuario que se debe modificar, agregar o eliminar.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 (opcional): bool que especifica si agregar un usuario patrocinado.SponsoredUser (optional) : bool specifying whether to add a sponsored user.
    • Delete (opcional): bool que especifica la eliminación de este usuario de la consolaDelete (optional) : bool specifying to delete this user from the console

ResponseResponse

Cuerpo de respuestaResponse body

Las llamadas a GET devolverán una matriz JSON con las propiedades siguientes:Calls to GET will return a JSON array with the following properties:

  • UsuariosUsers
    • AutoSignIn (opcional)AutoSignIn (optional)
    • EmailAddress (opcional)EmailAddress (optional)
    • GamertagGamertag
    • SignedInSignedIn
    • UserIdUserId
    • XboxUserIdXboxUserId
    • SponsoredUser (opcional)SponsoredUser (optional)

Código de estadoStatus code

Esta API tiene los siguientes códigos de estado previstos.This API has the following expected status codes.

Código de estado HTTPHTTP status code DescripciónDescription
200200 La llamada a GET se realizó correctamente y la matriz JSON de usuarios devueltos en el cuerpo de la respuestaCall to GET was successful and JSON array of users returned in the response body
204204 La llamada a PUT se realizó correctamente y se han actualizado los usuarios de la consolaCall to PUT was successful and the users on the console have been updated
4XX4XX Varios errores de formato o datos de solicitud no válidosVarious errors for invalid request data or format
5XX5XX Códigos de error para errores inesperadosError codes for unexpected failures