Obtenir directoryRole

Espace de noms: microsoft.graph

Importante

Les API sous la version /beta dans Microsoft Graph sont susceptibles d’être modifiées. L’utilisation de ces API dans des applications de production n’est pas prise en charge. Pour déterminer si une API est disponible dans v1.0, utilisez le sélecteur Version .

Remarque

Microsoft vous recommande d’utiliser l’API RBAC unifiée au lieu de cette API. L’API RBAC unifiée offre davantage de fonctionnalités et de flexibilité. Pour plus d’informations, consultez Obtenir unifiedRoleDefinition.

Récupérer les propriétés d’un objet directoryRole.

Vous pouvez utiliser à la fois l’ID d’objet et l’ID de modèle de directoryRole avec cette API. L’ID de modèle d’un rôle intégré est immuable et peut être consulté dans la description du rôle sur le centre d’administration Microsoft Entra. Pour plus d’informations, consultez ID de modèle de rôle.

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

Service global	Gouvernement américain L4	Gouvernement américain L5 (DOD)	Chine exploitée par 21Vianet
✅	✅	✅	✅

Autorisations

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

Type d’autorisation	Autorisations les moins privilégiées	Autorisations à privilèges plus élevés
Déléguée (compte professionnel ou scolaire)	RoleManagement.Read.Directory	Directory.Read.All, Directory.ReadWrite.All, RoleManagement.ReadWrite.Directory
Déléguée (compte Microsoft personnel)	Non prise en charge.	Non prise en charge.
Application	RoleManagement.Read.Directory	Directory.Read.All, Directory.ReadWrite.All, RoleManagement.ReadWrite.Directory

Importante

Pour l’accès délégué à l’aide de comptes professionnels ou scolaires, l’utilisateur connecté doit disposer d’un rôle Microsoft Entra pris en charge ou d’un rôle personnalisé qui accorde les autorisations requises pour cette opération. Cette opération prend en charge les rôles intégrés suivants, qui n’offrent que le moindre privilège nécessaire :

Administrateur d’utilisateurs
Administrateur du support technique
Administrateur du service de prise en charge
Administrateur de facturation
Utilisateur
Administrateur de boîtes aux lettres
Lecteurs d’annuaires
Rédacteurs d'annuaires
Administrateur de l'application
Lecteur de sécurité
Administrateur de sécurité
Administrateur de rôle privilégié
Administrateur de l'application cloud
Approbateur d’accès au référentiel client
Administrateur Dynamics 365
Administrateur Power BI
Administrateur Azure Information Protection
Administrateur d’analytique de bureau
Administrateur de licence
Administrateur de bureau géré Microsoft
Administrateur d’authentification
Administrateur d’authentification privilégié
Administrateur des communications Teams
Ingénieur de support des communications Teams
Spécialiste du support des communications Teams
Administrateur Teams
Administrateur d’informations
Administrateur de conformité des données
Opérateur de sécurité
Administrateur Kaizala
Lecteur général
Gestionnaire de licences en volume Utilisateur de Business Center
Utilisateur du Centre de gestion des licences en volume
Administrateur de commerce moderne
Utilisateur de Microsoft Store pour Entreprises
Réviseur d’annuaires

Requête HTTP

Vous pouvez vous adresser au rôle d’annuaire à l’aide de son ID ou de RôleTemplateId.

GET /directoryRoles/{role-id}
GET /directoryRoles(roleTemplateId='{roleTemplateId}')

Paramètres facultatifs de la requête

Cette méthode prend en charge le paramètre de $selectrequête OData pour personnaliser la réponse.

En-têtes de demande

Nom	Description
Autorisation	Porteur {token}. Obligatoire. En savoir plus sur l’authentification et les autorisations.

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 code de réponse 200 OK et un objet directoryRole dans le corps de la réponse.

Exemples

Exemple 1 : obtenir la définition d’un rôle d’annuaire à l’aide de l’ID de rôle

Demande

L’exemple suivant illustre une demande.

GET https://graph.microsoft.com/beta/directoryRoles/fe8f10bf-c9c2-47eb-95cb-c26cc85f1830


// 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.DirectoryRoles["{directoryRole-id}"].GetAsync();

Importante

