Skip to content

organizationalbranding-get.md

Latest commit

 

History

History
496 lines (389 loc) · 17.6 KB

organizationalbranding-get.md

File metadata and controls

496 lines (389 loc) · 17.6 KB
title Get organizationalBranding
description Read the properties and relationships of an organizationalBranding object.
author nanguil
ms.localizationpriority medium
ms.subservice entra-sign-in
doc_type apiPageType
ms.date 04/05/2024

Get organizationalBranding

Namespace: microsoft.graph

[!INCLUDE beta-disclaimer]

Retrieve the default organizational branding object, if the Accept-Language header is set to 0 or default. If no default organizational branding object exists, this method returns a 404 Not Found error.

If the Accept-Language header is set to an existing locale identified by the value of its id, this method retrieves the branding for the specified locale.

This method retrieves only non-Stream properties, for example, usernameHintText and signInPageText. To retrieve Stream types of the default branding, for example, bannerLogo and backgroundImage, use the GET organizationalBrandingLocalization method.

[!INCLUDE national-cloud-support]

Permissions

Choose the permission or permissions marked as least privileged for this API. Use a higher privileged permission or permissions only if your app requires it. For details about delegated and application permissions, see Permission types. To learn more about these permissions, see the permissions reference.

[!INCLUDE permissions-table]

[!INCLUDE rbac-org-branding-apis-read]

HTTP request

GET /organization/{organizationId}/branding

Optional query parameters

This method supports only the $select OData query parameter to help customize the response. For general information, see OData query parameters.

Request headers

Name Description
Authorization Bearer {token}. Required. Learn more about authentication and authorization.
Accept-Language A valid ISO 639-1 locale or 0 for the default locale. Required.

Request body

Don't supply a request body for this method.

Response

If successful, this method returns a 200 OK response code and an organizationalBranding object in the response body. If no default branding object exists, this method returns a 404 Not Found response code.

Examples

Example 1: Get the default branding

Request

The following example shows a request.

HTTP

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

C#

[!INCLUDE sample-code] [!INCLUDE sdk-documentation]

Go

[!INCLUDE sample-code] [!INCLUDE sdk-documentation]

Java

[!INCLUDE sample-code] [!INCLUDE sdk-documentation]

JavaScript

[!INCLUDE sample-code] [!INCLUDE sdk-documentation]

PHP

[!INCLUDE sample-code] [!INCLUDE sdk-documentation]

PowerShell

[!INCLUDE sample-code] [!INCLUDE sdk-documentation]

Python

[!INCLUDE sample-code] [!INCLUDE sdk-documentation]

Response

The following example shows the response.

Note: The response object shown here might be shortened for readability.

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
    }
}

Example 2: Get organizational branding when no branding is configured

Request

The following example shows a request.

HTTP

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

C#

[!INCLUDE sample-code] [!INCLUDE sdk-documentation]

Go

[!INCLUDE sample-code] [!INCLUDE sdk-documentation]

Java

[!INCLUDE sample-code] [!INCLUDE sdk-documentation]

JavaScript

[!INCLUDE sample-code] [!INCLUDE sdk-documentation]

PHP

[!INCLUDE sample-code] [!INCLUDE sdk-documentation]

PowerShell

[!INCLUDE sample-code] [!INCLUDE sdk-documentation]

Python

[!INCLUDE sample-code] [!INCLUDE sdk-documentation]

Response

The following example shows the response.

HTTP/1.1 404 Not Found

Example 3: Get organizational branding for the French locale

In the following example, the Accept-Language header is used to specify to retrieve the fr-FR localization branding.

Request

The following example shows a request.

HTTP

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

C#

[!INCLUDE sample-code] [!INCLUDE sdk-documentation]

Go

[!INCLUDE sample-code] [!INCLUDE sdk-documentation]

Java

[!INCLUDE sample-code] [!INCLUDE sdk-documentation]

JavaScript

[!INCLUDE sample-code] [!INCLUDE sdk-documentation]

PHP

[!INCLUDE sample-code] [!INCLUDE sdk-documentation]

PowerShell

[!INCLUDE sample-code] [!INCLUDE sdk-documentation]

Python

[!INCLUDE sample-code] [!INCLUDE sdk-documentation]

Response

The following example shows the response.

Note: The response object shown here might be shortened for readability.

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": " "
}

Example 4: Get the bannerLogo for the default locale

The following example returns the bannerLogo object for the default locale. To retrieve Stream object types for example, bannerLogo, use the Get organizationalBrandingLocalizationmethod. You may specify the value of id as default or 0 in the request URL. If the property isn't set, the request returns an empty response.

Request

The following example shows a request.

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

Response

The following example shows the response.

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

<Image>

Example 5: Get the bannerLogo for the default locale when it isn't set

The following example returns the bannerLogo object that hadn't been set for the default locale.

Request

The following example shows a request.

HTTP

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

C#

[!INCLUDE sample-code] [!INCLUDE sdk-documentation]

Go

[!INCLUDE sample-code] [!INCLUDE sdk-documentation]

Java

[!INCLUDE sample-code] [!INCLUDE sdk-documentation]

JavaScript

[!INCLUDE sample-code] [!INCLUDE sdk-documentation]

PHP

[!INCLUDE sample-code] [!INCLUDE sdk-documentation]

PowerShell

[!INCLUDE sample-code] [!INCLUDE sdk-documentation]

Python

[!INCLUDE sample-code] [!INCLUDE sdk-documentation]

Response

The following example shows the response.

HTTP/1.1 200 OK

{}