Obtener organizationalBrandingPropertiesGet organizationalBrandingProperties

Recupere las propiedades y las relaciones de un objeto organizationalBrandingProperties.Retrieve the properties and relationships of an organizationalBrandingProperties object.

PermisosPermissions

Se requiere uno de los siguientes permisos para llamar a esta API. Para obtener más información, incluido cómo elegir permisos, vea Permisos.One of the following permissions is required to call this API. To learn more, including how to choose permissions, see Permissions.

Tipo de permisoPermission type Permisos (de menos a más privilegiados)Permissions (from least to most privileged)
Delegado (cuenta profesional o educativa)Delegated (work or school account) Organization.Read.All, User.Read, User.Read.All, User.ReadBasic.AllOrganization.Read.All, User.Read, User.Read.All, User.ReadBasic.All
Delegado (cuenta personal de Microsoft)Delegated (personal Microsoft account) No admitida.Not supported.
AplicaciónApplication No admitida.Not supported.

Solicitud HTTPHTTP request

GET /organization/{tenant id}/branding/{property name}

Encabezados de solicitudRequest headers

NombreName DescripciónDescription
AuthorizationAuthorization {token} de portador. Obligatorio.Bearer {token}. Required.

Nota

Si prueba la consulta en Graph Explorer, también debe incluir el encabezado de solicitud Accept-Language con una configuración regional ISO-639 válida.If you try the query in Graph Explorer, you must also include the Accept-Language request header with a valid ISO-639 locale.

Cuerpo de la solicitudRequest body

No proporcione un cuerpo de solicitud para este método.Do not supply a request body for this method.

RespuestaResponse

Si se realiza correctamente, este método devuelve un código 200 OK de respuesta y el objeto organizationalBrandingProperties solicitado en el cuerpo de la respuesta.If successful, this method returns a 200 OK response code and the requested organizationalBrandingProperties object in the response body.

EjemplosExamples

Ejemplo 1: Obtener la personalidad de marca predeterminadaExample 1: Get the default branding

Nota

Si intenta el ejemplo en el Explorador de Graph, también debe incluir el encabezado de solicitud Accept-Language con una configuración regional ISO-639 válida para evitar obtener un error " Valor de identificador de configuración regional no válido en-US,en;q=0.9. Debe ser una configuración regional ISO-639 válida."If you try the example in Graph Explorer, you must also include the Accept-Language request header with a valid ISO-639 locale to avoid getting an error "Invalid locale id value en-US,en;q=0.9. It must be a valid ISO-639 locale."

SolicitudRequest

Aquí tiene un ejemplo de la solicitud.The following is an example of the request.

GET https://graph.microsoft.com/v1.0/organization/d69179bf-f4a4-41a9-a9de-249c0f2efb1d/branding

RespuestaResponse

Aquí tiene un ejemplo de la respuesta.The following is an example of the response.

Nota: Se puede acortar el objeto de respuesta que se muestra aquí para mejorar la legibilidad.Note: The response object shown here might be shortened for readability.

HTTP/1.1 200 OK
Content-Type: application/json

{
  "backgroundColor":"#FFFF33",
  "backgroundImage@odata.mediaContentType":"image/*",
  "backgroundImage@odata.mediaReadLink": "https://graph.microsoft.com/v1.0/organization/d69179bf-f4a4-41a9-a9de-249c0f2efb1d/branding/backgroundImage",
  "backgroundImage@odata.mediaEditLink": "https://graph.microsoft.com/v1.0/organization/d69179bf-f4a4-41a9-a9de-249c0f2efb1d/branding/backgroundImage",
  "bannerLogo@odata.mediaContentType":"image/*",
  "bannerLogo@odata.mediaReadLink": "https://graph.microsoft.com/v1.0/organization/d69179bf-f4a4-41a9-a9de-249c0f2efb1d/branding/bannerLogo",
  "bannerLogo@odata.mediaEditLink": "https://graph.microsoft.com/v1.0/organization/d69179bf-f4a4-41a9-a9de-249c0f2efb1d/branding/bannerLogo",
  "id": "und",
  "squareLogo@odata.mediaContentType":"image/*",
  "squareLogo@odata.mediaReadLink": "https://graph.microsoft.com/v1.0/organization/d69179bf-f4a4-41a9-a9de-249c0f2efb1d/branding/squareLogo",
  "squareLogo@odata.mediaEditLink": "https://graph.microsoft.com/v1.0/organization/d69179bf-f4a4-41a9-a9de-249c0f2efb1d/branding/squareLogo",
  "signInPageText":"Default",
  "usernameHintText":"DefaultHint"
}

Las solicitudes de /branding siempre devuelven las propiedades mediaContentType, mediaReadLink y mediaEditLink.Requests for /branding always return the mediaContentType, mediaReadLink, and mediaEditLink properties. Si se ha aplicado una configuración regional, mediaEditLink es el mediaEditLink para la configuración regional (que siempre es no null), y mediaReadLink y mediaContentType son el mediaReadLink y mediaContentType de la configuración regional si el mediaReadLink de la configuración regional no es null; de lo contrario, el valor predeterminado mediaReadLink y mediaContentType.If a locale has been applied, the mediaEditLink is the mediaEditLink for the locale (which is always non-null), and the mediaReadLink and mediaContentType are the mediaReadLink and mediaContentType of the locale if the mediaReadLink of the locale is non-null; otherwise, the default mediaReadLink and mediaContentType.

