Obtenir organizationalBranding

2024-04-04

Espace de noms: microsoft.graph

Récupérez l’objet de marque d’organisation par défaut, si l’en-tête Accept-Language est défini sur 0 ou default. S’il n’existe aucun objet de marque d’organisation par défaut, cette méthode renvoie une 404 Not Found erreur.

Si l’en-tête Accept-Language est défini sur des paramètres régionaux existants identifiés par la valeur de son ID, cette méthode récupère la personnalisation des paramètres régionaux spécifiés.

Cette méthode récupère uniquement les propriétés non Stream, par exemple usernameHintText et signInPageText. Pour récupérer Stream types de la personnalisation par défaut, par exemple bannerLogo et backgroundImage, utilisez la méthode GET organizationalBrandingLocalization.

Cette API est disponible dans les déploiements de cloud national suivants.

Service global	Gouvernement des États-Unis L4	Us Government L5 (DOD)	Chine gérée par 21Vianet
✅	✅	✅	✅

Autorisations

Choisissez l’autorisation ou les autorisations marquées comme moins privilégiées pour cette API. Utilisez une autorisation ou des autorisations privilégiées plus élevées uniquement si votre application en a besoin. Pour plus d’informations sur les autorisations déléguées et d’application, consultez Types d’autorisations. Pour en savoir plus sur ces autorisations, consultez les informations de référence sur les autorisations.

Type d’autorisation	Autorisations avec privilèges minimum	Autorisations privilégiées plus élevées
Déléguée (compte professionnel ou scolaire)	User.Read	Organization.Read.All, Organization.ReadWrite.All, OrganizationalBranding.Read.All, OrganizationalBranding.ReadWrite.All, User.Read.All
Déléguée (compte Microsoft personnel)	Non prise en charge.	Non prise en charge.
Application	OrganizationalBranding.Read.All	Organization.Read.All, Organization.ReadWrite.All, OrganizationalBranding.ReadWrite.All

Importante

Dans les scénarios délégués avec des comptes professionnels ou scolaires, l’utilisateur connecté doit se voir attribuer un rôle Microsoft Entra pris en charge ou un rôle personnalisé avec une autorisation de rôle prise en charge. Lecteur général ou Administrateur de la marque organisationnelle sont les rôles les moins privilégiés pris en charge pour cette opération.

Requête HTTP

GET /organization/{organizationId}/branding

Paramètres facultatifs de la requête

Cette méthode prend uniquement en charge le $select paramètre de requête OData pour vous aider à personnaliser la réponse. Pour des informations générales, consultez paramètres de la requête OData.

En-têtes de demande

Nom	Description
Autorisation	Porteur {token}. Obligatoire. En savoir plus sur l’authentification et l’autorisation.
Accept-Language	Paramètres régionaux ISO 639-1 valides. Obligatoire.

Corps de la demande

N’indiquez pas le corps de la demande pour cette méthode.

Réponse

Si elle réussit, cette méthode renvoie un 200 OK code de réponse et un objet organizationalBranding dans le corps de la réponse. S’il n’existe aucun objet de personnalisation par défaut, cette méthode renvoie un 404 Not Found code de réponse.

Exemples

Exemple 1 : Obtenir la personnalisation par défaut

Demande

L’exemple suivant illustre une demande.

GET https://graph.microsoft.com/v1.0/organization/dcd219dd-bc68-4b9b-bf0b-4a33a796be35/branding
Accept-Language: 0


// Code snippets are only available for the latest version. Current version is 5.x

// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=csharp
var result = await graphClient.Organization["{organization-id}"].Branding.GetAsync((requestConfiguration) =>
{
	requestConfiguration.Headers.Add("Accept-Language", "0");
});



mgc organization branding get --organization-id {organization-id}



// Code snippets are only available for the latest major version. Current major version is $v1.*

// Dependencies
import (
	  "context"
	  abstractions "github.com/microsoft/kiota-abstractions-go"
	  msgraphsdk "github.com/microsoftgraph/msgraph-sdk-go"
	  graphorganization "github.com/microsoftgraph/msgraph-sdk-go/organization"
	  //other-imports
)

headers := abstractions.NewRequestHeaders()
headers.Add("Accept-Language", "0")

configuration := &graphorganization.ItemBrandingRequestBuilderGetRequestConfiguration{
	Headers: headers,
}

// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=go
branding, err := graphClient.Organization().ByOrganizationId("organization-id").Branding().Get(context.Background(), configuration)


// Code snippets are only available for the latest version. Current version is 6.x

GraphServiceClient graphClient = new GraphServiceClient(requestAdapter);

OrganizationalBranding result = graphClient.organization().byOrganizationId("{organization-id}").branding().get(requestConfiguration -> {
	requestConfiguration.headers.add("Accept-Language", "0");
});


const options = {
	authProvider,
};

const client = Client.init(options);

let organizationalBranding = await client.api('/organization/dcd219dd-bc68-4b9b-bf0b-4a33a796be35/branding')
	.header('Accept-Language','0')
	.get();


<?php
use Microsoft\Graph\GraphServiceClient;
use Microsoft\Graph\Generated\Organization\Item\Branding\BrandingRequestBuilderGetRequestConfiguration;


$graphServiceClient = new GraphServiceClient($tokenRequestContext, $scopes);

$requestConfiguration = new BrandingRequestBuilderGetRequestConfiguration();
$headers = [
		'Accept-Language' => '0',
	];
$requestConfiguration->headers = $headers;


$result = $graphServiceClient->organization()->byOrganizationId('organization-id')->branding()->get($requestConfiguration)->wait();


Import-Module Microsoft.Graph.Identity.DirectoryManagement

Get-MgOrganizationBranding -OrganizationId $organizationId


# Code snippets are only available for the latest version. Current version is 1.x
from msgraph import GraphServiceClient
from msgraph.generated.organization.item.branding.branding_request_builder import BrandingRequestBuilder
from kiota_abstractions.base_request_configuration import RequestConfiguration
# To initialize your graph_client, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=python

request_configuration = RequestConfiguration()
request_configuration.headers.add("Accept-Language", "0")


result = await graph_client.organization.by_organization_id('organization-id').branding.get(request_configuration = request_configuration)

Réponse

L’exemple suivant illustre la réponse.

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

{
    "@odata.context": "https://graph.microsoft.com/v1.0/$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"
    ],
    "signInPageText": "Contoso",
    "squareLogoRelativeUrl": "c1c6b6c8-urr-dzbkz44n5kuo9kzl1kziuujjcdqonoe2owyacso/logintenantbranding/0/tilelogo?ts=637535563832888580",
    "usernameHintText": ""
}

Exemple 2 : Obtenir la personnalisation de l’organisation quand aucune personnalisation n’est configurée

Demande

L’exemple suivant illustre une demande.

GET https://graph.microsoft.com/v1.0/organization/dcd219dd-bc68-4b9b-bf0b-4a33a796be35/branding
Accept-Language: 0


// Code snippets are only available for the latest version. Current version is 5.x

// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=csharp
var result = await graphClient.Organization["{organization-id}"].Branding.GetAsync((requestConfiguration) =>
{
	requestConfiguration.Headers.Add("Accept-Language", "0");
});



mgc organization branding get --organization-id {organization-id}



// Code snippets are only available for the latest major version. Current major version is $v1.*

// Dependencies
import (
	  "context"
	  abstractions "github.com/microsoft/kiota-abstractions-go"
	  msgraphsdk "github.com/microsoftgraph/msgraph-sdk-go"
	  graphorganization "github.com/microsoftgraph/msgraph-sdk-go/organization"
	  //other-imports
)

headers := abstractions.NewRequestHeaders()
headers.Add("Accept-Language", "0")

configuration := &graphorganization.ItemBrandingRequestBuilderGetRequestConfiguration{
	Headers: headers,
}

// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=go
branding, err := graphClient.Organization().ByOrganizationId("organization-id").Branding().Get(context.Background(), configuration)


// Code snippets are only available for the latest version. Current version is 6.x

GraphServiceClient graphClient = new GraphServiceClient(requestAdapter);

OrganizationalBranding result = graphClient.organization().byOrganizationId("{organization-id}").branding().get(requestConfiguration -> {
	requestConfiguration.headers.add("Accept-Language", "0");
});


const options = {
	authProvider,
};

const client = Client.init(options);

let organizationalBranding = await client.api('/organization/dcd219dd-bc68-4b9b-bf0b-4a33a796be35/branding')
	.header('Accept-Language','0')
	.get();


<?php
use Microsoft\Graph\GraphServiceClient;
use Microsoft\Graph\Generated\Organization\Item\Branding\BrandingRequestBuilderGetRequestConfiguration;


