Trabalhando com a API Azure AD de gerenciamento de direitos

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 de versão.

Azure Active Directory (Azure AD) pode ajudá-lo a gerenciar o acesso a grupos, aplicativos e sites do SharePoint Online para usuários internos, bem como usuários fora da sua organização.

Ao criar pacotes de acesso com as funções que os usuários precisam ter nesses recursos e definir políticas para quem pode solicitar um pacote de acesso e por quanto tempo eles podem ter uma atribuição a 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 assuntos 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 assunto específico, por um período de tempo.
• accessPackageAssignmentResourceRole: indica a função específica do recurso à qual uma entidade foi atribuída por meio de uma atribuição de pacote de acesso.
• 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 à localização geográfica do recurso. Aplicável a sites multigeográficos SharePoint Online.
• connectedOrganization: uma organização conectada para usuários externos que podem solicitar acesso.
• entitlementManagementSettings: configurações em todo o locatário para Azure AD gerenciamento de direitos.
• aprovação: representa as decisões associadas a uma solicitação de pacote de acesso.

Além disso, as atribuições de função para funções específicas do gerenciamento de direitos podem ser gerenciadas por meio de definições de função de gerenciamento de direitos.

Para obter um tutorial que mostra como usar o gerenciamento de direitos para criar um pacote de recursos que os usuários internos podem solicitar por autoatendimento, consulte Criar um pacote de acesso usando apIs do Microsoft Graph.

Observe que o recurso de gerenciamento de direitos, incluindo a API, está incluído Azure AD Premium P2. O locatário em que o gerenciamento de direitos está sendo usado deve ter uma assinatura válida de compra ou avaliação Azure AD Premium P2 ou emS E5. 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 entitlementManagementSettings .
Atualização	entitlementManagementSettings	Atualize as propriedades de um objeto entitlementManagementSettings .
Listar accessPackages	Coleção accessPackage	Recupere 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 .
Excluir accessPackage		Exclua accessPackage.
FilterByCurrentUser	Coleção accessPackage	Recupere uma lista de objetos accessPackage filtrados no usuário conectado.
Listar accessPackageResourceRoleScopes	coleção accessPackageResourceRoleScope	Recupere 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	Recupere uma lista dos objetos accesspackage incompatíveis para este pacote de acesso.
Adicionar accessPackage a incompatibleAccessPackages	Nenhum	Adicione um link para indicar que outro accesspackage é incompatível com um pacote de acesso especificado.
Remover accessPackage de incompatibleAccessPackages	Nenhum	Remova um link que indicava que um accesspackage era incompatível.
Listar incompatibleGroups	Coleção group	Recupere uma lista dos objetos de grupo incompatíveis para este pacote de acesso.
Adicionar grupo a incompatibleGroups	Nenhum	Adicione um link para indicar que a associação de um grupo é incompatível com um pacote de acesso especificado.
Remover grupo de incompatibleGroups	Nenhum	Remova um link que indicava 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.
Listar accessPackageAssignmentPolicies	coleção accessPackageAssignmentPolicy	Recupere 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 .
Excluir accessPackageAssignmentPolicy		Exclua um accessPackageAssignmentPolicy.
Listar accessPackageAssignmentRequests	coleção accessPackageAssignmentRequest	Recupere uma lista de objetos accessPackageAssignmentRequest .
Criar accessPackageAssignmentRequest	accessPackageAssignmentRequest	Crie um novo accessPackageAssignmentRequest.
Obter accessPackageAssignmentRequest	accessPackageAssignmentRequest	Ler propriedades e relações de um objeto accessPackageAssignmentRequest .
Excluir accessPackageAssignmentRequest	Nenhum	Exclua um accessPackageAssignmentRequest.
FilterByCurrentUser	coleção accessPackageAssignmentRequest	Recupere a lista de objetos accessPackageAssignmentRequest filtrados no usuário conectado.
cancel	coleção accessPackageAssignmentRequest	Cancelar um objeto accessPackageAssignmentRequest que está em um estado cancelável: accepted, pendingApproval, pendingNotBefore, pendingApprovalEscalated.
Listar accessPackageAssignments	coleção accessPackageAssignment	Recupere uma lista de objetos accessPackageAssignment .
FilterByCurrentUser	coleção accessPackageAssignment	Recupere a lista de objetos accessPackageAssignment filtrados no usuário conectado.
Reprocessar	Nenhum	Reavaliar e impor automaticamente as atribuições de um usuário para um pacote de acesso específico.
coleção additionalAccess accessPackageAssignment	Recupere a lista de objetos accessPackageAssignment para usuários que têm atribuições a pacotes de acesso incompatíveis.
Listar accessPackageAssignmentResourceRoles	coleção accessPackageAssignmentResourceRole	Recupere uma lista de objetos accessPackageAssignmentResourceRole .
Obter accessPackageAssignmentResourceRole	accessPackageAssignmentResourceRole	Recupere um objeto accessPackageAssignmentResourceRole .
Listar accessPackageCatalogs	coleção accessPackageCatalog	Recupere 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 .
Excluir accessPackageCatalog		Exclua um accessPackageCatalog.
Listar recursos accessPackageCatalog	Coleção accessPackageResource	Recupere uma lista de objetos accessPackageResource .
Listar funções de recurso accessPackageCatalog	coleção accessPackageResourceRole	Recupere uma lista de objetos accessPackageResourceRole .
Listar accessPackageResourceRequests	coleção accessPackageResourceRequest	Ler propriedades e relações de objetos accessPackageResourceRequest .
Criar accessPackageResourceRequest	accessPackageCatalog	Crie um novo objeto accessPackageResourceRequest .
Listar accessPackageResourceEnvironments	coleção accessPackageResourceEnvironment	Recupere uma lista de objetos accessPackageResourceEnvironment .
Obter accessPackageResourceEnvironment	accessPackageResourceEnvironment	Leia as propriedades e as relações de um objeto accessPackageResourceEnvironment .
Listar connectedOrganizations	coleção connectedOrganization	Recupere uma lista de objetos connectedOrganization .
Criar connectedOrganization	connectedOrganization	Crie um novo objeto connectedOrganization .
Obter connectedOrganization	connectedOrganization	Ler 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 de 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 .
Obter aprovação	aprovação	Recupere as propriedades de um objeto de aprovação.
Listar approvalSteps	coleção approvalStep	Liste os objetos approvalStep associados a um objeto de aprovação.
Obter approvalStep	approvalStep	Recupere as propriedades de um objeto approvalStep .
Atualizar approvalStep	Nenhum	Aplicar a decisão aprovar ou negar em um objeto approvalStep .

Tipos

• requestorSettings, approvalSettings, questions e assignmentReviewSettings – usado em um accessPackageAssignmentPolicy para especificar quem pode solicitar, quem aprova e quem revisa as solicitações de atribuição de pacote de acesso nessa política.
• approvalStage – usado em approvalSettings para especificar os aprovadores primários, de backup e de escalonamento.
• approvalStep – usado na aprovação para distinguir as diferentes etapas de aprovação.
• subtipos userSet singleUser, groupMembers, connectedOrganizationMembers, requestorManager, internalSponsors e externalSponsors - Usado em requestorSettings, approvalStage, approvalStep e assignmentReviewSettings.
• accessPackageSubject – usado no accessPackageAssignment como um usuário da entidade que tem uma atribuição de pacote de acesso.
• identitySource - usado no connectedOrganization, um de azureActiveDirectoryTenant, crossCloudAzureActiveDirectoryTenant, domainIdentitySource ou externalDomainFederation.

Confira também

• O que Azure AD gerenciamento de direitos?