Microsoft Graph SDK utilisent la version v1.0 de l’API par défaut et ne prennent pas en charge tous les types, propriétés et API disponibles dans la version bêta. Pour plus d’informations sur l’accès à l’API bêta avec le SDK, consultez Utiliser les kits de développement logiciel (SDK) Microsoft Graph avec l’API bêta.

Pour plus d’informations sur la façon d'ajouter le Kit de développement logiciel (SDK) à votre projet et créer une instance authProvider, consultez la documentation du Kit de développement logiciel (SDK).



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

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


// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=go
directoryRoles, err := graphClient.DirectoryRoles().ByDirectoryRoleId("directoryRole-id").Get(context.Background(), nil)

Importante


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

GraphServiceClient graphClient = new GraphServiceClient(requestAdapter);

DirectoryRole result = graphClient.directoryRoles().byDirectoryRoleId("{directoryRole-id}").get();

Importante


const options = {
	authProvider,
};

const client = Client.init(options);

let directoryRole = await client.api('/directoryRoles/fe8f10bf-c9c2-47eb-95cb-c26cc85f1830')
	.version('beta')
	.get();

Importante


<?php
use Microsoft\Graph\Beta\GraphServiceClient;


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


$result = $graphServiceClient->directoryRoles()->byDirectoryRoleId('directoryRole-id')->get()->wait();

Importante


Import-Module Microsoft.Graph.Beta.Identity.DirectoryManagement

Get-MgBetaDirectoryRole -DirectoryRoleId $directoryRoleId

Importante


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

result = await graph_client.directory_roles.by_directory_role_id('directoryRole-id').get()

Importante

Réponse

Remarque : l’objet de réponse affiché ci-après peut être raccourci pour plus de lisibilité.

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

{
    "@odata.context": "https://graph.microsoft.com/beta/$metadata#directoryRoles/$entity",
    "id": "fe8f10bf-c9c2-47eb-95cb-c26cc85f1830",
    "deletedDateTime": null,
    "description": "Can read basic directory information. Commonly used to grant directory read access to applications and guests.",
    "displayName": "Directory Readers",
    "roleTemplateId": "88d8e3e3-8f55-4a1e-953a-9b9898b8876b"
}

Exemple 2 : obtenir la définition d’un rôle d’annuaire à l’aide de roleTemplateId

Demande

L’exemple suivant illustre une demande.

GET https://graph.microsoft.com/beta/directoryRoles(roleTemplateId='88d8e3e3-8f55-4a1e-953a-9b9898b8876b')


// 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.DirectoryRolesWithRoleTemplateId("{roleTemplateId}").GetAsync();

Importante



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

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


// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=go
roleTemplateId := "{roleTemplateId}"
directoryRoles, err := graphClient.DirectoryRolesWithRoleTemplateId(&roleTemplateId).Get(context.Background(), nil)

Importante


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

GraphServiceClient graphClient = new GraphServiceClient(requestAdapter);

DirectoryRole result = graphClient.directoryRolesWithRoleTemplateId("{roleTemplateId}").get();

Importante

Snippet not available

Importante


<?php
use Microsoft\Graph\Beta\GraphServiceClient;


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


$result = $graphServiceClient->directoryRolesWithRoleTemplateId('{roleTemplateId}', )->get()->wait();

Importante


Import-Module Microsoft.Graph.Beta.Identity.DirectoryManagement

Get-MgBetaDirectoryRoleByRoleTemplateId

Importante


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

result = await graph_client.directory_roles_with_role_template_id("{roleTemplateId}").get()

Importante

Réponse

Remarque : l’objet de réponse affiché ci-après peut être raccourci pour plus de lisibilité.

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

{
    "@odata.context": "https://graph.microsoft.com/beta/$metadata#directoryRoles/$entity",
    "id": "fe8f10bf-c9c2-47eb-95cb-c26cc85f1830",
    "deletedDateTime": null,
    "description": "Can read basic directory information. Commonly used to grant directory read access to applications and guests.",
    "displayName": "Directory Readers",
    "roleTemplateId": "88d8e3e3-8f55-4a1e-953a-9b9898b8876b"
}

Commentaires

Cette page a-t-elle été utile ?

Last updated on 2024-09-17

Obtenir directoryRole

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 définition d’un rôle d’annuaire à l’aide de l’ID de rôle

Demande

Réponse

Exemple 2 : obtenir la définition d’un rôle d’annuaire à l’aide de roleTemplateId

Demande

Réponse

Commentaires

Ressources supplémentaires