$graphServiceClient = new GraphServiceClient($tokenRequestContext, $scopes);

$requestConfiguration = new BrandingRequestBuilderGetRequestConfiguration();
$headers = [
		'Accept-Language' => '0',
	];
$requestConfiguration->headers = $headers;


$result = $graphServiceClient->organization()->byOrganizationId('organization-id')->branding()->get($requestConfiguration)->wait();


Import-Module Microsoft.Graph.Identity.DirectoryManagement

Get-MgOrganizationBranding -OrganizationId $organizationId


# Code snippets are only available for the latest version. Current version is 1.x
from msgraph import GraphServiceClient
from msgraph.generated.organization.item.branding.branding_request_builder import BrandingRequestBuilder
from kiota_abstractions.base_request_configuration import RequestConfiguration
# To initialize your graph_client, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=python

request_configuration = RequestConfiguration()
request_configuration.headers.add("Accept-Language", "0")


result = await graph_client.organization.by_organization_id('organization-id').branding.get(request_configuration = request_configuration)

Réponse

L’exemple suivant illustre la réponse.

HTTP/1.1 404 Not Found

Exemple 3 : Obtenir la personnalisation de l’organisation pour les paramètres régionaux français

Dans l’exemple suivant, l’en-tête Accept-Language est utilisé pour récupérer la personnalisation de la fr-FR localisation.

Demande

L’exemple suivant illustre une demande.

GET https://graph.microsoft.com/v1.0/organization/dcd219dd-bc68-4b9b-bf0b-4a33a796be35/branding
Accept-Language: fr-FR


// Code snippets are only available for the latest version. Current version is 5.x

// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=csharp
var result = await graphClient.Organization["{organization-id}"].Branding.GetAsync((requestConfiguration) =>
{
	requestConfiguration.Headers.Add("Accept-Language", "fr-FR");
});



mgc organization branding get --organization-id {organization-id}



// Code snippets are only available for the latest major version. Current major version is $v1.*

// Dependencies
import (
	  "context"
	  abstractions "github.com/microsoft/kiota-abstractions-go"
	  msgraphsdk "github.com/microsoftgraph/msgraph-sdk-go"
	  graphorganization "github.com/microsoftgraph/msgraph-sdk-go/organization"
	  //other-imports
)

headers := abstractions.NewRequestHeaders()
headers.Add("Accept-Language", "fr-FR")

configuration := &graphorganization.ItemBrandingRequestBuilderGetRequestConfiguration{
	Headers: headers,
}

// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=go
branding, err := graphClient.Organization().ByOrganizationId("organization-id").Branding().Get(context.Background(), configuration)


// Code snippets are only available for the latest version. Current version is 6.x

GraphServiceClient graphClient = new GraphServiceClient(requestAdapter);

OrganizationalBranding result = graphClient.organization().byOrganizationId("{organization-id}").branding().get(requestConfiguration -> {
	requestConfiguration.headers.add("Accept-Language", "fr-FR");
});


const options = {
	authProvider,
};

const client = Client.init(options);

let organizationalBranding = await client.api('/organization/dcd219dd-bc68-4b9b-bf0b-4a33a796be35/branding')
	.header('Accept-Language','fr-FR')
	.get();


<?php
use Microsoft\Graph\GraphServiceClient;
use Microsoft\Graph\Generated\Organization\Item\Branding\BrandingRequestBuilderGetRequestConfiguration;


$graphServiceClient = new GraphServiceClient($tokenRequestContext, $scopes);

$requestConfiguration = new BrandingRequestBuilderGetRequestConfiguration();
$headers = [
		'Accept-Language' => 'fr-FR',
	];
$requestConfiguration->headers = $headers;


$result = $graphServiceClient->organization()->byOrganizationId('organization-id')->branding()->get($requestConfiguration)->wait();


Import-Module Microsoft.Graph.Identity.DirectoryManagement

Get-MgOrganizationBranding -OrganizationId $organizationId


# Code snippets are only available for the latest version. Current version is 1.x
from msgraph import GraphServiceClient
from msgraph.generated.organization.item.branding.branding_request_builder import BrandingRequestBuilder
from kiota_abstractions.base_request_configuration import RequestConfiguration
# To initialize your graph_client, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=python

request_configuration = RequestConfiguration()
request_configuration.headers.add("Accept-Language", "fr-FR")


