Obtener directoryRole

Espacio de nombres: microsoft.graph

Nota:

Microsoft recomienda usar la API de RBAC unificada en lugar de esta API. La API de RBAC unificada proporciona más funcionalidad y flexibilidad. Para obtener más información, vea Get unifiedRoleDefinition.

Recupere las propiedades de un objeto directoryRole . El rol debe activarse en el inquilino para obtener una respuesta correcta.

Puede usar tanto el identificador de objeto como el identificador de plantilla del directoryRole con esta API. El identificador de plantilla de un rol integrado es inmutable y se puede ver en la descripción del rol en el Centro de administración Microsoft Entra. Para obtener más información, consulte Identificadores de plantilla de rol.

Esta API está disponible en las siguientes implementaciones nacionales de nube.

Servicio global	Gobierno de EE. UU. L4	Us Government L5 (DOD)	China operada por 21Vianet
✅	✅	✅	✅

Permissions

Elija el permiso o los permisos marcados como con privilegios mínimos para esta API. Use un permiso o permisos con privilegios superiores solo si la aplicación lo requiere. Para obtener más información sobre los permisos delegados y de aplicación, consulte Tipos de permisos. Para obtener más información sobre estos permisos, consulte la referencia de permisos.

Tipo de permiso	Permisos con privilegios mínimos	Permisos con privilegios más altos
Delegado (cuenta profesional o educativa)	RoleManagement.Read.Directory	Directory.Read.All, Directory.ReadWrite.All, RoleManagement.ReadWrite.Directory
Delegado (cuenta personal de Microsoft)	No admitida.	No admitida.
Aplicación	RoleManagement.Read.Directory	Directory.Read.All, Directory.ReadWrite.All, RoleManagement.ReadWrite.Directory

Importante

En escenarios delegados con cuentas profesionales o educativas, al usuario que ha iniciado sesión se le debe asignar un rol de Microsoft Entra compatible o un rol personalizado con un permiso de rol admitido. Se admiten los siguientes roles con privilegios mínimos para esta operación.

• Administrador de usuarios
• Administrador del servicio de asistencia
• Administrador de soporte técnico de servicio
• Administrador de facturación
• Usuario
• Administrador de buzones
• Lectores de directorio
• Escritores de directorios
• Administrador de la aplicación
• Lector de seguridad
• Administrador de seguridad
• Administrador de roles con privilegios
• Administrador de aplicaciones en la nube
• Aprobador de acceso de caja de seguridad del cliente
• Administrador de Dynamics 365
• Administrador de Power BI
• Administrador de Azure Information Protection
• Administrador de Análisis de escritorio
• Administrador de licencias
• Administrador de Escritorio administrado de Microsoft
• Administrador de autenticación
• Administrador de autenticación con privilegios
• Administrador de comunicaciones de Teams
• Ingeniero de soporte en comunicaciones de Teams
• Especialista de soporte en comunicaciones de Teams
• Administrador de Teams
• Administrador de Insights
• Administrador de datos de cumplimiento
• Operador de seguridad
• Administrador de Kaizala
• Lector global
• Usuario del Centro de negocios de licencias por volumen
• Usuario del Centro de servicios de licencias por volumen
• Administrador de comercio moderno
• Microsoft Store para Empresas usuario
• Revisor de directorios

Solicitud HTTP

Puede abordar el rol de directorio mediante su id . o roleTemplateId.

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

Parámetros de consulta opcionales

Este método admite el $selectparámetro de consulta OData para ayudar a personalizar la respuesta.

Encabezados de solicitud

Nombre	Tipo	Descripción
Authorization	string	{token} de portador. Obligatorio. Obtenga más información sobre la autenticación y la autorización.

Cuerpo de la solicitud

No proporcione un cuerpo de solicitud para este método.

Respuesta

Si se ejecuta correctamente, este método devuelve un código de respuesta 200 OK y el objeto directoryRole en el cuerpo de la respuesta.

Ejemplos

Ejemplo 1: Obtención de la definición de un rol de directorio mediante el identificador de rol

Solicitud

HTTP

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

C#

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

Para obtener más información sobre cómo agregar el SDK al proyecto y crear una instancia de authProvider, consulte la documentación del SDK.

CLI

mgc directory-roles get --directory-role-id {directoryRole-id}

Para obtener más información sobre cómo agregar el SDK al proyecto y crear una instancia de authProvider, consulte la documentación del SDK.

Ir

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

Para obtener más información sobre cómo agregar el SDK al proyecto y crear una instancia de authProvider, consulte la documentación del SDK.

Java

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

Para obtener más información sobre cómo agregar el SDK al proyecto y crear una instancia de authProvider, consulte la documentación del SDK.

JavaScript

const options = {
	authProvider,
};

const client = Client.init(options);

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

Para obtener más información sobre cómo agregar el SDK al proyecto y crear una instancia de authProvider, consulte la documentación del SDK.

PHP

<?php
use Microsoft\Graph\GraphServiceClient;


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


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

Para obtener más información sobre cómo agregar el SDK al proyecto y crear una instancia de authProvider, consulte la documentación del SDK.

PowerShell

Import-Module Microsoft.Graph.Identity.DirectoryManagement

Get-MgDirectoryRole -DirectoryRoleId $directoryRoleId

Para obtener más información sobre cómo agregar el SDK al proyecto y crear una instancia de authProvider, consulte la documentación del SDK.

Python

# 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

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

Para obtener más información sobre cómo agregar el SDK al proyecto y crear una instancia de authProvider, consulte la documentación del SDK.

Respuesta

Nota: Se puede acortar el objeto de respuesta que se muestra aquí para mejorar la legibilidad.

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

Ejemplo 2: Obtención de la definición de un rol de directorio mediante roleTemplateId

Solicitud

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

Respuesta

Nota: Se puede acortar el objeto de respuesta que se muestra aquí para mejorar la legibilidad.

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