Restore a deleted user for a customer (Restaurar un usuario eliminado para un cliente)

Artículo
03/06/2024

Cómo restaurar un usuario eliminado por identificador de cliente e identificador de usuario.

Requisitos previos

Credenciales tal como se describen en el artículo Autenticación del Centro de partners. Este escenario admite la autenticación solo con credenciales de aplicación y usuario.
Un id. de cliente (customer-tenant-id). Si no conoce el identificador del cliente, puede buscarlo en el Centro de partners seleccionando el área de trabajo Clientes , luego el cliente de la lista de clientes y, a continuación , Cuenta. En la página Cuenta del cliente, busque el identificador de Microsoft en la sección Información de la cuenta de cliente. El id. de Microsoft es el mismo que el de cliente (customer-tenant-id).
El id. de usuario. Si no tiene el identificador de usuario, consulte Ver usuarios eliminados para un cliente.

Roles de GDAP

Necesitará al menos uno de los siguientes roles de GDAP:

Administrador de usuarios
Escritor de directorios

Restauración de una cuenta de usuario eliminada

El estado de usuario se establece en "inactivo" al eliminar una cuenta de usuario. Sigue siendo así durante 30 días, después de lo cual la cuenta de usuario y sus datos asociados se purgan y hacen irrecuperables. Solo puede restaurar una cuenta de usuario eliminada durante esta ventana de 30 días. Una vez eliminado y marcado como "inactivo", la cuenta de usuario ya no se devuelve como miembro de la colección de usuarios (por ejemplo, mediante Obtener una lista de todas las cuentas de usuario para un cliente).

C#

Para restaurar un usuario, cree una nueva instancia de la clase CustomerUser y establezca el valor de la propiedad User.State en UserState.Active.

Para restaurar un usuario eliminado, establezca el estado del usuario en activo. No es necesario volver a rellenar los campos restantes en el recurso de usuario. Esos valores se restaurarán automáticamente a partir del recurso de usuario inactivo eliminado. A continuación, use el método IAggregatePartner.Customers.ById con el identificador de cliente para identificar al cliente y el método Users.ById para identificar al usuario.

Por último, llame al método Patch y pase la instancia customerUser para enviar la solicitud para restaurar el usuario.

// IAggregatePartner partnerOperations;
// string selectedCustomerId;
// string selectedCustomerUserId;

var updatedCustomerUser = new CustomerUser()
{
    State = UserState.Active
};

// Restore customer user information.
var restoredCustomerUserInfo = partnerOperations.Customers.ById(selectedCustomerId).Users.ById(selectedCustomerUserId).Patch(updatedCustomerUser);

Ejemplo: Aplicación de prueba de consola. Project: Partner Center SDK Samples Class: CustomerUserRestore.cs

Solicitud REST

Sintaxis de la solicitud

Method	URI de solicitud
PATCH	{baseURL}/v1/customers/{customer-tenant-id}/users/{user-id} HTTP/1.1

Parámetro de URI

Use los parámetros de consulta siguientes para especificar el identificador de cliente y el identificador de usuario.

Nombre	Tipo	Obligatorio	Descripción
customer-tenant-id	guid	Y	El valor es un GUID con formato customer-tenant-id que permite al revendedor filtrar los resultados a un cliente determinado.
user-id	guid	Y	El valor es un identificador de usuario con formato GUID que pertenece a una sola cuenta de usuario.

Encabezados de solicitud

Para obtener más información, consulta Encabezados REST del Centro de partners.

Cuerpo de la solicitud

En esta tabla se describen las propiedades necesarias en el cuerpo de la solicitud.

Nombre	Tipo	Obligatorio	Descripción
State	cadena	Y	Estado del usuario. Para restaurar un usuario eliminado, esta cadena debe contener "activo".
Atributos	object	N	Contiene "ObjectType": "CustomerUser".

Ejemplo de solicitud

PATCH https://api.partnercenter.microsoft.com/v1/customers/4d3cf487-70f4-4e1e-9ff1-b2bfce8d9f04/users/a45f1416-3300-4f65-9e8d-f123b397a4ea HTTP/1.1
Authorization: Bearer <token>
Accept: application/json
MS-RequestId: 6e668bc0-5bd7-44d6-b6fa-529d41ce9659
MS-CorrelationId: 32be760f-8282-4e01-a37b-829c8a700e8a
X-Locale: en-US
Content-Type: application/json
Host: api.partnercenter.microsoft.com
Content-Length: 269
Expect: 100-continue

{
    "State": "active",
    "Attributes": {
        "ObjectType": "CustomerUser"
    }
}

Respuesta REST

Si se ejecuta correctamente, la respuesta devuelve la información de usuario restaurada en el cuerpo de la respuesta.

Códigos de error y de respuesta correctos

Cada respuesta incluye un código de estado HTTP que indica si la operación se ha realizado correctamente o con errores y proporciona información de depuración adicional. Use una herramienta de seguimiento de red para leer este código, el tipo de error y los parámetros adicionales. Para obtener la lista completa, consulte Códigos de error rest del Centro de partners.

Ejemplo de respuesta

HTTP/1.1 200 OK
Content-Length: 465
Content-Type: application/json; charset=utf-8
MS-CorrelationId: 32be760f-8282-4e01-a37b-829c8a700e8a
MS-RequestId: 6e668bc0-5bd7-44d6-b6fa-529d41ce9659
MS-CV: ZTeBriO7mEaiM13+.0
MS-ServerId: 101112616
Date: Fri, 20 Jan 2017 22:24:55 GMT

{
    "usageLocation": "US",
    "id": "a45f1416-3300-4f65-9e8d-f123b397a4ea",
    "userPrincipalName": "e83763f7f2204ac384cfcd49f79f2749@dtdemocspcustomer005.onmicrosoft.com",
    "firstName": "Ferdinand",
    "lastName": "Filibuster",
    "displayName": "Ferdinand",
    "userDomainType": "none",
    "state": "active",
    "links": {
        "self": {
            "uri": "/customers/4d3cf487-70f4-4e1e-9ff1-b2bfce8d9f04/users/a45f1416-3300-4f65-9e8d-f123b397a4ea",
            "method": "GET",
            "headers": []
        }
    },
    "attributes": {
        "objectType": "CustomerUser"
    }
}