result = await graph_client.organization.by_organization_id('organization-id').branding.get(request_configuration = request_configuration)

Réponse

L’exemple suivant illustre la réponse.

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

{
    "@odata.context": "https://graph.microsoft.com/v1.0/$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,
    "usernameHintText": " "
}

Exemple 4 : Obtenir le bannerLogo pour les paramètres régionaux par défaut

L’exemple suivant renvoie l’objet bannerLogo pour les paramètres régionaux par défaut. Pour récupérer Stream types d’objets, par exemple bannerLogo, utilisez la méthode Get organizationalBrandingLocalization. Vous pouvez spécifier la valeur id en tant que default ou 0 dans l’URL de la requête. Si la propriété n’est pas définie, la requête renvoie une réponse vide.

Demande

L’exemple suivant illustre une demande.

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

Réponse

L’exemple suivant illustre la réponse.

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

<Image>

Exemple 5 : Obtenir le bannerLogo pour les paramètres régionaux par défaut lorsqu’il n’est pas défini

L’exemple suivant retourne l’objet bannerLogo qui n’avait pas été défini pour les paramètres régionaux par défaut.

Demande

L’exemple suivant illustre une demande.

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


// Code snippets are only available for the latest version. Current version is 5.x

// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=csharp
await graphClient.Organization["{organization-id}"].Branding.Localizations["{organizationalBrandingLocalization-id}"].BannerLogo.GetAsync();



mgc organization branding localizations banner-logo get --organization-id {organization-id} --organizational-branding-localization-id {organizationalBrandingLocalization-id}



// Code snippets are only available for the latest major version. Current major version is $v1.*

// Dependencies
import (
	  "context"
	  msgraphsdk "github.com/microsoftgraph/msgraph-sdk-go"
	  //other-imports
)


// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=go
graphClient.Organization().ByOrganizationId("organization-id").Branding().Localizations().ByOrganizationalBrandingLocalizationId("organizationalBrandingLocalization-id").BannerLogo().Get(context.Background(), nil)


// Code snippets are only available for the latest version. Current version is 6.x

GraphServiceClient graphClient = new GraphServiceClient(requestAdapter);

graphClient.organization().byOrganizationId("{organization-id}").branding().localizations().byOrganizationalBrandingLocalizationId("{organizationalBrandingLocalization-id}").bannerLogo().get();


const options = {
	authProvider,
};

const client = Client.init(options);

let stream = await client.api('/organization/d69179bf-f4a4-41a9-a9de-249c0f2efb1d/branding/localizations/default/bannerLogo')
	.get();


<?php
use Microsoft\Graph\GraphServiceClient;


$graphServiceClient = new GraphServiceClient($tokenRequestContext, $scopes);


$graphServiceClient->organization()->byOrganizationId('organization-id')->branding()->localizations()->byOrganizationalBrandingLocalizationId('organizationalBrandingLocalization-id')->bannerLogo()->get()->wait();


Import-Module Microsoft.Graph.Identity.DirectoryManagement

Get-MgOrganizationBrandingLocalizationBannerLogo -OrganizationId $organizationId -OrganizationalBrandingLocalizationId $organizationalBrandingLocalizationId


# Code snippets are only available for the latest version. Current version is 1.x
from msgraph import GraphServiceClient
# To initialize your graph_client, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=python

await graph_client.organization.by_organization_id('organization-id').branding.localizations.by_organizational_branding_localization_id('organizationalBrandingLocalization-id').banner_logo.get()

Réponse

L’exemple suivant illustre la réponse.

HTTP/1.1 200 OK

{}

Partager via

Obtenir organizationalBranding

Autorisations

Requête HTTP

Paramètres facultatifs de la requête

En-têtes de demande

Corps de la demande

Réponse

Exemples

Exemple 1 : Obtenir la personnalisation par défaut

Demande

Réponse

Exemple 2 : Obtenir la personnalisation de l’organisation quand aucune personnalisation n’est configurée

Demande

Réponse

Exemple 3 : Obtenir la personnalisation de l’organisation pour les paramètres régionaux français

Demande

Réponse

Exemple 4 : Obtenir le bannerLogo pour les paramètres régionaux par défaut

Demande

Réponse

Exemple 5 : Obtenir le bannerLogo pour les paramètres régionaux par défaut lorsqu’il n’est pas défini

Demande

Réponse

Commentaires

Ressources supplémentaires