Obter organizationalBranding

  • Artigo

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.

Recupere o objeto de identidade visual organizacional padrão, se o cabeçalho Accept-Language estiver definido como 0 ou default. Se nenhum objeto de identidade visual organizacional padrão existir, esse método retornará um 404 Not Found erro.

Se o cabeçalho Accept-Language for definido como uma localidade existente identificada pelo valor de sua id, esse método recuperará a identidade visual da localidade especificada.

Esse método recupera apenas propriedades não Stream, por exemplo, nome de usuárioHintText e signInPageText. Para recuperar Stream tipos da identidade visual padrão, por exemplo, bannerLogo e backgroundImage, use o método GET organizationalBrandingLocalization.

Essa API está disponível nas seguintes implantações nacionais de nuvem.

Serviço global Governo dos EUA L4 GOVERNO DOS EUA L5 (DOD) China operada pela 21Vianet
✅ ✅ ✅ ✅

Permissões

Escolha a permissão ou as permissões marcadas como menos privilegiadas para essa API. Use uma permissão ou permissões privilegiadas mais altas somente se o aplicativo exigir. Para obter detalhes sobre permissões delegadas e de aplicativo, consulte Tipos de permissão. Para saber mais sobre essas permissões, consulte a referência de permissões.

Tipo de permissão Permissões menos privilegiadas Permissões privilegiadas mais altas
Delegado (conta corporativa ou de estudante) User.Read Organization.Read.All, OrganizationalBranding.Read.All, OrganizationalBranding.ReadWrite.All, User.Read.All
Delegado (conta pessoal da Microsoft) Sem suporte. Sem suporte.
Aplicativo OrganizationalBranding.Read.All Organization.Read.All, OrganizationalBranding.ReadWrite.All

Para cenários delegados, o usuário conectado deve ter pelo menos a função Leitor Global ou Administrador de Branding OrganizacionalMicrosoft Entra função.

Solicitação HTTP

GET /organization/{organizationId}/branding

Parâmetros de consulta opcionais

Esse método dá suporte apenas ao $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 localidade iso 639-1 válida ou 0 para a localidade padrão. Obrigatório.

Corpo da solicitação

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

Resposta

Se for bem-sucedido, esse método retornará um 200 OK código de resposta e um objeto organizationalBranding no corpo da resposta. Se nenhum objeto de identidade visual padrão existir, esse método retornará um código de 404 Not Found resposta.

Exemplos

Exemplo 1: Obter a identidade visual padrão

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 identidade visual organizacional quando nenhuma identidade visual estiver configurada

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 identidade visual organizacional para a localidade francesa

No exemplo a seguir, o cabeçalho Accept-Language é usado para especificar para recuperar a marca de fr-FR 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 localidade padrão

O exemplo a seguir retorna o objeto bannerLogo para a localidade padrão. Para recuperar Stream tipos de objeto, por exemplo, bannerLogo, use o Get organizationalBrandingLocalizationmethod. Você pode especificar o valor da ID como default ou 0 na URL de solicitação. Se a propriedade não estiver definida, a solicitação retornará 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 localidade padrão quando ele não estiver definido

O exemplo a seguir retorna o objeto bannerLogo que não havia sido definido para a localidade padrão.

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

{}