Create o reemplace claimsPolicy

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.

Create un nuevo objeto customClaimsPolicy si no existe o reemplaza uno existente.

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.Read.ApplicationConfiguration	Policy.ReadWrite.ApplicationConfiguration
Delegado (cuenta personal de Microsoft)	No admitida.	No admitida.
Aplicación	Policy.Read.ApplicationConfiguration	Policy.ReadWrite.ApplicationConfiguration

Para escenarios delegados en los que un administrador actúa sobre otro usuario, el administrador necesita al menos uno de los siguientes roles de Microsoft Entra.

• Administrador de la aplicación

Solicitud HTTP

PUT /servicePrincipals/{servicePrincipalsId}/claimsPolicy

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, proporcione una representación JSON del objeto customClaimsPolicy .

Puede especificar las siguientes propiedades al crear customClaimsPolicy.

Propiedad	Tipo	Description
includeBasicClaimSet	Booleano	Determina si el conjunto de notificaciones básico se incluye en los tokens afectados por esta directiva. Si se establece trueen , todas las notificaciones del conjunto de notificaciones básico se emiten en tokens afectados por la directiva. De forma predeterminada, el conjunto de notificaciones básico no está en los tokens, a menos que estén configurados explícitamente en esta directiva. Opcional.
includeApplicationIdInIssuer	Booleano	Indica si el identificador de aplicación se agrega a la notificación. Solo es relevante para SAML2.0 y si se usa una clave de firma personalizada. el valor predeterminado es true. Opcional.
audienceOverride	Cadena	Si se especifica, invalida el contenido de la notificación de audiencia para los protocolos WS-Federation y SAML2. Se debe usar una clave de firma personalizada para que se aplique audienceOverride; de lo contrario, se omite el valor audienceOverride. El valor proporcionado debe tener el formato de un URI absoluto. Opcional.
Reclamaciones	colección customClaimBase	Define qué notificaciones están presentes en los tokens afectados por la directiva, además de la notificación básica y el conjunto de notificaciones principal. Opcional.

Respuesta

Si se ejecuta correctamente, este método devuelve un 204 código de respuesta y un objeto customClaimsPolicy en el cuerpo de la respuesta.

Ejemplos

Solicitud

En el ejemplo siguiente se muestra la solicitud.

HTTP

PUT https://graph.microsoft.com/beta/servicePrincipals/{servicePrincipalsId}/claimsPolicy
Content-Type: application/json

{
  "@odata.type": "#microsoft.graph.customClaimsPolicy",
  "includeBasicClaimSet": "Boolean",
  "includeApplicationIdInIssuer": "Boolean",
  "audienceOverride": "String",
  "claims": [
    {
      "@odata.type": "microsoft.graph.customClaim"
    }
  ]
}

JavaScript

const options = {
	authProvider,
};

const client = Client.init(options);

const customClaimsPolicy = {
  '@odata.type': '#microsoft.graph.customClaimsPolicy',
  includeBasicClaimSet: 'Boolean',
  includeApplicationIdInIssuer: 'Boolean',
  audienceOverride: 'String',
  claims: [
    {
      '@odata.type': 'microsoft.graph.customClaim'
    }
  ]
};

await client.api('/servicePrincipals/{servicePrincipalsId}/claimsPolicy')
	.version('beta')
	.put(customClaimsPolicy);

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.

Respuesta

En el ejemplo siguiente se muestra la respuesta.

Nota: Se puede acortar el objeto de respuesta que se muestra aquí para mejorar la legibilidad.

HTTP/1.1 201 Created
Content-Type: application/json

{
  "@odata.type": "#microsoft.graph.customClaimsPolicy",
  "id": "f914f36d-167e-3fa7-cfa2-355cc5a36689",
  "includeBasicClaimSet": "Boolean",
  "includeApplicationIdInIssuer": "Boolean",
  "audienceOverride": "String",
  "claims": [
    {
      "@odata.type": "microsoft.graph.customClaim"
    }
  ]
}