Trabalhar com a API de gerenciamento de direitos Microsoft Entra
Namespace: microsoft.graph
Microsoft Entra gerenciamento de direitos pode ajudá-lo a gerenciar o acesso a grupos, aplicativos e sites do SharePoint Online para usuários internos, bem como usuários fora de sua organização.
Ao criar pacotes de acesso com as funções que os usuários precisam ter entre esses recursos e definir políticas para quem pode solicitar um pacote de acesso e quanto tempo eles podem ter uma atribuição para um pacote de acesso, você pode controlar o ciclo de vida de acesso para usuários internos e externos.
Os tipos de recursos de gerenciamento de direitos incluem:
- accessPackage: define as coleções de funções de recurso e as políticas de como um ou mais usuários podem obter acesso a esses recursos.
- accessPackageAssignmentPolicy: especifica a política pela qual os sujeitos podem solicitar ou receber um pacote de acesso por meio de uma atribuição de pacote de acesso.
- accessPackageAssignmentRequest: criado por um usuário que deseja obter uma atribuição de pacote de acesso.
- accessPackageAssignment: uma atribuição de um pacote de acesso a um determinado assunto, por um período de tempo.
- accessPackageCatalog: um contêiner para pacotes de acesso.
- accessPackageResource: uma referência a um recurso associado a um catálogo de pacotes de acesso.
- accessPackageResourceRequest: uma solicitação para adicionar um recurso a um catálogo de pacotes de acesso.
- accessPackageResourceEnvironment: uma referência à geolocalização do recurso. Aplicável a sites multi-geográficos do SharePoint Online.
- connectedOrganization: uma organização conectada para usuários externos que podem solicitar acesso.
- rightsManagementSettings: configurações em todo o locatário para Microsoft Entra gerenciamento de direitos.
- aprovação: representa as decisões associadas a uma solicitação de pacote de acesso.
Além disso, você pode gerenciar atribuições de função para usuários, grupos de usuários e entidades de serviço para funções específicas de gerenciamento de direitos por meio de definições de função de gerenciamento de direitos.
O locatário em que o gerenciamento de direitos está sendo usado deve ter licenças compradas ou de avaliação suficientes. Para obter mais informações sobre os requisitos de licença para o recurso de gerenciamento de direitos, consulte Requisitos de licença de gerenciamento de direitos.
Métodos
A tabela a seguir lista os métodos que você pode usar para interagir com recursos relacionados ao gerenciamento de direitos.
| Método | Tipo de retorno | Descrição |
|---|---|---|
| Get | entitlementManagementSettings | Leia as propriedades de um objeto rightManagementSettings . |
| Atualizar | entitlementManagementSettings | Atualize as propriedades de um objeto rightManagementSettings . |
| Listar accessPackages | coleção accessPackage | Recupere uma lista de objetos accessPackage . |
| Criar accessPackage | accessPackage | Crie um novo objeto accessPackage . |
| Obter accessPackage | accessPackage | Leia propriedades e relações de um objeto accessPackage . |
| Atualizar accessPackage | Nenhum | Atualize as propriedades de um objeto accesspackage . |
| Excluir accessPackage | Excluir accessPackage. | |
| Lista incompatívelAccessPackages | coleção accessPackage | Recupere uma lista dos objetos de pacote de acesso incompatíveis para este pacote de acesso. |
| Adicionar accessPackage a incompatíveisAccessPackages | Nenhum | Adicione um link para indicar que outro pacote de acesso é incompatível com um pacote de acesso especificado. |
| Remover accessPackage de incompatíveisAccessPackages | Nenhum | Remova um link que indicasse que um pacote de acesso era incompatível. |
| Listar grupos incompatíveis | Coleção group | Recupere uma lista dos objetos de grupo incompatíveis para este pacote de acesso. |
| Adicionar grupo a grupos incompatíveis | Nenhum | Adicione um link para indicar que a associação de um grupo é incompatível com um pacote de acesso especificado. |
| Remover grupo de grupos incompatíveis | Nenhum | Remova um link que indicasse que uma associação de grupo era incompatível. |
| Listar accessPackagesIncompatibleWith | coleção accessPackage | Recupere uma lista dos objetos accesspackage que listam esse pacote de acesso como incompatível. |
| FilterByCurrentUser | coleção accessPackage | Recupere uma lista de objetos accessPackage filtrados no usuário conectado. |
| Listar accessPackageAssignmentRequests | coleção accessPackageAssignmentRequest | Recupere uma lista de objetos accessPackageAssignmentRequest . |
| Criar accessPackageAssignmentRequest | accessPackageAssignmentRequest | Cria um novo objeto accessPackageAssignmentRequest . |
| Obter accessPackageAssignmentRequest | accessPackageAssignmentRequest | Leia propriedades e relações de um objeto accessPackageAssignmentRequest . |
| Excluir accessPackageAssignmentRequest | Nenhum | Excluir um accessPackageAssignmentRequest. |
| FilterByCurrentUser | coleção accessPackageAssignmentRequest | Recupere a lista de objetos accessPackageAssignmentRequest filtrados no usuário conectado. |
| cancel | coleção accessPackageAssignmentRequest | Cancele um objeto accessPackageAssignmentRequest que esteja em um estado cancelável: accepted, pendingApproval, , pendingNotBefore, pendingApprovalEscalated. |
| Listar accessPackageAssignments | coleção accessPackageAssignment | Recupere uma lista de objetos accessPackageAssignment . |
| Obter accessPackageAssignment | accessPackageAssignment | Recupere um objeto accessPackageAssignment . |
| FilterByCurrentUser | coleção accessPackageAssignment | Recupere a lista de objetos accessPackageAssignment filtrados no usuário conectado. |
| Listar accessPackageCatalogs | coleção accessPackageCatalog | Recupere uma lista de objetos accessPackageCatalogs . |
| Criar accessPackageCatalog | accessPackageCatalog | Crie um novo objeto accessPackageCatalog . |
| Obter accessPackageCatalog | accessPackageCatalog | Leia propriedades e relações de um objeto accessPackageCatalog . |
| Atualizar accessPackageCatalog | Nenhum | Atualize as propriedades de um objeto accessPackageCatalog . |
| Excluir accessPackageCatalog | Excluir um accessPackageCatalog. | |
| Listar accessPackageAssignmentPolicies | coleção accessPackageAssignmentPolicy | Obtenha uma lista dos objetos accessPackageAssignmentPolicy e suas propriedades. |
| Criar accessPackageAssignmentPolicy | accessPackageAssignmentPolicy | Crie um novo objeto accessPackageAssignmentPolicy . |
| Obter accessPackageAssignmentPolicy | accessPackageAssignmentPolicy | Leia as propriedades e as relações de um objeto accessPackageAssignmentPolicy . |
| Atualizar accessPackageAssignmentPolicy | accessPackageAssignmentPolicy | Atualize as propriedades de um objeto accessPackageAssignmentPolicy . |
| Excluir accessPackageAssignmentPolicy | Nenhum | Exclui um objeto accessPackageAssignmentPolicy . |
| Listar connectedOrganizations | coleção connectedOrganization | Recupere uma lista de objetos connectedOrganization . |
| Criar connectedOrganization | connectedOrganization | Crie um novo objeto connectedOrganization . |
| Obter connectedOrganization | connectedOrganization | Leia propriedades e relações de um objeto connectedOrganization . |
| Atualizar connectedOrganization | Nenhum | Atualize uma connectedOrganization. |
| Excluir connectedOrganization | Nenhum | Exclua uma connectedOrganization. |
| Listar internalSponsors | Coleção directoryObject | Recupere uma lista dos patrocinadores internos de uma connectedOrganization . |
| Listar externalSponsors | Coleção directoryObject | Recupere uma lista dos patrocinadores externos de uma connectedOrganization . |
| Adicionar internalSponsors | Nenhum | Adicione um usuário ou grupo aos patrocinadores internos de uma connectedOrganization . |
| Adicionar externalSponsors | Nenhum | Adicione um usuário ou grupo aos patrocinadores externos de uma connectedOrganization . |
| Remover internalSponsors | Nenhum | Remova um usuário ou grupo dos patrocinadores internos de uma connectedOrganization . |
| Remover externalSponsors | Nenhum | Remova um usuário ou grupo de patrocinadores externos de uma connectedOrganization . |
| Obter aprovação | aprovação | Recupere as propriedades de um objeto de aprovação . |
| filterByCurrentUser | coleção de aprovação | Recupere os objetos de aprovação de um aprovador. |
| List approvalStages | coleção approvalStage | Liste os objetos approvalStage associados a um objeto de aprovação . |
| Obter approvalStage | approvalStage | Recupere as propriedades de um objeto approvalStage . |
| Atualizar o ApprovalStage | Nenhum | Aplique a decisão de aprovação ou negação em um objeto approvalStage . |
Conteúdo relacionado
- O que é Microsoft Entra gerenciamento de direitos?
- subtipos subjectSetsingleUser, groupMembers, connectedOrganizationMembers, requestorManager, internalSponsors, externalSponsors e targetUserSponsors.
- accessPackageSubject – usado no accessPackageAssignment como um usuário sujeito que tem uma atribuição de pacote de acesso.
- identitySource - usado no connectedOrganization, um dos azureActiveDirectoryTenant, domainIdentitySource ou externalDomainFederation.