Criar roleEligibilityScheduleRequests

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.

Crie um novo objeto unifiedRoleEligibilityScheduleRequest . Essa operação permite que administradores e usuários qualificados adicionem, revoguem ou estendam atribuições qualificadas.

Permissões

Uma das seguintes permissões é obrigatória para chamar esta API. Para saber mais, incluindo como escolher permissões, confira Permissões.

Tipo de permissão Permissões (da com menos para a com mais privilégios)
Delegada (conta corporativa ou de estudante) RoleEligibilitySchedule.ReadWrite.Directory
Delegado (conta pessoal da Microsoft) Sem suporte
Aplicativo Sem suporte

Solicitação HTTP

POST /roleManagement/directory/roleEligibilityScheduleRequests

Cabeçalhos de solicitação

Nome Descrição
Autorização {token} de portador. Obrigatório.
Content-Type application/json. Obrigatório.

Corpo da solicitação

No corpo da solicitação, forneça uma representação JSON do objeto unifiedRoleEligibilityScheduleRequest .

A tabela a seguir mostra as propriedades opcionais e necessárias ao criar unifiedRoleEligibilityScheduleRequest.

Propriedade Tipo Descrição
ação String Representa o tipo da operação na atribuição de qualificação de função. Os valores possíveis são:
  • AdminAssign: para que os administradores atribuam elegibilidade de função a usuários ou grupos a funções.
  • AdminExtend: para que os administradores estendam as atribuições de expiração.
  • AdminUpdate: para que os administradores alterem as atribuições de função existentes.
  • AdminRenew: para que os administradores renovem atribuições expiradas.
  • AdminRemove: para administradores removerem usuários ou grupos de funções qualificadas.
  • UserAdd: para que os usuários ativem suas atribuições qualificadas.
  • UserExtend: para que os usuários solicitem a extensão de suas atribuições qualificadas de expiração.
  • UserRemove: para que os usuários desativem suas atribuições qualificadas ativas.
  • UserRenew: para que os usuários solicitem a renovação de suas atribuições qualificadas expiradas.
appScopeId String Identificador do escopo específico do aplicativo quando o escopo de atribuição é específico do aplicativo. O escopo de uma atribuição determina o conjunto de recursos aos quais a entidade de segurança recebeu acesso. Os escopos do aplicativo são escopos definidos e compreendidos apenas por esse aplicativo. Use / para escopos de aplicativo em todo o locatário. Use directoryScopeId para limitar o escopo a objetos de diretório específicos, por exemplo, unidades administrativas ou todos os usuários.
directoryScopeId String Identificador do objeto de diretório que representa o escopo da atribuição. O escopo de uma atribuição determina o conjunto de recursos aos quais a entidade de segurança recebeu acesso. Os escopos de diretório são escopos compartilhados armazenados no diretório que são compreendidos por vários aplicativos. Use / para escopo de todo o locatário. Use appScopeId para limitar o escopo somente a um aplicativo.
isValidationOnly Booliano Um booliano que determina se a chamada é uma validação ou uma chamada real. Defina essa propriedade somente se você quiser verificar se uma ativação está sujeita a regras adicionais, como MFA, antes de realmente enviar a solicitação.
Justificação String Uma mensagem fornecida por usuários e administradores ao criar a solicitação sobre por que ela é necessária. Opcional quando a ação é AdminRemove.
principalId String Identificador da entidade de segurança à qual a atribuição está sendo concedida. Por exemplo, um usuário ou um grupo. Para grupos, eles devem ser atribuíveis a funções, ou seja, o isAssignableToRole da propriedade de grupo definida como true.
roleDefinitionId String Identificador do unifiedRoleDefinition para o que a atribuição se aplica. Obrigatório. Somente leitura.
scheduleInfo requestSchedule O objeto de agendamento da solicitação de atribuição de função. Essa propriedade não é necessária quando a ação é AdminRemove.
ticketInfo ticketInfo O objeto ticketInfo anexado à solicitação de atribuição de função que inclui detalhes do número do tíquete e do sistema de tíquetes. Opcional.

Resposta

Se tiver êxito, este método retornará 201 Created um código de resposta e um objeto unifiedRoleEligibilityScheduleRequest no corpo da resposta.

Exemplos

Exemplo 1: Administrador para atribuir uma solicitação de agendamento de qualificação de função

Na solicitação a seguir, o administrador cria uma solicitação para atribuir a fdd7a751-b60b-444a-984c-02652fe8fa1c elegibilidade de uma função identificada por uma entidade de segurança identificada pela ID07706ff1-46c7-4847-ae33-3003830675a1. O escopo da qualificação é todos os objetos de diretório no locatário até 30 de junho de 2022 à meia-noite hora UTC.

Solicitação

POST https://graph.microsoft.com/beta/roleManagement/directory/roleEligibilityScheduleRequests
Content-Type: application/json

