Partilhar via


Obter organizationalBranding

Namespace: microsoft.graph

Importante

As APIs na versão /beta no Microsoft Graph estão sujeitas a alterações. Não há suporte para o uso dessas APIs em aplicativos de produção. Para determinar se uma API está disponível na v1.0, use o seletor Versão.

Obtenha o objeto de imagem corporativa organizacional predefinido, se o cabeçalho Accept-Language estiver definido como 0 ou default. Se não existir nenhum objeto de imagem corporativa organizacional predefinido, este método devolve um 404 Not Found erro.

Se o cabeçalho Accept-Language estiver definido para uma região existente identificada pelo valor do respetivo ID, este método obtém a imagem corporativa da região especificada.

Este método obtém apenas propriedades não Stream, por exemplo, usernameHintText e signInPageText. Para obter Stream tipos de imagem corporativa predefinida, por exemplo, bannerLogo e backgroundImage, utilize o método GET organizationalBrandingLocalization.

Esta API está disponível nas seguintes implementações de cloud nacionais.

Serviço global US Government L4 US Government L5 (DOD) China operada pela 21Vianet

Permissões

Escolha a permissão ou permissões marcadas como menos privilegiadas para esta API. Utilize uma permissão ou permissões com privilégios mais elevados apenas se a sua aplicação o exigir. Para obter detalhes sobre as permissões delegadas e de aplicação, veja Tipos de permissão. Para saber mais sobre estas permissões, veja a referência de permissões.

Tipo de permissão Permissões com menos privilégios Permissões com privilégios superiores
Delegado (conta corporativa ou de estudante) User.Read Organization.Read.All, Organization.ReadWrite.All, OrganizationalBranding.Read.All, OrganizationalBranding.ReadWrite.All, User.Read.All
Delegado (conta pessoal da Microsoft) Sem suporte. Sem suporte.
Application OrganizationalBranding.Read.All Organization.Read.All, Organization.ReadWrite.All, OrganizationalBranding.ReadWrite.All

Importante

Em cenários delegados com contas escolares ou profissionais, o utilizador com sessão iniciada tem de ter uma função de Microsoft Entra suportada ou uma função personalizada com uma permissão de função suportada. O Leitor Global ou o Administrador de Imagem Corporativa Organizacional são as funções com menos privilégios suportadas para esta operação.

Solicitação HTTP

GET /organization/{organizationId}/branding

Parâmetros de consulta opcionais

Este método suporta apenas o $select parâmetro de consulta OData para ajudar a personalizar a resposta. Para obter informações gerais, acesse Parâmetros de consulta OData.

Cabeçalhos de solicitação

Nome Descrição
Autorização {token} de portador. Obrigatório. Saiba mais sobre autenticação e autorização.
Accept-Language Uma região ISO 639-1 válida ou 0 para a região predefinida. Obrigatório.

Corpo da solicitação

Não forneça um corpo de solicitação para esse método.

Resposta

Se for bem-sucedido, este método devolve um 200 OK código de resposta e um objeto organizationalBranding no corpo da resposta. Se não existir nenhum objeto de imagem corporativa predefinido, este método devolve um 404 Not Found código de resposta.

Exemplos

Exemplo 1: Obter a imagem corporativa predefinida

Solicitação

O exemplo a seguir mostra uma solicitação.

GET https://graph.microsoft.com/beta/organization/84841066-274d-4ec0-a5c1-276be684bdd3/branding
Accept-Language: 0

Resposta

O exemplo a seguir mostra a resposta.

Observação: o objeto de resposta mostrado aqui pode ser encurtado para legibilidade.

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

{
    "@odata.context": "https://graph.microsoft.com/beta/$metadata#branding",
    "@odata.id": "https://graph.microsoft.com/v2/99b24e1b-abec-4598-9d63-a2baf0a3cea1/directoryObjects/$/Microsoft.DirectoryServices.Organization('99b24e1b-abec-4598-9d63-a2baf0a3cea1')/branding/0",
    "id": "0",
    "backgroundColor": " ",
    "backgroundImageRelativeUrl": "c1c6b6c8-urr-dzbkz44n5kuo9kzl1kziuujjcdqonoe2owyacso/logintenantbranding/0/illustration?ts=637535563816027796",
    "bannerLogoRelativeUrl": "c1c6b6c8-urr-dzbkz44n5kuo9kzl1kziuujjcdqonoe2owyacso/logintenantbranding/0/bannerlogo?ts=637535563824629275",
    "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": null,
    "usernameHintText": " ",
    "loginPageLayoutConfiguration": {
      "layoutTemplateType": "default",
      "isHeaderShown": false,
      "isFooterShown": true
    },
    "loginPageTextVisibilitySettings": {
      "hideCannotAccessYourAccount": false,
      "hideForgotMyPassword": false,
      "hideResetItNow": false,
      "hideTermsOfUse": true,
      "hidePrivacyAndCookies": true
    }
}

Exemplo 2: obter a imagem corporativa organizacional quando não está configurada nenhuma imagem corporativa

Solicitação

O exemplo a seguir mostra uma solicitação.

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

Resposta

O exemplo a seguir mostra a resposta.

HTTP/1.1 404 Not Found

Exemplo 3: Obter imagem corporativa organizacional para a região francesa

No exemplo seguinte, o cabeçalho Accept-Language é utilizado para especificar para obter a fr-FR imagem corporativa de localização.

Solicitação

O exemplo a seguir mostra uma solicitação.

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

Resposta

O exemplo a seguir mostra a resposta.

Observação: o objeto de resposta mostrado aqui pode ser encurtado para legibilidade.

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

{
    "@odata.context": "https://graph.microsoft.com/beta/$metadata#branding",
    "@odata.id": "https://graph.microsoft.com/v2/84841066-274d-4ec0-a5c1-276be684bdd3/directoryObjects/$/Microsoft.DirectoryServices.Organization('84841066-274d-4ec0-a5c1-276be684bdd3')/branding/fr-FR",
    "id": "fr-FR",
    "backgroundColor": "#FFFF33",
    "backgroundImageRelativeUrl": null,
    "bannerLogoRelativeUrl": null,
    "cdnList": [],
    "signInPageText": " ",
    "squareLogoRelativeUrl": null,
    "squareLogoDarkRelativeUrl": null,
    "usernameHintText": " "
}

Exemplo 4: Obter o bannerLogo para a região predefinida

O exemplo seguinte devolve o objeto bannerLogo para a região predefinida. Para obter Stream tipos de objetos, por exemplo, bannerLogo, utilize Get organizationalBrandingLocalizationmethod. Pode especificar o valor do ID como default ou 0 no URL do pedido. Se a propriedade não estiver definida, o pedido devolve uma resposta vazia.

Solicitação

O exemplo a seguir mostra uma solicitação.

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

Resposta

O exemplo a seguir mostra a resposta.

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

<Image>

Exemplo 5: Obter o bannerLogo para a região predefinida quando não está definido

O exemplo seguinte devolve o objeto bannerLogo que não tinha sido definido para a região predefinida.

Solicitação

O exemplo a seguir mostra uma solicitação.

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

Resposta

O exemplo a seguir mostra a resposta.

HTTP/1.1 200 OK

{}