Obtenir directoryRole

Article
10/30/2023

Espace de noms: microsoft.graph

Récupérer les propriétés d’un objet directoryRole . Le rôle doit être activé dans le locataire pour une réponse réussie.

Vous pouvez utiliser 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 vu dans la description du rôle dans 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 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)	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

Requête HTTP

Vous pouvez traiter le rôle d’annuaire à l’aide de son id ou de roleTemplateId.

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

Paramètres facultatifs de la requête

Cette méthode prend en charge le $selectparamètre de requête OData pour vous aider à personnaliser la réponse.

En-têtes de demande

Nom	Type	Description
Autorisation	string	Porteur {token}. Obligatoire. En savoir plus sur l’authentification et l’autorisation.

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

GET https://graph.microsoft.com/v1.0/directoryRoles/43a63cc2-582b-4d81-a79d-1591f91d5558


// 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();



mgc directory-roles get --directory-role-id {directoryRole-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
directoryRoles, err := graphClient.DirectoryRoles().ByDirectoryRoleId("directoryRole-id").Get(context.Background(), nil)


// 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();


const options = {
	authProvider,
};

const client = Client.init(options);

let directoryRole = await client.api('/directoryRoles/43a63cc2-582b-4d81-a79d-1591f91d5558')
	.get();


<?php
use Microsoft\Graph\GraphServiceClient;


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


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


Import-Module Microsoft.Graph.Identity.DirectoryManagement

Get-MgDirectoryRole -DirectoryRoleId $directoryRoleId


from msgraph import GraphServiceClient

graph_client = GraphServiceClient(credentials, scopes)


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

Réponse

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

{
    "@odata.context": "https://graph.microsoft.com/v1.0/$metadata#directoryRoles/$entity",
    "id": "43a63cc2-582b-4d81-a79d-1591f91d5558",
    "deletedDateTime": null,
    "description": "Can manage all aspects of Azure AD and Microsoft services that use Azure AD identities.",
    "displayName": "Global Administrator",
    "roleTemplateId": "62e90394-69f5-4237-9190-012177145e10"
}

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

Demande

GET https://graph.microsoft.com/v1.0/directoryRoles(roleTemplateId='43a63cc2-582b-4d81-a79d-1591f91d5558')

Réponse

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

{
    "@odata.context": "https://graph.microsoft.com/v1.0/$metadata#directoryRoles/$entity",
    "id": "43a63cc2-582b-4d81-a79d-1591f91d5558",
    "deletedDateTime": null,
    "description": "Can manage all aspects of Azure AD and Microsoft services that use Azure AD identities.",
    "displayName": "Global Administrator",
    "roleTemplateId": "62e90394-69f5-4237-9190-012177145e10"
}

Partager via

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

Commentaires

Ressources supplémentaires