Compartir a través de

Obtener organizationalBrandingLocalization

  • Artículo

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.

Lea las propiedades y relaciones de un objeto organizationalBrandingLocalization . Para recuperar un objeto de personalización de marca de localización, especifique el valor de id en la dirección URL.

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) User.Read Organization.Read.All, Organization.ReadWrite.All, OrganizationalBranding.Read.All, OrganizationalBranding.ReadWrite.All, User.Read.All
Delegado (cuenta personal de Microsoft) No admitida. No admitida.
Aplicación OrganizationalBranding.Read.All Organization.Read.All, Organization.ReadWrite.All, OrganizationalBranding.ReadWrite.All

Importante

En escenarios delegados con cuentas profesionales o educativas, al usuario que ha iniciado sesión se le debe asignar un rol de Microsoft Entra compatible o un rol personalizado con un permiso de rol admitido. Lector global o administrador de personalización de marca de la organización son los roles con privilegios mínimos admitidos para esta operación.

Solicitud HTTP

GET /organization/{organizationId}/branding/localizations/{organizationalBrandingLocalizationId}

Encabezados de solicitud

Nombre Descripción
Authorization {token} de portador. Obligatorio. Obtenga más información sobre la autenticación y la autorización.

Cuerpo de la solicitud

No proporcione un cuerpo de solicitud para este método.

Respuesta

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

Ejemplos

Ejemplo 1: Obtener la personalización de marca localizada para una configuración regional específica (fr-FR)

Solicitud

En el ejemplo siguiente se muestra la solicitud.

GET https://graph.microsoft.com/beta/organization/d69179bf-f4a4-41a9-a9de-249c0f2efb1d/branding/localizations/fr-FR

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 200 OK
Content-Type: application/json

{
    "@odata.context": "https://graph.microsoft.com/beta/$metadata#organization('99b24e1b-abec-4598-9d63-a2baf0a3cea1')/branding/localizations/$entity",
    "@odata.type": "#microsoft.graph.organizationalBrandingProperties",
    "@odata.id": "https://graph.microsoft.com/v2/99b24e1b-abec-4598-9d63-a2baf0a3cea1/directoryObjects/$/Microsoft.DirectoryServices.Organization('99b24e1b-abec-4598-9d63-a2baf0a3cea1')//localizations('fr-FR')/fr-FR",
    "id": "fr-FR",
    "backgroundColor": " ",
    "backgroundImageRelativeUrl": null,
    "bannerLogoRelativeUrl": "c1c6b6c8-urr-dzbkz44n5kuo9kzl1kziuujjcdqonoe2owyacso/logintenantbranding/1036/bannerlogo?ts=637673868626068858",
    "cdnList": [
        "secure.aadcdn.microsoftonline-p.com",
        "aadcdn.msftauthimages.net",
        "aadcdn.msauthimages.net"
    ],
    "contentCustomization": {
      "attributeCollectionRelativeUrl": "dbd5a2dd-dt17xdjgu8kxc14xcav-rckknamct7yytiih-vm-ksm/logintenantbranding/1033/attributecollection?ts=638151133931615483",
      "attributeCollection": [
            {
                "key": "AttributeCollection_Description",
                "value": "We just need a little more information to set up your account."
            },
            {
                "key": "AttributeCollection_Title",
                "value": "Add details"
            },
            {
                "key": "Attribute_City",
                "value": "City"
            },
            {
                "key": "Attribute_Country",
                "value": "Country/Region"
            },
            {
                "key": "Attribute_DisplayName",
                "value": "Display Name"
            },
            {
                "key": "Attribute_Email",
                "value": "Email Address"
            },
            {
                "key": "Attribute_Generic_ConfirmationLabel",
                "value": "Re-enter"
            },
            {
                "key": "Attribute_GivenName",
                "value": "Given Name"
            },
            {
                "key": "Attribute_JobTitle",
                "value": "Job Title"
            },
            {
                "key": "Attribute_Password",
                "value": "Password"
            },
            {
                "key": "Attribute_Password_MismatchErrorString",
                "value": "Passwords do not match."
            },
            {
                "key": "Attribute_PostalCode",
                "value": "Postal Code"
            },
            {
                "key": "Attribute_State",
                "value": "State/Province"
            },
            {
                "key": "Attribute_StreetAddress",
                "value": "Street Address"
            },
            {
                "key": "Attribute_Surname",
                "value": "Sasha Surname"
            },
            {
                "key": "SignIn_Description",
                "value": "Sign in to access"
            },
            {
                "key": "SignIn_Title",
                "value": "Sign in"
            },
            {
                "key": "SignUp_Description",
                "value": "Sign up to access"
            },
            {
                "key": "SignUp_Title",
                "value": "Create account"
            },
            {
                "key": "SisuOtc_Title",
                "value": "Enter code"
            },
            {
                "key": "Attribute_extension_82936c774db949fcac549215e8857017_Total_Job_Experience_Years",
                "value": "Total_Job_Experience_Years"
            }
        ]
    },     
    "customAccountResetCredentialsUrl": null,
    "customCannotAccessYourAccountText": null,
    "customCannotAccessYourAccountUrl": null,
    "customCSS": null,
    "customCSSRelativetUrl": null,
    "customForgotMyPasswordText": null,
    "customPrivacyAndCookiesText": null,
    "customPrivacyAndCookiesUrl": null,
    "customTermsOfUseText": null,
    "customTermsOfUseUrl": null,
    "customResetItNowText": null,
    "faviconRelativeUrl": null,
    "headerBackgroundColor": null,
    "headerLogoRelativeUrl": null,
    "signInPageText": "Contoso",
    "squareLogoRelativeUrl": "c1c6b6c8-urr-dzbkz44n5kuo9kzl1kziuujjcdqonoe2owyacso/logintenantbranding/0/tilelogo?ts=637535563832888580",
    "squareLogoDarkRelativeUrl": "c1c6b6c8-urr-dzbkz44n5kuo9kzl1kziuujjcdqonoe2owyacso/logintenantbranding/0/tilelogo?ts=637535563832888580",    
    "usernameHintText": " ",
    "loginPageLayoutConfiguration": {
      "layoutTemplateType": "default",
      "isHeaderShown": false,
      "isFooterShown": true
    },
    "loginPageTextVisibilitySettings": {
      "hideCannotAccessYourAccount": false,
      "hideForgotMyPassword": false,
      "hideResetItNow": false,
      "hideTermsOfUse": true,
      "hidePrivacyAndCookies": true
    }
}

