Trabalhar com a API de gestão de direitos do Microsoft Entra
Namespace: microsoft.graph
Importante
As APIs na versão /beta no Microsoft Graph estão sujeitas a alterações. Não há suporte para o uso dessas APIs em aplicativos de produção. Para determinar se uma API está disponível na v1.0, use o seletor Versão.
A gestão de direitos do Microsoft Entra pode ajudá-lo a gerir o acesso a grupos, aplicações e sites do SharePoint Online para utilizadores internos, bem como utilizadores fora da sua organização.
Ao criar pacotes de acesso com as funções que os utilizadores precisam de ter em todos esses recursos e definir políticas para quem pode pedir um pacote de acesso e quanto tempo podem ter uma atribuição a um pacote de acesso, pode governar o ciclo de vida de acesso para utilizadores internos e externos.
Os tipos de recursos de gestão de direitos incluem:
- accessPackage: define as coleções de funções de recursos e as políticas de como um ou mais utilizadores podem obter acesso a esses recursos.
- accessPackageAssignmentPolicy: especifica a política através da qual os assuntos podem pedir ou ser atribuídos um pacote de acesso através de uma atribuição de pacote de acesso.
- accessPackageAssignmentRequest: criado por um utilizador que pretende obter uma atribuição de pacote de acesso.
- accessPackageAssignment: uma atribuição de um pacote de acesso a um determinado assunto, durante um período de tempo.
- accessPackageAssignmentResourceRole: indica a função específica do recurso à qual um assunto foi atribuído através de uma atribuição de pacote de acesso.
- accessPackageCatalog: um contentor para pacotes de acesso.
- accessPackageResource: uma referência a um recurso associado a um catálogo de pacotes de acesso.
- accessPackageResourceRequest: um pedido para adicionar um recurso a um catálogo de pacotes de acesso.
- accessPackageResourceEnvironment: uma referência à geolocalização do recurso. Aplicável a sites do SharePoint Online Multi-Geo.
- connectedOrganization: uma organização ligada para utilizadores externos que podem pedir acesso.
- entitlementManagementSettings: definições ao nível do inquilino para a gestão de direitos do Microsoft Entra.
- aprovação: representa as decisões associadas a um pedido de pacote de acesso.
Além disso, pode gerir atribuições de funções para utilizadores, grupos de utilizadores e principais de serviço para funções específicas de gestão de direitos através de definições de funções de gestão de direitos.
Para um tutorial que mostra como utilizar a gestão de direitos para criar um pacote de recursos que os utilizadores internos podem pedir de forma personalizada, veja Criar um pacote de acesso com as APIs do Microsoft Graph.
O inquilino onde a gestão de direitos está a ser utilizada tem de ter licenças de compra ou avaliação suficientes. Para obter mais informações sobre os requisitos de licença para a funcionalidade de gestão de direitos, veja Requisitos de licença de gestão de direitos.
Métodos
A tabela seguinte lista os métodos que pode utilizar para interagir com recursos relacionados com a gestão de direitos.
| Método | Tipo de retorno | Descrição |
|---|---|---|
| Get | entitlementManagementSettings | Leia as propriedades de um objeto entitlementManagementSettings . |
| Atualizar | entitlementManagementSettings | Atualize as propriedades de um objeto entitlementManagementSettings . |
| Listar accessPackages | coleção accessPackage | Obtenha uma lista de objetos accessPackage . |
| Criar accessPackage | accessPackage | Crie um novo objeto accessPackage . |
| Obter accessPackage | accessPackage | Ler propriedades e relações de um objeto accessPackage . |
| Atualizar accessPackage | Nenhum | Atualize as propriedades de um objeto accesspackage . |
| Eliminar accessPackage | Eliminar accessPackage. | |
| FilterByCurrentUser | coleção accessPackage | Obtenha uma lista de objetos accessPackage filtrados no utilizador com sessão iniciada. |
| Listar accessPackageResourceRoleScopes | coleção accessPackageResourceRoleScope | Obtenha uma lista de objetos accessPackageResourceRoleScope para um pacote de acesso. |
| Criar accessPackageResourceRoleScope | Crie um novo objeto accessPackageResourceRoleScope para um pacote de acesso. | |
| Listar incompatibleAccessPackages | coleção accessPackage | Obtenha uma lista dos objetos de accesspackage incompatíveis para este pacote de acesso. |
| Adicionar accessPackage a incompatibleAccessPackages | Nenhum | Adicione uma ligação para indicar que outro accesspackage é incompatível com um pacote de acesso especificado. |
| Remover accessPackage de incompatibleAccessPackages | Nenhum | Remova uma ligação que indicasse que um accesspackage era incompatível. |
| Listar incompatibleGroups | Coleção group | Obtenha uma lista dos objetos de grupo incompatíveis para este pacote de acesso. |
| Adicionar grupo a incompatibleGroups | Nenhum | Adicione uma ligação para indicar que a associação de um grupo é incompatível com um pacote de acesso especificado. |
| Remover grupo de incompatibleGroups | Nenhum | Remova uma ligação que indicasse que uma associação a um grupo era incompatível. |
| Listar accessPackagesIncompatibleWith | coleção accessPackage | Obtenha uma lista dos objetos accesspackage que listam este pacote de acesso como incompatíveis. |
| moveToCatalog | Nenhum | Mover um pacote de acesso para um catálogo diferente. |
| Listar accessPackageAssignmentPolicies | coleção accessPackageAssignmentPolicy | Obtenha uma lista de objetos accessPackageAssignmentPolicy . |
| Criar accessPackageAssignmentPolicy | accessPackageAssignmentPolicy | Crie um novo objeto accessPackageAssignmentPolicy . |
| Obter accessPackageAssignmentPolicy | accessPackageAssignmentPolicy | Ler propriedades e relações de um objeto accessPackageAssignmentPolicy . |
| Atualizar accessPackageAssignmentPolicy | accessPackageAssignmentPolicy | Atualize as propriedades de um objeto accessPackageAssignmentPolicy . |
| Eliminar accessPackageAssignmentPolicy | Elimine um accessPackageAssignmentPolicy. | |
| Listar accessPackageAssignmentRequests | accessPackageAssignmentRequest collection (coleção accessPackageAssignmentRequest ) | Obtenha uma lista de objetos accessPackageAssignmentRequest . |
| Criar accessPackageAssignmentRequest | accessPackageAssignmentRequest | Crie um novo accessPackageAssignmentRequest. |
| Obter accessPackageAssignmentRequest | accessPackageAssignmentRequest | Ler propriedades e relações de um objeto accessPackageAssignmentRequest . |
| Eliminar accessPackageAssignmentRequest | Nenhum | Elimine um accessPackageAssignmentRequest. |
| FilterByCurrentUser | accessPackageAssignmentRequest collection (coleção accessPackageAssignmentRequest ) | Obtenha a lista de objetos accessPackageAssignmentRequest filtrados no utilizador com sessão iniciada. |
| cancel | accessPackageAssignmentRequest collection (coleção accessPackageAssignmentRequest ) | Cancele um objeto accessPackageAssignmentRequest que esteja num estado cancelável: accepted, pendingApproval, pendingNotBefore, pendingApprovalEscalated. |
| Listar accessPackageAssignments | coleção accessPackageAssignment | Obtenha uma lista de objetos accessPackageAssignment . |
| FilterByCurrentUser | coleção accessPackageAssignment | Obtenha a lista de objetos accessPackageAssignment filtrados no utilizador com sessão iniciada. |
| reprocessar | Nenhum | Reavalie e imponha automaticamente as atribuições de um utilizador para um pacote de acesso específico. |
| additionalAccessaccessPackageAssignment collection | Obtenha a lista de objetos accessPackageAssignment para utilizadores que tenham atribuições a pacotes de acesso incompatíveis. | |
| Listar accessPackageAssignmentResourceRoles | accessPackageAssignmentResourceRole collection (coleção accessPackageAssignmentResourceRole ) | Obtenha uma lista de objetos accessPackageAssignmentResourceRole . |
| Obter accessPackageAssignmentResourceRole | accessPackageAssignmentResourceRole | Obtenha um objeto accessPackageAssignmentResourceRole . |
| Listar accessPackageCatalogs | coleção accessPackageCatalog | Obtenha uma lista de objetos accessPackageCatalogs . |
| Criar accessPackageCatalog | accessPackageCatalog | Crie um novo objeto accessPackageCatalog . |
| Obter accessPackageCatalog | accessPackageCatalog | Ler propriedades e relações de um objeto accessPackageCatalog . |
| Atualizar accessPackageCatalog | Nenhum | Atualize as propriedades de um objeto accessPackageCatalog . |
| Eliminar accessPackageCatalog | Eliminar um accessPackageCatalog. | |
| Listar recursos accessPackageCatalog | accessPackageResource collection | Obtenha uma lista de objetos accessPackageResource . |
| Listar funções de recursos accessPackageCatalog | coleção accessPackageResourceRole | Obtenha uma lista de objetos accessPackageResourceRole . |
| Listar accessPackageResourceRequests | accessPackageResourceRequest collection (coleção accessPackageResourceRequest ) | Ler propriedades e relações de objetos accessPackageResourceRequest . |
| Criar accessPackageResourceRequest | accessPackageCatalog | Crie um novo objeto accessPackageResourceRequest . |
| Listar accessPackageResourceEnvironments | accessPackageResourceEnvironment collection | Obtenha uma lista de objetos accessPackageResourceEnvironment . |
| Obter accessPackageResourceEnvironment | accessPackageResourceEnvironment | Leia as propriedades e relações de um objeto accessPackageResourceEnvironment . |
| Listar connectedOrganizations | connectedOrganization collection | Obtenha uma lista de objetos connectedOrganization . |
| Criar connectedOrganization | connectedOrganization | Crie um novo objeto connectedOrganization . |
| Obter ligaçãoOrganização | connectedOrganization | Ler propriedades e relações de um objeto connectedOrganization . |
| Atualizar connectedOrganization | Nenhum | Atualizar uma connectedOrganization. |
| Eliminar connectedOrganization | Nenhum | Eliminar uma connectedOrganization. |
| Listar internalSponsors | Coleção directoryObject | Obtenha uma lista dos patrocinadores internos de uma organização ligada . |
| Listar externalSponsors | Coleção directoryObject | Obtenha uma lista dos patrocinadores externos de uma organização ligada . |
| Adicionar InternalSponsors | Nenhum | Adicione um utilizador ou grupo aos patrocinadores internos de uma organização ligada . |
| Adicionar externalSponsors | Nenhum | Adicionar um utilizador ou grupo a patrocinadores externos de uma organização ligada . |
| Remover InternalSponsors | Nenhum | Remover um utilizador ou grupo dos patrocinadores internos de uma organização ligada . |
| Obter aprovação | aprovação | Obtenha as propriedades de um objeto de aprovação . |
| Aprovação da listaPassos | aprovaçãoA coleção de passos | Liste os objetos approvalStep associados a um objeto de aprovação . |
| Obter aprovaçãoPasso | aprovaçãoPasso | Obter as propriedades de um objeto approvalStep . |
| Atualizar aprovaçãoPasso | Nenhum | Aplicar a decisão de aprovação ou negação num objeto approvalStep . |
Tipos
- requestorSettings, approvalSettings, questions and assignmentReviewSettings - Utilizado num accessPackageAssignmentPolicy para especificar quem pode pedir, quem aprova e quem revê os pedidos de atribuição de pacotes de acesso nessa política.
- approvalStage – utilizado nas approvalSettings para especificar os aprovadores primários, de cópia de segurança e de escalamento.
- approvalStep – utilizado na aprovação para distinguir os diferentes passos de aprovação.
- userSet subtypes singleUser, groupMembers, connectedOrganizationMembers, requestorManager, internalSponsors, externalSponsors and targetUserSponsors - Used in requestorSettings, approvalStage, approvalStep and assignmentReviewSettings.
- accessPackageSubject – utilizado no accessPackageAssignment como um utilizador sujeito que tem uma atribuição de pacote de acesso.
- identitySource - utilizado na connectedOrganization, uma de azureActiveDirectoryTenant, crossCloudAzureActiveDirectoryTenant, domainIdentitySource ou externalDomainFederation.