Tipo de recurso claimsMappingPolicy
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.
Representa las directivas de asignación de notificaciones para los protocolos WS-Fed, SAML, OAuth 2.0 y OpenID Connect, para los tokens emitidos a una aplicación específica. Puede usar directivas de asignación de notificaciones para:
- Seleccione qué notificaciones se incluyen en los tokens.
- Creación de tipos de notificación que aún no existen
- Elección o cambio del origen de datos emitidos en notificaciones específicas
El número de notificaciones y transformaciones que se pueden agregar a una directiva de asignación de notificaciones se limita a reducir el tamaño del token. Las entradas o transformaciones del esquema de notificaciones que se encuentran después de alcanzar el límite se omiten e incluyen en el token emitido. Para obtener más información sobre los límites, vea Propiedades de una definición de directiva de asignación de notificaciones.
Para obtener más detalles de escenario y configuración, vea Tipo de directiva de asignación de notificaciones y Cómo: Personalizar las notificaciones emitidas en tokens para una aplicación específica en un inquilino.
Además, visite Personalización de notificaciones mediante una directiva para conocer la diferencia entre esta directiva y la directiva de notificaciones personalizada.
Hereda de stsPolicy.
Métodos
| Método | Tipo de valor devuelto | Descripción |
|---|---|---|
| List | claimsMappingPolicy | Lee las propiedades y las relaciones de los objetos claimsMappingPolicies. |
| Crear | claimsMappingPolicy | Cree un objeto claimsMappingPolicy. |
| Get | claimsMappingPolicy | Lea las propiedades y las relaciones de un objeto claimsMappingPolicy. |
| Actualizar | Ninguno | Actualice un objeto claimsMappingPolicy. |
| Delete | Ninguno | Elimine un objeto claimsMappingPolicy. |
| La lista se aplica a | Colección directoryObject | Obtenga la lista de directoryObjects a los que se ha aplicado esta directiva. |
| Asignación a la entidad de servicio | Ninguno | Asigne claimsMappingPolicy a un objeto servicePrincipal . |
| Lista asignada a la entidad de servicio | Colección claimsMappingPolicy | Enumere los objetos claimsMappingPolicy asignados a un objeto servicePrincipal . |
| Anulación de la asignación de la entidad de servicio | Ninguno | Quite claimsMappingPolicy de un objeto servicePrincipal . |
Propiedades
| Propiedad | Tipo | Descripción |
|---|---|---|
| id | Cadena | Identificador único de esta directiva. Solo lectura. |
| definición | Colección string | Colección de cadenas que contiene una cadena JSON que define las reglas y la configuración de esta directiva. Para obtener más información sobre el esquema JSON de esta propiedad, consulte Propiedades de una definición de directiva de asignación de notificaciones. Obligatorio. |
| displayName | Cadena | Nombre para mostrar de esta directiva. Obligatorio. |
| isOrganizationDefault | Booleano | Omita esta propiedad. La directiva de asignación de notificaciones solo se puede aplicar a las entidades de servicio y no se puede establecer globalmente para la organización. |
Propiedades de una definición de directiva de asignación de notificaciones
El objeto JSON que se va a insertar en la propiedad de definición debe convertirse primero en una cadena con comillas de escape. En esta sección se muestran algunos ejemplos de definición.
Ejemplo: definición para incluir EmployeeID y TenantCountry como notificaciones en tokens
{
"definition": [
"{\"ClaimsMappingPolicy\":{\"Version\":1,\"IncludeBasicClaimSet\":\"true\",\"ClaimsSchema\": [{\"Source\":\"user\",\"ID\":\"employeeid\",\"SamlClaimType\":\"http://schemas.xmlsoap.org/ws/2005/05/identity/claims/name\",\"JwtClaimType\":\"name\"},{\"Source\":\"company\",\"ID\":\"tenantcountry\",\"SamlClaimType\":\"http://schemas.xmlsoap.org/ws/2005/05/identity/claims/country\",\"JwtClaimType\":\"country\"}]}}"
],
"displayName": "Test1234"
}
Ejemplo: definición que usa una transformación de notificaciones
{
"definition": [
"{\"ClaimsMappingPolicy\":{\"Version\":1,\"IncludeBasicClaimSet\":\"true\",\"ClaimsSchema\": [{\"Source\":\"user\",\"ID\":\"userprincipalname\",\"SamlClaimType\":\"http://schemas.xmlsoap.org/ws/2005/05/identity/claims/nameidentifier\"},{\"Source\":\"user\",\"ID\":\"givenname\",\"SamlClaimType\":\"http://schemas.xmlsoap.org/ws/2005/05/identity/claims/givenname\"},{\"Source\":\"user\",\"ID\":\"displayname\",\"SamlClaimType\":\"http://schemas.xmlsoap.org/ws/2005/05/identity/claims/name\"},{\"Source\":\"user\",\"ID\":\"surname\",\"SamlClaimType\":\"http://schemas.xmlsoap.org/ws/2005/05/identity/claims/surname\"},{\"Source\":\"user\",\"ID\":\"userprincipalname\",\"SamlClaimType\":\"username\"}],\"ClaimsTransformation\":[{\"ID\":\"CreateTermsOfService\",\"TransformationMethod\":\"CreateStringClaim\",\"InputParameters\": [{\"ID\":\"value\",\"DataType\":\"string\", \"Value\":\"sandbox\"}],\"OutputClaims\":[{\"ClaimTypeReferenceId\":\"TOS\",\"TransformationClaimType\":\"createdClaim\"}]}]}}"
],
"displayName": "Test1234"
}
| Propiedad | Tipo | Descripción |
|---|---|---|
| Versión | Entero | Establezca el valor de 1. Obligatorio. |
| IncludeBasicClaimSet | Booleano | Si se establece trueen , todas las notificaciones del conjunto de notificaciones básico se emiten en tokens afectados por la directiva. Si se establece falseen , las notificaciones del conjunto de notificaciones básico no están en los tokens, a menos que se agreguen individualmente en la propiedad ClaimsSchema de la misma directiva. |
| ClaimsSchema | Objeto JSON | Define qué notificaciones están presentes en los tokens afectados por la directiva, además del conjunto de notificaciones básico y el conjunto de notificaciones principal. Para cada entrada de esquema de notificación definida en esta propiedad, se requiere cierta información. Especifique de dónde proceden los datos (par valor o origen/identificador) y qué notificación emiten los datos como (Tipo de notificación). Se incluyen un máximo de 50 notificaciones en el token a través del objeto ClaimsSchema. Las entradas de esquema de notificaciones que se encuentran después de alcanzar el límite se omiten y no aparecen en el token emitido. Hay más detalles disponibles en la definición ClaimsSchema. |
| ClaimsTransformation | Objeto JSON | Define transformaciones comunes que se pueden aplicar a los datos de origen para generar los datos de salida para las notificaciones especificadas en ClaimsSchema. Se incluyen un máximo de 50 transformaciones en el token a través del objeto ClaimsTransformation. Las transformaciones que se encuentran después de alcanzar el límite se omiten y no aparecen en el token emitido. Para obtener más información sobre ClaimsTransformation y las funciones admitidas, vea Transformación de notificaciones. |
Relaciones
| Relación | Tipo | Descripción |
|---|---|---|
| appliesTo | Colección directoryObject | Colección directoryObject a la que se ha aplicado esta directiva. Solo lectura. |
Representación JSON
La siguiente representación JSON muestra el tipo de recurso.
{
"definition": ["String"],
"displayName": "String",
"id": "String (identifier)",
"isOrganizationDefault": false,
}