Actualizar externalIdentitiesPolicy

Artículo
10/28/2023

Espacio de nombres: microsoft.graph

Importante

Las API de la versión /beta de Microsoft Graph están sujetas a cambios. No se admite el uso de estas API en aplicaciones de producción. Para determinar si una API está disponible en la versión 1.0, use el selector de Versión.

Actualice la configuración del objeto externalIdentitiesPolicy de todo el inquilino que controla si los usuarios externos pueden dejar un inquilino Microsoft Entra a través de controles de autoservicio.

Esta API está disponible en las siguientes implementaciones nacionales de nube.

Servicio global	Gobierno de EE. UU. L4	Us Government L5 (DOD)	China operada por 21Vianet
✅	✅	✅	✅

Permissions

Elija el permiso o los permisos marcados como con privilegios mínimos para esta API. Use un permiso o permisos con privilegios superiores solo si la aplicación lo requiere. Para obtener más información sobre los permisos delegados y de aplicación, consulte Tipos de permisos. Para obtener más información sobre estos permisos, consulte la referencia de permisos.

Tipo de permiso	Permisos con privilegios mínimos	Permisos con privilegios más altos
Delegado (cuenta profesional o educativa)	Policy.ReadWrite.ExternalIdentities	No disponible.
Delegado (cuenta personal de Microsoft)	No admitida.	No admitida.
Aplicación	Policy.ReadWrite.ExternalIdentities	No disponible.

Solicitud HTTP

PATCH /policies/externalIdentitiesPolicy

Encabezados de solicitud

Nombre	Descripción
Authorization	{token} de portador. Obligatorio. Obtenga más información sobre la autenticación y la autorización.
Content-Type	application/json. Obligatorio.

Cuerpo de la solicitud

En el cuerpo de la solicitud, únicamente proporcione los valores de las propiedades que deben actualizarse. Las propiedades existentes que no se incluyen en el cuerpo de la solicitud mantienen sus valores anteriores o se recalculan en función de los cambios realizados en otros valores de propiedad.

En la tabla siguiente se especifican las propiedades que se pueden actualizar.

Propiedad	Tipo	Descripción
allowDeletedIdentitiesDataRemoval	Booleano	Reservado para uso futuro.
allowExternalIdentitiesToLeave	Booleano	Define si los usuarios externos pueden dejar el inquilino invitado. Si se establece en `false`, los controles de autoservicio están deshabilitados y el administrador del inquilino invitado debe quitar manualmente el usuario externo del inquilino invitado. Cuando el usuario externo deja el inquilino, sus datos en el inquilino invitado se eliminan temporalmente primero y, a continuación, se eliminan permanentemente en 30 días. Obligatorio.

Respuesta

Si se ejecuta correctamente, este método devuelve un código de respuesta 204 No Content. No devuelve nada en el cuerpo de la respuesta.

Ejemplos

Solicitud

PATCH https://graph.microsoft.com/beta/policies/externalIdentitiesPolicy

{
  "allowExternalIdentitiesToLeave":false
}


// Code snippets are only available for the latest version. Current version is 5.x

// Dependencies
using Microsoft.Graph.Beta.Models;

var requestBody = new ExternalIdentitiesPolicy
{
	AllowExternalIdentitiesToLeave = false,
};

// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=csharp
var result = await graphClient.Policies.ExternalIdentitiesPolicy.PatchAsync(requestBody);

Importante

Los SDK de Microsoft Graph usan la versión v1.0 de la API de manera predeterminada y no admiten todos los tipos, propiedades y API disponibles en la versión beta. Para obtener más información sobre cómo acceder a la API beta con el SDK, consulte Uso de los SDK de Microsoft Graph con la API beta.

Para obtener más información sobre cómo agregar el SDK al proyecto y crear una instancia de authProvider, consulte la documentación del SDK.


// THE CLI IS IN PREVIEW. NON-PRODUCTION USE ONLY
mgc-beta policies external-identities-policy patch

Importante

Para obtener más información sobre cómo agregar el SDK al proyecto y crear una instancia de authProvider, consulte la documentación del SDK.



import (
	  "context"
	  msgraphsdk "github.com/microsoftgraph/msgraph-beta-sdk-go"
	  graphmodels "github.com/microsoftgraph/msgraph-beta-sdk-go/models"
	  //other-imports
)

graphClient := msgraphsdk.NewGraphServiceClientWithCredentials(cred, scopes)


requestBody := graphmodels.NewExternalIdentitiesPolicy()
allowExternalIdentitiesToLeave := false
requestBody.SetAllowExternalIdentitiesToLeave(&allowExternalIdentitiesToLeave) 

externalIdentitiesPolicy, err := graphClient.Policies().ExternalIdentitiesPolicy().Patch(context.Background(), requestBody, nil)

Importante

Para obtener más información sobre cómo agregar el SDK al proyecto y crear una instancia de authProvider, consulte la documentación del SDK.


// Code snippets are only available for the latest version. Current version is 6.x

GraphServiceClient graphClient = new GraphServiceClient(requestAdapter);

ExternalIdentitiesPolicy externalIdentitiesPolicy = new ExternalIdentitiesPolicy();
externalIdentitiesPolicy.setAllowExternalIdentitiesToLeave(false);
ExternalIdentitiesPolicy result = graphClient.policies().externalIdentitiesPolicy().patch(externalIdentitiesPolicy);

Importante

Para obtener más información sobre cómo agregar el SDK al proyecto y crear una instancia de authProvider, consulte la documentación del SDK.


const options = {
	authProvider,
};

const client = Client.init(options);

const externalIdentitiesPolicy = {
  allowExternalIdentitiesToLeave: false
};

await client.api('/policies/externalIdentitiesPolicy')
	.version('beta')
	.update(externalIdentitiesPolicy);

Importante

Para obtener más información sobre cómo agregar el SDK al proyecto y crear una instancia de authProvider, consulte la documentación del SDK.


<?php
use Microsoft\Graph\GraphServiceClient;
use Microsoft\Graph\Generated\Models\ExternalIdentitiesPolicy;


$graphServiceClient = new GraphServiceClient($tokenRequestContext, $scopes);

$requestBody = new ExternalIdentitiesPolicy();
$requestBody->setAllowExternalIdentitiesToLeave(false);

$result = $graphServiceClient->policies()->externalIdentitiesPolicy()->patch($requestBody)->wait();

Importante

Para obtener más información sobre cómo agregar el SDK al proyecto y crear una instancia de authProvider, consulte la documentación del SDK.


Import-Module Microsoft.Graph.Beta.Identity.SignIns

$params = @{
	allowExternalIdentitiesToLeave = $false
}

Update-MgBetaPolicyExternalIdentityPolicy -BodyParameter $params

Importante

Para obtener más información sobre cómo agregar el SDK al proyecto y crear una instancia de authProvider, consulte la documentación del SDK.


from msgraph import GraphServiceClient
from msgraph.generated.models.external_identities_policy import ExternalIdentitiesPolicy

graph_client = GraphServiceClient(credentials, scopes)

request_body = ExternalIdentitiesPolicy(
	allow_external_identities_to_leave = False,
)

result = await graph_client.policies.external_identities_policy.patch(request_body)

Importante

Para obtener más información sobre cómo agregar el SDK al proyecto y crear una instancia de authProvider, consulte la documentación del SDK.

Respuesta

HTTP/1.1 204 No Content

Actualizar externalIdentitiesPolicy

Permissions

Solicitud HTTP

Encabezados de solicitud

Cuerpo de la solicitud

Respuesta

Ejemplos

Solicitud

Respuesta

Comentarios

Comentarios

Recursos adicionales