{
  "action": "AdminAssign",
  "justification": "Assign User Admin eligibility to IT Helpdesk (User) group",
  "roleDefinitionId": "fdd7a751-b60b-444a-984c-02652fe8fa1c",
  "directoryScopeId": "/",
  "principalId": "07706ff1-46c7-4847-ae33-3003830675a1",
  "scheduleInfo": {
    "startDateTime": "2021-07-01T00:00:00Z",
    "expiration": {
      "endDateTime": "2022-06-30T00:00:00Z",
      "type": "AfterDateTime"
    }
  }
}

Resposta

Este é um exemplo de resposta.

Observação: o objeto de resposta mostrado aqui pode ser encurtado para legibilidade.

HTTP/1.1 201 Created
Content-Type: application/json

{
    "@odata.context": "https://graph.microsoft.com/beta/$metadata#roleManagement/directory/roleEligibilityScheduleRequests/$entity",
    "id": "672c03bf-226a-42ec-a8b7-3bfab96064a1",
    "status": "Provisioned",
    "createdDateTime": "2021-07-26T18:08:03.1299669Z",
    "completedDateTime": "2021-07-26T18:08:06.2081758Z",
    "approvalId": null,
    "customData": null,
    "action": "AdminAssign",
    "principalId": "07706ff1-46c7-4847-ae33-3003830675a1",
    "roleDefinitionId": "fdd7a751-b60b-444a-984c-02652fe8fa1c",
    "directoryScopeId": "/",
    "appScopeId": null,
    "isValidationOnly": false,
    "targetScheduleId": "672c03bf-226a-42ec-a8b7-3bfab96064a1",
    "justification": "Assign User Admin eligibility to IT Helpdesk (User) group",
    "createdBy": {
        "application": null,
        "device": null,
        "user": {
            "displayName": null,
            "id": "fc9a2c2b-1ddc-486d-a211-5fe8ca77fa1f"
        }
    },
    "scheduleInfo": {
        "startDateTime": "2021-07-26T18:08:06.2081758Z",
        "recurrence": null,
        "expiration": {
            "type": "afterDateTime",
            "endDateTime": "2022-06-30T00:00:00Z",
            "duration": null
        }
    },
    "ticketInfo": {
        "ticketNumber": null,
        "ticketSystem": null
    }
}

Exemplo 2: Administrador para remover uma solicitação de agendamento de qualificação de função existente

Na solicitação a seguir, o administrador cria uma solicitação para revogar a fdd7a751-b60b-444a-984c-02652fe8fa1c qualificação de uma função identificada por uma entidade de segurança identificada pela ID07706ff1-46c7-4847-ae33-3003830675a1.

Solicitação

POST https://graph.microsoft.com/beta/roleManagement/directory/roleEligibilityScheduleRequests
Content-Type: application/json

{
    "action": "AdminRemove",
    "justification": "Assign User Admin eligibility to IT Helpdesk (User) group",
    "roleDefinitionId": "fdd7a751-b60b-444a-984c-02652fe8fa1c",
    "directoryScopeId": "/",
    "principalId": "07706ff1-46c7-4847-ae33-3003830675a1",
    "scheduleInfo": {
        "startDateTime": "2021-07-26T18:08:06.2081758Z",
        "expiration": {
            "endDateTime": "2022-06-30T00:00:00Z",
            "type": "AfterDateTime"
        }
    }
}

Resposta

Este é um exemplo de resposta. A solicitação retorna um objeto de resposta que mostra o status das alterações de atribuição qualificadas anteriormente como Revoked. A entidade de segurança não verá mais sua função qualificada anteriormente.

Observação: o objeto de resposta mostrado aqui pode ser encurtado para legibilidade.

HTTP/1.1 201 Created
Content-Type: application/json

{
    "@odata.context": "https://graph.microsoft.com/beta/$metadata#roleManagement/directory/roleEligibilityScheduleRequests/$entity",
    "id": "7f88a144-f9a9-4f8c-9623-39c321ae93c2",
    "status": "Revoked",
    "createdDateTime": "2021-08-06T17:59:12.4263499Z",
    "completedDateTime": null,
    "approvalId": null,
    "customData": null,
    "action": "AdminRemove",
    "principalId": "07706ff1-46c7-4847-ae33-3003830675a1",
    "roleDefinitionId": "fdd7a751-b60b-444a-984c-02652fe8fa1c",
    "directoryScopeId": "/",
    "appScopeId": null,
    "isValidationOnly": false,
    "targetScheduleId": null,
    "justification": "Assign User Admin eligibility to IT Helpdesk (User) group",
    "createdBy": {
        "application": null,
        "device": null,
        "user": {
            "displayName": null,
            "id": "fc9a2c2b-1ddc-486d-a211-5fe8ca77fa1f"
        }
    },
    "scheduleInfo": {
        "startDateTime": "2021-07-26T18:08:06.2081758Z",
        "recurrence": null,
        "expiration": {
            "type": "afterDateTime",
            "endDateTime": "2022-06-30T00:00:00Z",
            "duration": null
        }
    },
    "ticketInfo": {
        "ticketNumber": null,
        "ticketSystem": null
    }
}