tipo de recurso organizationalBranding
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.
Contiene detalles sobre la personalización de marca predeterminada de la organización. Hereda de organizationalBrandingProperties.
Las organizaciones pueden personalizar sus páginas de inicio de sesión de Microsoft Entra que aparecen cuando los usuarios inician sesión en las aplicaciones específicas del inquilino de su organización o cuando Microsoft Entra ID identifica el inquilino del usuario desde su nombre de usuario. Un desarrollador también puede leer la información de personalización de marca de la empresa y personalizar su experiencia de aplicación para adaptarla específicamente para el usuario que ha iniciado sesión mediante la personalización de marca de su empresa.
No se puede cambiar el idioma de la configuración original. Sin embargo, las empresas pueden agregar una personalización de marca diferente en función de la configuración regional. Para la personalización de marca específica del lenguaje, consulte el objeto organizationalBrandingLocalization .
Nota:
Agregar personalización de marca requiere que tenga licencias de Microsoft Entra ID P1 o P2, Premium 2 o Office 365 (para aplicaciones Office 365). Para obtener más información sobre las licencias y las ediciones, vea Registrarse para Microsoft Entra ID P1 o P2.
Microsoft Entra ID ediciones P1 o P2 están disponibles para los clientes de China que usan la instancia mundial de Microsoft Entra ID. Microsoft Entra ID ediciones P1 o P2 no se admiten actualmente en el servicio de Azure operado por 21Vianet en China. Para obtener más información, hable con nosotros mediante el foro de Microsoft Entra.
Métodos
| Método | Tipo devuelto | Descripción |
|---|---|---|
| Obtener organizationalBranding | organizationalbranding | Lea las propiedades y relaciones de un objeto organizationalBranding . |
| Actualizar organizationalBranding | Ninguno | Actualice las propiedades de un objeto organizationalBranding . |
Propiedades
| Propiedad | Tipo | Descripción |
|---|---|---|
| Backgroundcolor | Cadena | Color que aparece en lugar de la imagen de fondo en conexiones de ancho de banda bajo. Se recomienda usar el color principal del logotipo de banner o el color de la organización. Especifique esto en formato hexadecimal, por ejemplo, white es #FFFFFF. Se hereda de organizationalBrandingProperties. |
| Backgroundimage | Stream | Imagen que aparece como fondo de la página de inicio de sesión. Los tipos permitidos son PNG o JPEG no menores que 300 KB y no mayores que 1920 × 1080 píxeles. Una imagen más pequeña reducirá los requisitos de ancho de banda y hará que la carga de la página sea más rápida. Se hereda de organizationalBrandingProperties. |
| backgroundImageRelativeUrl | Cadena | Dirección URL relativa de la propiedad backgroundImage que se combina con una dirección URL base de la red CDN de cdnList para proporcionar la versión que proporciona una red CDN. Solo lectura. Se hereda de organizationalBrandingProperties. |
| bannerLogo | Stream | Una versión de banner del logotipo de la empresa que aparece en la página de inicio de sesión. Los tipos permitidos son PNG o JPEG que no superan los 245 x 36 píxeles. Se recomienda usar una imagen transparente sin relleno alrededor del logotipo. Se hereda de organizationalBrandingProperties. |
| bannerLogoRelativeUrl | Cadena | Dirección URL relativa de la propiedad bannerLogo que se combina con una dirección URL base de la red CDN de cdnList para proporcionar la versión de solo lectura que proporciona una red CDN. Solo lectura. Se hereda de organizationalBrandingProperties. |
| cdnList | Colección de cadenas | Lista de direcciones URL base para todos los proveedores de red CDN disponibles que atienden los recursos del recurso actual. Varios proveedores de CDN se usan al mismo tiempo para la alta disponibilidad de las solicitudes de lectura. Solo lectura. Se hereda de organizationalBrandingProperties. |
| contentCustomization | contentCustomization | Representa las distintas opciones de contenido que se deben personalizar en todo el flujo de autenticación de un inquilino. NOTA: Solo es compatible con Microsoft Entra ID para los inquilinos de clientes. Se hereda de organizationalBrandingProperties. |
| customAccountResetCredentialsUrl | Cadena | Dirección URL personalizada para restablecer las credenciales de la cuenta. Esta dirección URL debe estar en formato ASCII o los caracteres que no sean ASCII deben estar codificados con dirección URL y no deben superar los 128 caracteres. Se hereda de organizationalBrandingProperties. |
| customCannotAccessYourAccountText | Cadena | Cadena para reemplazar el texto de hipervínculo predeterminado "¿No se puede acceder a su cuenta?", texto de hipervínculo de autoservicio de restablecimiento de contraseña (SSPR) en la página de inicio de sesión. Este texto debe estar en formato Unicode y no superar los 256 caracteres. Se hereda de organizationalBrandingProperties. |
| customCannotAccessYourAccountUrl | Cadena | Dirección URL personalizada para reemplazar la dirección URL predeterminada del hipervínculo de autoservicio de restablecimiento de contraseña (SSPR) "¿No se puede acceder a su cuenta?" en la página de inicio de sesión. Esta dirección URL debe estar en formato ASCII o los caracteres que no sean ASCII deben estar codificados con dirección URL y no deben superar los 128 caracteres. NO UTILICE. Use customAccountResetCredentialsUrl en su lugar. Se hereda de organizationalBrandingProperties. |
| customCSS | Stream | Estilo CSS que aparece en la página de inicio de sesión. El formato permitido es .css solo y no es mayor que 25 KB. Se hereda de organizationalBrandingProperties. |
| customCSSRelativeUrl | Cadena | Dirección URL relativa para la propiedad customCSS que se combina con una dirección URL base de la red CDN de cdnList para proporcionar la versión que proporciona una red CDN. Solo lectura. Se hereda de organizationalBrandingProperties. |
| customForgotMyPasswordText | Cadena | Cadena para reemplazar el texto de hipervínculo predeterminado "Olvidó mi contraseña" en el formulario de inicio de sesión. Este texto debe estar en formato Unicode y no superar los 256 caracteres. Se hereda de organizationalBrandingProperties. |
| customPrivacyAndCookiesText | Cadena | Cadena para reemplazar el texto predeterminado del hipervínculo "Privacidad y cookies" en el pie de página. Este texto debe estar en formato Unicode y no superar los 256 caracteres. Se hereda de organizationalBrandingProperties. |
| customPrivacyAndCookiesUrl | Cadena | Dirección URL personalizada para reemplazar la dirección URL predeterminada del hipervínculo "Privacidad y cookies" en el pie de página. Esta dirección URL debe estar en formato ASCII o los caracteres que no sean ASCII deben estar codificados con dirección URL y no deben superar los 128 caracteres. Se hereda de organizationalBrandingProperties. |
| customResetItNowText | Cadena | Cadena para reemplazar el texto de hipervínculo predeterminado "reset it now" en el formulario de inicio de sesión. Este texto debe estar en formato Unicode y no superar los 256 caracteres. NO USE: Actualmente no se admite la personalización del texto del hipervínculo "restablecerlo ahora". Se hereda de organizationalBrandingProperties. |
| customTermsOfUseText | Cadena | Cadena para reemplazar el texto predeterminado del hipervínculo "Términos de uso" en el pie de página. Este texto debe estar en formato Unicode y no superar los 256 caracteres. Se hereda de organizationalBrandingProperties. |
| customTermsOfUseUrl | Cadena | Dirección URL personalizada para reemplazar la dirección URL predeterminada del hipervínculo "Términos de uso" en el pie de página. Esta dirección URL debe estar en formato ASCII o los caracteres que no sean ASCII deben estar codificados con dirección URL y no deben superar los 128characters. Se hereda de organizationalBrandingProperties. |
| Favicon | Stream | Icono personalizado (favicon) para reemplazar un icono de favoritos de producto de Microsoft predeterminado en un inquilino de Microsoft Entra. Se hereda de organizationalBrandingProperties. |
| faviconRelativeUrl | Cadena | Dirección URL relativa para el icono de favoritos anterior que se combina con una dirección URL base de la red CDN de cdnList para proporcionar la versión que proporciona una red CDN. Solo lectura. Se hereda de organizationalBrandingProperties. |
| headerBackgroundColor | Cadena | Color RGB que se va a aplicar para personalizar el color del encabezado. Se hereda de organizationalBrandingProperties. |
| headerLogo | Stream | Logotipo de empresa que aparece en el encabezado de la página de inicio de sesión. Los tipos permitidos son PNG o JPEG que no superan los 245 x 36 píxeles. Se recomienda usar una imagen transparente sin relleno alrededor del logotipo. Se hereda de organizationalBrandingProperties. |
| headerLogoRelativeUrl | Cadena | Dirección URL relativa de la propiedad headerLogo que se combina con una dirección URL base de cdN de cdnList para proporcionar la versión de solo lectura que proporciona una red CDN. Solo lectura. Se hereda de organizationalBrandingProperties. |
| id | Cadena | Identificador que representa la configuración regional especificada mediante nombres de referencia cultural. Los nombres de referencia cultural siguen el estándar RFC 1766 con el formato "languagecode2-country/regioncode2", donde "languagecode2" es un código de dos letras minúscula derivado de ISO 639-1 y "country/regioncode2" es un código de dos letras en mayúsculas derivado de ISO 3166. Por ejemplo, el inglés de EE. UU. es en-US. El identificador del valor predeterminado /branding es siempre los tipos 0 String o default. Solo lectura. NOTA: Actualmente no se admite la personalización de marca de varias configuraciones regionales. |
| loginPageLayoutConfiguration | loginPageLayoutConfiguration | Representa la configuración de diseño que se mostrará en la página de inicio de sesión de un inquilino. Se hereda de organizationalBrandingProperties. |
| loginPageTextVisibilitySettings | loginPageTextVisibilitySettings | Representa los distintos textos que se pueden ocultar en la página de inicio de sesión de un inquilino. Se hereda de organizationalBrandingProperties. |
| signInPageText | Cadena | Texto que aparece en la parte inferior del cuadro de inicio de sesión. Use esta opción para comunicar información adicional, como el número de teléfono al departamento de soporte técnico o una declaración legal. Este texto debe estar en formato Unicode y no superar los 1024 caracteres. |
| squareLogo | Stream | Una versión cuadrada del logotipo de la empresa que aparece en Windows 10 experiencias integradas (OOBE) y cuando Windows Autopilot está habilitado para la implementación. Los tipos permitidos son PNG o JPEG que no superan los 240 x 240 píxeles y no tienen un tamaño superior a 10 KB. Se recomienda usar una imagen transparente sin relleno alrededor del logotipo. Se hereda de organizationalBrandingProperties. |
| squareLogoRelativeUrl | Cadena | Dirección URL relativa de la propiedad squareLogo que se combina con una dirección URL base de la red CDN de cdnList para proporcionar la versión que proporciona una red CDN. Solo lectura. Se hereda de organizationalBrandingProperties. |
| squareLogoDark | Stream | Una versión cuadrada y oscura del logotipo de la empresa que aparece en Windows 10 experiencias integradas (OOBE) y cuando Windows Autopilot está habilitado para la implementación. Los tipos permitidos son PNG o JPEG que no superan los 240 x 240 píxeles y no tienen un tamaño superior a 10 KB. Se recomienda usar una imagen transparente sin relleno alrededor del logotipo. Se hereda de organizationalBrandingProperties. |
| squareLogoDarkRelativeUrl | Cadena | Dirección URL relativa de la propiedad squareLogoDark que se combina con una dirección URL base de la red CDN de cdnList para proporcionar la versión que proporciona una red CDN. Solo lectura. Se hereda de organizationalBrandingProperties. |
| usernameHintText | Cadena | Cadena que se muestra como sugerencia en el cuadro de texto nombre de usuario de la pantalla de inicio de sesión. Este texto debe ser Unicode, sin vínculos ni código, y no puede superar los 64 caracteres. Se hereda de organizationalBrandingProperties. |
Relaciones
| Relación | Tipo | Descripción |
|---|---|---|
| Localizaciones | Colección organizationalBrandingLocalization | Agregue una personalización de marca diferente en función de una configuración regional. |
Representación JSON
La siguiente es una representación JSON del recurso
{
"@odata.type": "#microsoft.graph.organizationalBranding",
"id": "String (identifier)",
"backgroundColor": "String",
"backgroundImage": "Stream",
"backgroundImageRelativeUrl": "String",
"bannerLogo": "Stream",
"bannerLogoRelativeUrl": "String",
"cdnList": [
"String"
],
"signInPageText": "String",
"squareLogo": "Stream",
"squareLogoRelativeUrl": "String",
"squareLogoDark": "Stream",
"squareLogoDarkRelativeUrl": "String",
"usernameHintText": "String",
"contentCustomization": {
"@odata.type": "microsoft.graph.contentCustomization"
},
"customAccountResetCredentialsUrl": "String",
"customCannotAccessYourAccountText": "String",
"customCannotAccessYourAccountUrl": "String",
"customCSS": "Stream",
"customCSSRelativeUrl": "String",
"customForgotMyPasswordText": "String",
"customPrivacyAndCookiesText": "String",
"customPrivacyAndCookiesUrl": "String",
"customResetItNowText": "String",
"customTermsOfUseText": "String",
"customTermsOfUseUrl": "String",
"favicon": "Stream",
"faviconRelativeUrl": "String",
"headerBackgroundColor": "String",
"headerLogo": "Stream",
"headerLogoRelativeUrl": "String",
"loginPageLayoutConfiguration": {
"@odata.type": "microsoft.graph.loginPageLayoutConfiguration"
},
"loginPageTextVisibilitySettings": {
"@odata.type": "microsoft.graph.loginPageTextVisibilitySettings"
}
}
Comentarios
Próximamente: A lo largo de 2024 iremos eliminando gradualmente GitHub Issues como mecanismo de comentarios sobre el contenido y lo sustituiremos por un nuevo sistema de comentarios. Para más información, vea: https://aka.ms/ContentUserFeedback.
Enviar y ver comentarios de