List localizations

Namespace: microsoft.graph

Important

APIs under the /beta version in Microsoft Graph are subject to change. Use of these APIs in production applications is not supported. To determine whether an API is available in v1.0, use the Version selector.

Retrieve all localization branding objects, including the default branding.

This API is available in the following national cloud deployments.

Global service US Government L4 US Government L5 (DOD) China operated by 21Vianet

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.

Permission type Least privileged permissions Higher privileged permissions
Delegated (work or school account) User.Read Organization.Read.All, Organization.ReadWrite.All, OrganizationalBranding.Read.All, OrganizationalBranding.ReadWrite.All, User.Read.All
Delegated (personal Microsoft account) Not supported. Not supported.
Application OrganizationalBranding.Read.All Organization.Read.All, Organization.ReadWrite.All, OrganizationalBranding.ReadWrite.All

In delegated scenarios with work or school accounts, the signed-in user must be assigned a supported Microsoft Entra role or a custom role with a supported role permission. Global Reader or Organizational Branding Administrator are the least privileged roles supported for this operation.

HTTP request

GET /organization/{organizationId}/branding/localizations

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.

Request body

Don't supply a request body for this method.

Response

If successful, this method returns a 200 OK response code and a collection of organizationalBrandingLocalization objects in the response body.

Examples

Request

The following example shows a request.

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

Response

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

{
    "@odata.context": "https://graph.microsoft.com/beta/$metadata#organization('84841066-274d-4ec0-a5c1-276be684bdd3')/branding/localizations",
    "value": [
        {
            "@odata.id": "https://graph.microsoft.com/v2/84841066-274d-4ec0-a5c1-276be684bdd3/directoryObjects/$/Microsoft.DirectoryServices.Organization('84841066-274d-4ec0-a5c1-276be684bdd3')//localizations/0",
            "id": "0",
            "backgroundColor": " ",
            "backgroundImageRelativeUrl": "c1c6b6c8-ctwpxrbizfcsectmtir3yvna3hrhaib9j7ueqv0ldne/logintenantbranding/0/illustration?ts=637635061764954395",
            "bannerLogoRelativeUrl": "c1c6b6c8-ctwpxrbizfcsectmtir3yvna3hrhaib9j7ueqv0ldne/logintenantbranding/0/bannerlogo?ts=637635061773126717",
            "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": []
             },            
            "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
            }
        },
        {
            "@odata.id": "https://graph.microsoft.com/v2/84841066-274d-4ec0-a5c1-276be684bdd3/directoryObjects/$/Microsoft.DirectoryServices.Organization('84841066-274d-4ec0-a5c1-276be684bdd3')//localizations/fr",
            "id": "fr",
            "backgroundColor": "#FFFF33",
            "backgroundImageRelativeUrl": null,
            "bannerLogoRelativeUrl": null,
            "cdnList": [],
            "contentCustomization": {
              "attributeCollectionRelativeUrl": "dbd5a2dd-dt17xdjgu8kxc14xcav-rckknamct7yytiih-vm-ksm/logintenantbranding/1033/attributecollection?ts=638151133931615483",
              "attributeCollection": []
             },             
            "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
            }
        }
    ]
}