Ejemplo 2: Obtener el valor de signInPageText para una configuración regional específica

Solicitud

En el ejemplo siguiente se muestra la solicitud.

GET https://graph.microsoft.com/beta/organization/99b24e1b-abec-4598-9d63-a2baf0a3cea1/branding/localizations/fr-FR/signInPageText

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 200 OK
Content-Type: application/json

{
    "@odata.context": "https://graph.microsoft.com/beta/$metadata#organization('99b24e1b-abec-4598-9d63-a2baf0a3cea1')/branding/localizations('fr-FR')/usernameHintText",
    "value": "Welcome to Contoso France"
}

Ejemplo 3: Obtener el bannerLogo para la configuración regional predeterminada

En el ejemplo siguiente se devuelve el objeto bannerLogo para la configuración regional predeterminada. Puede especificar el identificador como default o 0 en la dirección URL de la solicitud. Si no se establece el objeto, la solicitud devuelve una respuesta vacía.

Solicitud

En el ejemplo siguiente se muestra la solicitud.

GET https://graph.microsoft.com/beta/organization/d69179bf-f4a4-41a9-a9de-249c0f2efb1d/branding/localizations/default/bannerLogo

Respuesta

En el ejemplo siguiente se muestra la respuesta.

HTTP/1.1 200 OK
Content-Type: image/*

<Image>

Ejemplo 4: Obtener el bannerLogo para la configuración regional fr-FR

En el ejemplo siguiente se devuelve el objeto bannerLogo para la fr-FR configuración regional cuyo bannerLogo no está establecido.

Solicitud

En el ejemplo siguiente se muestra la solicitud.

GET https://graph.microsoft.com/beta/organization/d69179bf-f4a4-41a9-a9de-249c0f2efb1d/branding/localizations/default/bannerLogo

Respuesta

En el ejemplo siguiente se muestra la respuesta.

HTTP/1.1 200 OK

{}