Ejemplo 2: Obtener personal de marca de la organización, pero sin configuración de personal de marcaExample 2: Get organizational branding but no branding configured

SolicitudRequest

Aquí tiene un ejemplo de la solicitud.The following is an example of the request.

GET https://graph.microsoft.com/v1.0/organization/d69179bf-f4a4-41a9-a9de-249c0f2efb1d/branding

RespuestaResponse

Aquí tiene un ejemplo de la respuesta.The following is an example of the response.

HTTP/1.1 404 NOT FOUND

Ejemplo 3: Obtener la personalizado de marca de la organización para la configuración regional francesaExample 3: Get organizational branding for the French locale

El encabezado Accept-Language se usa para aplicar una localización determinada a la personalización de marca.The Accept-Language header is used to apply a particular localization to the branding. Las propiedades que null se encuentran en la localización especificada se devuelven de la personalización de marca predeterminada.Properties that are null in the specified localization are returned from the default branding. Si el encabezado Accept-Language se especifica en la solicitud, la respuesta incluirá el encabezado Content-Language, a menos que sea und .If the Accept-Language header is specified in the request, the response will include the Content-Language header, unless it is und.

SolicitudRequest

Aquí tiene un ejemplo de la solicitud.The following is an example of the request.

GET https://graph.microsoft.com/v1.0/organization/d69179bf-f4a4-41a9-a9de-249c0f2efb1d/branding
Accept-Language: fr

RespuestaResponse

Aquí tiene un ejemplo de la respuesta.The following is an example of the response.

Nota: Se puede acortar el objeto de respuesta que se muestra aquí para mejorar la legibilidad.Note: The response object shown here might be shortened for readability.

HTTP/1.1 200 OK
Content-Type: application/json
Content-Language: fr

{
    "backgroundColor":"#00000F",
    "backgroundImage@odata.mediaContentType":"image/*",
    "backgroundImage@odata.mediaReadLink": "https://graph.microsoft.com/v1.0/organization/d69179bf-f4a4-41a9-a9de-249c0f2efb1d/branding/backgroundImage",
    "backgroundImage@odata.mediaEditLink": "https://graph.microsoft.com/v1.0/organization/d69179bf-f4a4-41a9-a9de-249c0f2efb1d/branding/localizations/fr/backgroundImage",
    "bannerLogo@odata.mediaContentType":"image/*",
    "bannerLogo@odata.mediaReadLink": "https://graph.microsoft.com/v1.0/organization/d69179bf-f4a4-41a9-a9de-249c0f2efb1d/branding/bannerLogo",
    "bannerLogo@odata.mediaEditLink": "https://graph.microsoft.com/v1.0/organization/d69179bf-f4a4-41a9-a9de-249c0f2efb1d/branding/localizations/fr/bannerLogo",
    "id": "und",
    "squareLogo@odata.mediaContentType":"image/*",
    "squareLogo@odata.mediaReadLink": "https://graph.microsoft.com/v1.0/organization/d69179bf-f4a4-41a9-a9de-249c0f2efb1d/branding/squareLogo",
    "squareLogo@odata.mediaEditLink": "https://graph.microsoft.com/v1.0/organization/d69179bf-f4a4-41a9-a9de-249c0f2efb1d/branding/localizations/fr/squareLogo",
    "signInPageText":"Default",
    "usernameHintText":"DefaultHint"
}

Ejemplo 4: Obtener bannerLogo para la configuración regional francesaExample 4: Get bannerLogo for the French locale

Devuelve bannerLogo para la fr configuración regional si existe.Returns bannerLogo for the fr locale if it exists. Si la localización no existe, devuelve el bannerLogo predeterminado.If the localization does not exist, returns the default bannerLogo.

SolicitudRequest

Aquí tiene un ejemplo de la solicitud.The following is an example of the request.

GET https://graph.microsoft.com/v1.0/organization/d69179bf-f4a4-41a9-a9de-249c0f2efb1d/branding/bannerLogo
Accept-Language: fr

RespuestaResponse

Aquí tiene un ejemplo de la respuesta.The following is an example of the response.

HTTP/1.1 200 OK
Content-Type: application/json

{
    "bannerLogo@odata.mediaContentType":"image/*",
    "bannerLogo@odata.mediaReadLink": "https://graph.microsoft.com/v1.0/organization/d69179bf-f4a4-41a9-a9de-249c0f2efb1d/branding/bannerLogo",
    "bannerLogo@odata.mediaEditLink": "https://graph.microsoft.com/v1.0/organization/d69179bf-f4a4-41a9-a9de-249c0f2efb1d/branding/localizations/fr/bannerLogo",
}

Ejemplo 5: Obtener bannerLogo cuando no se configura bannerLogoExample 5: Get bannerLogo when no bannerLogo is configured

En este ejemplo se muestra una solicitud de una propiedad que no existe en la personalidad de marca predeterminada o en el idioma especificado en el encabezado Accept-Language.This example shows a request for a property that does not exist on the default branding or the language specified in the Accept-Language header.

SolicitudRequest

Aquí tiene un ejemplo de la solicitud.The following is an example of the request.

GET https://graph.microsoft.com/v1.0/organization/d69179bf-f4a4-41a9-a9de-249c0f2efb1d/branding/bannerLogo
Accept-Language: de

RespuestaResponse

Este es un ejemplo de la respuesta.The following is an example of the response.

HTTP/1.1 204 NO CONTENT