Compartir a través de

Configuración de los argumentos para las tareas integradas del flujo de trabajo del ciclo de vida

  • Artículo

La API De flujos de trabajo de ciclo de vida de Microsoft Graph le permite automatizar procesos de ciclo de vida básicos para los usuarios en tres niveles: Joiner, Leaver y Mover. El núcleo de los flujos de trabajo son las tareas que representan las acciones específicas que se ejecutan automáticamente cuando se desencadena un flujo de trabajo.

Microsoft Graph admite 24 tareas integradas que puede usar para crear flujos de trabajo personalizados. Cada tarea tiene un conjunto de argumentos que se permiten para esa tarea. Por ejemplo, una tarea para generar un pase de acceso temporal (TAP) para un usuario permite configurar la duración del TAP y si el usuario puede reutilizarlo. Una tarea para agregar un usuario a un grupo requiere que especifique los grupos a los que desea agregar el usuario. Esta configuración se realiza en la propiedad arguments de una tarea.

En este artículo se proporcionan instrucciones sobre la configuración permitida para la propiedad arguments de las tareas en flujos de trabajo de ciclo de vida.

Configuración de argumentos para tareas

Nombre para mostrar de la tarea taskDefinitionId Argumentos
Enviar correo electrónico de bienvenida a la nueva contratación 70b29d51-b59a-4773-9280-8841dfd3f2ea nombre: cc
value: un identificador de usuario válido (String) para el usuario que desea cc en el correo electrónico.

nombre: customSubject
value: encabezado de asunto personalizado para el correo electrónico que se va a enviar.


nombre: customBody
value: el cuerpo del correo electrónico personalizado.


nombre: locale
value: valor de idioma que invalida la configuración de idioma del destinatario del correo electrónico. Este argumento no personaliza el texto personalizado del correo electrónico y debe establecerse en el mismo idioma que el texto personalizado.
Enviar correo electrónico de recordatorio de incorporación 3C860712-2D37-42A4-928F-5C93935D26A1 nombre: cc
value: un identificador de usuario válido (String) para el usuario que desea cc en el correo electrónico.

nombre: customSubject
value: encabezado de asunto personalizado para el correo electrónico que se va a enviar.


nombre: customBody
value: el cuerpo del correo electrónico personalizado.


nombre: locale
value: valor de idioma que invalida la configuración de idioma del destinatario del correo electrónico. Este argumento no personaliza el texto personalizado del correo electrónico y debe establecerse en el mismo idioma que el texto personalizado.
Generación de pase de acceso temporal y envío por correo electrónico al administrador del usuario 1b555e50-7f65-41d5-b514-5894a026d10d nombre: tapLifetimeMinutes
value: 10 upto 43000

nombre: tapIsUsableOnce
value: true o false

Requisitos previos:
  1. Al usuario se le debe asignar un administrador.
  2. El administrador del usuario debe tener su correo habilitado.
  3. La directiva de pase de acceso temporal (TAP) debe estar habilitada en el inquilino y el usuario habilitado para usar el método de autenticación TAP. Para obtener más información, vea temporaryAccessPassAuthenticationMethodConfiguration resource type( Tipo de recurso temporaryAccessPassAuthenticationMethodConfiguration).
Agregar usuario a grupos 22085229-5809-45e8-97fd-270d28d66910 nombre: groupID
value: un identificador de grupo válido o una lista separada por comas de grupos a los que se agrega el usuario como miembro. Por ejemplo: "06269010-2d8e-48e4-8f0e-33580720c9e1, 06bba22c-775e-42d8-b451-4221af061af0, 182f68db-6513-4e79-9ec2-a7e89a460e7f"
Adición de un usuario a los equipos e440ed8d-25a1-4618-84ce-091ed5be5594 nombre: teamID
value: un identificador de grupo válido o una lista separada por comas de los equipos a los que se agrega el usuario como miembro. Por ejemplo: "06269010-2d8e-48e4-8f0e-33580720c9e1, 06bba22c-775e-42d8-b451-4221af061af0, 182f68db-6513-4e79-9ec2-a7e89a460e7f"
Habilitar cuenta de usuario 6fc52c9d-398b-4305-9763-15f42c1676fc nombre: enableOnPremisesAccount
value: valor booleano que indica si la tarea habilita las cuentas de usuario locales sincronizadas.
Ejecución de una extensión de tarea personalizada 4262b724-8dba-4fad-afc3-43fcbb497a0e Nombre: CustomTaskExtensionID
value: el identificador de la extensión de tarea personalizada
Asignación de licencias a usuarios (versión preliminar) 683c87a4-2ad4-420b-97d4-220d90afcd24 Nombre: licenses
value: el identificador de la licencia que desea asignar
Eliminación de las asignaciones de licencias seleccionadas del usuario (versión preliminar) 5fc402a8-daaf-4b7b-9203-da868b05fc5f Nombre: licenses
value: el identificador de la licencia que desea asignar
Ejecución de una extensión de tarea personalizada 4262b724-8dba-4fad-afc3-43fcbb497a0e nombre: CustomTaskExtensionID
value: el identificador de la extensión de tarea personalizada
Deshabilitar la cuenta de usuario 1dfdfcc7-52fa-4c2e-bf3a-e3919cc12950 nombre: disableOnPremisesAccount
value: valor booleano que indica si la tarea deshabilita las cuentas de usuarios locales sincronizadas.
Eliminación del usuario del grupo seleccionado 1953a66c-751c-45e5-8bfe-01462c70da3c nombre: groupID
value: un identificador de grupo válido o una lista separada por comas de los grupos de los que el usuario es miembro. Por ejemplo: "06269010-2d8e-48e4-8f0e-33580720c9e1, 06bba22c-775e-42d8-b451-4221af061af0, 182f68db-6513-4e79-9ec2-a7e89a460e7f"
Eliminación de usuarios de todos los grupos b3a31406-2a15-4c9a-b25b-a658fa5f07fc Ninguno
Eliminación del usuario de los equipos 06aa7acb-01af-4824-8899-b14e5ed788d6 nombre: teamID
value: una lista separada por comas de los equipos de los que el usuario es miembro. Por ejemplo: "06269010-2d8e-48e4-8f0e-33580720c9e1, 06bba22c-775e-42d8-b451-4221af061af0, 182f68db-6513-4e79-9ec2-a7e89a460e7f"
Eliminación del usuario de todos los equipos 81f7b200-2816-4b3b-8c5d-dc556f07b024 Ninguno
Eliminación de todas las asignaciones de licencias del usuario 8fa97d28-3e52-4985-b3a9-a1126f9b8b4e Ninguno
Eliminar usuario 8d18588d-9ad3-4c0f-99d0-ec215f0e3dff nombre: deleteOnPremisesAccount
value: valor booleano que indica si la tarea elimina las cuentas de usuarios locales sincronizadas.
Enviar correo electrónico al administrador de notificaciones del traslado del usuario aab41899-9972-422a-9d97-f626014578b7 nombre: cc
value: un identificador de usuario válido (String) para el usuario que desea cc en el correo electrónico.

nombre: customSubject
value: encabezado de asunto personalizado para el correo electrónico que se va a enviar.


nombre: customBody
value: el cuerpo del correo electrónico personalizado.


nombre: locale
value: valor de idioma que invalida la configuración de idioma del destinatario del correo electrónico. No personaliza el texto personalizado del correo electrónico y debe establecerse en el mismo idioma que el texto personalizado.
Enviar correo electrónico al administrador antes del último día del usuario 52853a3e-f4e5-4eb8-bb24-1ac09a1da935 nombre: cc
value: un identificador de usuario válido (String) para el usuario que desea cc en el correo electrónico.

nombre: customSubject
value: encabezado de asunto personalizado para el correo electrónico que se va a enviar.


nombre: customBody
value: el cuerpo del correo electrónico personalizado.


nombre: locale
value: valor de idioma que invalida la configuración de idioma del destinatario del correo electrónico. No personaliza el texto personalizado del correo electrónico y debe establecerse en el mismo idioma que el texto personalizado.
Enviar correo electrónico a los usuarios el último día 9c0a1eaf-5bda-4392-9d9e-6e155bb57411 nombre: cc
value: un identificador de usuario válido (String) para el usuario que desea cc en el correo electrónico.

nombre: customSubject
value: un asunto personalizado para el correo electrónico que se va a enviar.


nombre: customBody
value: el cuerpo del correo electrónico personalizado.


nombre: locale
value: valor de idioma que invalida la configuración de idioma del destinatario del correo electrónico. No personaliza el texto personalizado del correo electrónico y debe establecerse en el mismo idioma que el texto personalizado.
Envío de correo electrónico fuera del panel al administrador de usuarios después de su último día 6f22ddd4-b3a5-47a4-a846-0d7c201a49ce nombre: cc
value: un identificador de usuario válido (String) para el usuario que desea cc en el correo electrónico.

nombre: customSubject
value: encabezado de asunto personalizado para el correo electrónico que se va a enviar.


nombre: customBody
value: el cuerpo del correo electrónico personalizado.


nombre: locale
value: valor de idioma que invalida la configuración de idioma del destinatario del correo electrónico. No personaliza el texto personalizado del correo electrónico y debe establecerse en el mismo idioma que el texto personalizado.
Solicitud de asignación de paquetes de acceso de usuario c1ec1e76-f374-4375-aaa6-0bb6bd4c60be nombre: assignmentPolicyId
value: un identificador de directiva de asignación (String) válido para el paquete de acceso que desea asignar al usuario.

nombre: accessPackageId
value: un identificador de paquete de acceso válido para el paquete de acceso que desea asignar al usuario.
Eliminación de la asignación de paquetes de acceso para el usuario 4a0b64f2-c7ec-46ba-b117-18f262946c50 nombre: accessPackageId
value: un identificador de paquete de acceso válido para el paquete de acceso que desea anular la asignación del usuario.
Eliminación de todas las asignaciones de paquetes de acceso para el usuario 42ae2956-193d-4f39-be06-691b8ac4fa1d Ninguno
Cancelación de solicitudes de asignación de paquetes de acceso pendientes para el usuario 498770d9-bab7-4e4c-b73d-5ded82a1d0b3 Ninguno

Ejemplos

Ejemplo 1: Envío de un correo electrónico de bienvenida a una nueva contratación

{
    "category": "joiner",
    "continueOnError": false,
    "description": "Send welcome email to new hire",
    "displayName": "Send Welcome Email",
    "isEnabled": true,
    "taskDefinitionId": "70b29d51-b59a-4773-9280-8841dfd3f2ea",
    "arguments": [
        {
            "name": "cc",
            "value": "e94ad2cd-d590-4b39-8e46-bb4f8e293f85,ac17d108-60cd-4eb2-a4b4-084cacda33f2"
        },
        {
            "name": "customSubject",
            "value": "Welcome to the organization {{userDisplayName}}!"
        },
        {
            "name": "customBody",
            "value": "Welcome to our organization {{userGivenName}} {{userSurname}}.\n\nFor more information, reach out to your manager {{managerDisplayName}} at {{managerEmail}}."
        },
        {
            "name": "locale",
            "value": "en-us"
        }
    ]
}

Ejemplo 2: Generar un pase de acceso temporal (TAP) y enviarlo al administrador del usuario

{
    "category": "joiner",
    "continueOnError": false,
    "description": "Generate Temporary Access Pass and send via email to user's manager",
    "displayName": "Generate TAP and Send Email",
    "isEnabled": true,
    "taskDefinitionId": "1b555e50-7f65-41d5-b514-5894a026d10d",
    "arguments": [
        {
            "name": "tapLifetimeMinutes",
            "value": "480"
        },
        {
            "name": "tapIsUsableOnce",
            "value": "false"
        },
        {
            "name": "cc",
            "value": "068fa0c1-fa00-4f4f-8411-e968d921c3e7,9d208c40-7eb6-46ff-bebd-f30148c39b47"
        },
        {
            "name": "customSubject",
            "value": "Temporary access pass for your new employee {{userDisplayName}}"
        },
        {
            "name": "customBody",
            "value": "Hello {{managerDisplayName}}\n\nPlease find the temporary access pass for your new employee {{userDisplayName}} below:\n\n{{temporaryAccessPass}}\n\nRegards\nYour IT department"
        },
        {
            "name": "locale",
            "value": "en-us"
        }
    ]
}

Ejemplo 3: Agregar un usuario a grupos

{
    "category": "joiner,leaver",
    "description": "Add user to groups",
    "displayName": "AddUserToGroup",
    "isEnabled": true,
    "continueOnError": true,
    "taskDefinitionId": "22085229-5809-45e8-97fd-270d28d66910",
    "arguments": [
        {
            "name": "groupID",
            "value": "06269010-2d8e-48e4-8f0e-33580720c9e1, 06bba22c-775e-42d8-b451-4221af061af0, 182f68db-6513-4e79-9ec2-a7e89a460e7f"
        }
    ]
}

Ejemplo 4: Agregar un usuario a los equipos

{
    "category": "joiner,leaver",
    "description": "Add user to team",
    "displayName": "AddUserToTeam",
    "isEnabled": true,
    "continueOnError": true,
    "taskDefinitionId": "e440ed8d-25a1-4618-84ce-091ed5be5594",
    "arguments": [
        {
            "name": "teamID",
            "value": "06269010-2d8e-48e4-8f0e-33580720c9e1, 06bba22c-775e-42d8-b451-4221af061af0, 182f68db-6513-4e79-9ec2-a7e89a460e7f"
        }
    ]
}

Ejemplo 5: Habilitación de una cuenta de usuario

{
    "category": "joiner,leaver",
    "description": "Enable user account",
    "displayName": "EnableUserAccount",
    "isEnabled": true,
    "continueOnError": true,
    "taskDefinitionId": "6fc52c9d-398b-4305-9763-15f42c1676fc",
    "arguments": []
}

Ejemplo 6: Ejecución de una extensión de tarea personalizada

{
    "category": "joiner,leaver",
    "description": "Run a Custom Task Extension to call-out to an external system.",
    "displayName": "Run a Custom Task Extension",
    "isEnabled": true,
    "continueOnError": true,
    "taskDefinitionId": "d79d1fcc-16be-490c-a865-f4533b1639ee",
    "arguments": [
        {
            "name": "customTaskExtensionID",
            "value": "<ID of your Custom Task Extension>"
        }
    ]
}

Ejemplo 7: Deshabilitar una cuenta de usuario

{
    "category": "joiner,leaver",
    "description": "Disable user account",
    "displayName": "DisableUserAccount",
    "isEnabled": true,
    "continueOnError": true,
    "taskDefinitionId": "1dfdfcc7-52fa-4c2e-bf3a-e3919cc12950",
    "arguments": []
}

Ejemplo 8: Eliminación de un usuario de grupos seleccionados

{
    "category": "leaver",
    "displayName": "Remove user from selected groups",
    "description": "Remove user from membership of selected Azure AD groups",
    "isEnabled": true,
    "continueOnError": true,
    "taskDefinitionId": "1953a66c-751c-45e5-8bfe-01462c70da3c",
    "arguments": [
        {
            "name": "groupID",
            "value": "06269010-2d8e-48e4-8f0e-33580720c9e1, 06bba22c-775e-42d8-b451-4221af061af0, 182f68db-6513-4e79-9ec2-a7e89a460e7f"
        }
    ]
}

Ejemplo 9: Eliminación de un usuario de todos los grupos

{
    "category": "leaver",
    "continueOnError": true,
    "displayName": "Remove user from all groups",
    "description": "Remove user from all Azure AD groups memberships",
    "isEnabled": true,
    "taskDefinitionId": "b3a31406-2a15-4c9a-b25b-a658fa5f07fc",
    "arguments": []
}

Ejemplo 10: Eliminación de un usuario de los equipos seleccionados

{
    "category": "joiner,leaver",
    "continueOnError": true,
    "displayName": "Remove user from selected Teams",
    "description": "Remove user from membership of selected Teams",
    "isEnabled": true,
    "taskDefinitionId": "06aa7acb-01af-4824-8899-b14e5ed788d6",
    "arguments": [
        {
            "name": "teamID",
            "value": "TeamId1, TeamId2, TeamId3, ..."
        }
    ]
}

Ejemplo 11: Eliminación de un usuario de todos los equipos

{
    "category": "leaver",
    "continueOnError": true,
    "description": "Remove user from all Teams",
    "displayName": "Remove user from all Teams memberships",
    "isEnabled": true,
    "taskDefinitionId": "81f7b200-2816-4b3b-8c5d-dc556f07b024",
    "arguments": []
}

Ejemplo 12: Eliminación de todas las asignaciones de licencias de un usuario

{
    "category": "leaver",
    "continueOnError": true,
    "displayName": "Remove all licenses for user",
    "description": "Remove all licenses assigned to the user",
    "isEnabled": true,
    "taskDefinitionId": "8fa97d28-3e52-4985-b3a9-a1126f9b8b4e",
    "arguments": []
}

Ejemplo 13: Eliminación de un usuario

{
    "category": "leaver",
    "continueOnError": true,
    "displayName": "Delete user account",
    "description": "Delete user account in Azure AD",
    "isEnabled": true,
    "taskDefinitionId": "8d18588d-9ad3-4c0f-99d0-ec215f0e3dff",
    "arguments": []
}

Ejemplo 14: Envío de un correo electrónico para notificar a un administrador de un traslado de usuario

{
    "category": "mover",
    "continueOnError": false,
    "description": "Send email to notify user\u2019s manager of user move",
    "displayName": "Send email to notify manager of user move",
    "isEnabled": true,
    "taskDefinitionId": "aab41899-9972-422a-9d97-f626014578b7",
    "arguments": [
        {
            "name": "cc",
            "value": "ac17d108-60cd-4eb2-a4b4-084cacda33f2,7d3ee937-edcc-46b0-9e2c-f832e01231ea"
        },
        {
            "name": "customSubject",
            "value": "{{userDisplayName}} has moved"
        },
        {
            "name": "customBody",
            "value": "Hello {{managerDisplayName}}\n\nwe are reaching out to let you know {{userDisplayName}} has moved in the organization.\n\nRegards\nYour IT department"
        },
        {
            "name": "locale",
            "value": "en-us"
        }
    ]
}

Ejemplo 15: Envío de un correo electrónico a un administrador antes del último día de un usuario

{
    "category": "leaver",
    "continueOnError": false,
    "description": "Send offboarding email to user's manager before the last day of work",
    "displayName": "Send email before user's last day",
    "isEnabled": true,
    "taskDefinitionId": "52853a3e-f4e5-4eb8-bb24-1ac09a1da935",
    "arguments": [
        {
            "name": "cc",
            "value": "068fa0c1-fa00-4f4f-8411-e968d921c3e7,e94ad2cd-d590-4b39-8e46-bb4f8e293f85"
        },
        {
            "name": "customSubject",
            "value": "Reminder that {{userDisplayName}}'s last day is coming up"
        },
        {
            "name": "customBody",
            "value": "Hello {{managerDisplayName}}\n\nthis is a reminder that {{userDisplayName}}'s last day is coming up.\n\nRegards\nYour IT department"
        },
        {
            "name": "locale",
            "value": "en-us"
        }
    ]
}

Ejemplo 16: Envío de un correo electrónico en el último día de un usuario

{
    "category": "leaver",
    "continueOnError": false,
    "description": "Send offboarding email to user's manager on the last day of work",
    "displayName": "Send email on user's last day",
    "isEnabled": true,
    "taskDefinitionId": "9c0a1eaf-5bda-4392-9d9e-6e155bb57411",
    "arguments": [
        {
            "name": "cc",
            "value": "068fa0c1-fa00-4f4f-8411-e968d921c3e7,e94ad2cd-d590-4b39-8e46-bb4f8e293f85"
        },
        {
            "name": "customSubject",
            "value": "{{userDisplayName}}'s last day"
        },
        {
            "name": "customBody",
            "value": "Hello {{managerDisplayName}}\n\nthis is a reminder that {{userDisplayName}}'s last day is today and their access will be revoked.\n\nRegards\nYour IT department"
        },
        {
            "name": "locale",
            "value": "en-us"
        }
    ]
}

Ejemplo 17: Enviar el correo electrónico de eliminación al administrador de un usuario después del último día de trabajo del usuario

{
    "category": "leaver",
    "continueOnError": true,
    "displayName": "Send offboarding email to user's manager after the last day of work",
    "description": "Send email after user's last day",
    "isEnabled": true,
    "continueOnError": true,
    "taskDefinitionId": "6f22ddd4-b3a5-47a4-a846-0d7c201a49ce",
    "arguments": []
}

Ejemplo 18: Solicitud de asignación de paquetes de acceso de usuario

{
    "category": "joiner,mover",
    "continueOnError": false,
    "description": "Request user assignment to selected access package",
    "displayName": "Request user access package assignment",
    "isEnabled": true,
    "taskDefinitionId": "c1ec1e76-f374-4375-aaa6-0bb6bd4c60be",
    "arguments": [
        {
            "name": "assignmentPolicyId",
            "value": "00d6fd25-6695-4f4a-8186-e4c6f901d2c1"
        },
        {
            "name": "accessPackageId",
            "value": "2ae5d6e5-6cbe-4710-82f2-09ef6ffff0d0"
        }
    ]
}

Ejemplo 19: Eliminación de la asignación de paquetes de acceso para un usuario

{
    "category": "leaver,mover",
    "continueOnError": false,
    "description": "Remove user assignment of selected access package",
    "displayName": "Remove access package assignment for user",
    "isEnabled": true,
    "taskDefinitionId": "4a0b64f2-c7ec-46ba-b117-18f262946c50",
    "arguments": [
        {
            "name": "accessPackageId",
            "value": "2ae5d6e5-6cbe-4710-82f2-09ef6ffff0d0"
        }
    ]
}

Ejemplo 20: Eliminación de todas las asignaciones de paquetes de acceso para un usuario

{
    "category": "leaver",
    "continueOnError": false,
    "description": "Remove all access packages assigned to the user",
    "displayName": "Remove all access package assignments for user",
    "isEnabled": true,
    "taskDefinitionId": "42ae2956-193d-4f39-be06-691b8ac4fa1d",
    "arguments": []
}

Ejemplo 21: Cancelación de solicitudes de asignación de paquetes de acceso pendientes para un usuario

{
    "category": "leaver",
    "continueOnError": false,
    "description": "Cancel all access package assignment requests pending for the user",
    "displayName": "Cancel all pending access package assignment requests for user",
    "isEnabled": true,
    "taskDefinitionId": "498770d9-bab7-4e4c-b73d-5ded82a1d0b3",
    "arguments": []
}

Ejemplo 22: Enviar correo electrónico de recordatorio de incorporación

{
    "category": "joiner",
    "continueOnError": false,
    "description": "Send onboarding reminder email to user\u2019s manager",
    "displayName": "Send onboarding reminder email",
    "isEnabled": true,
    "taskDefinitionId": "3C860712-2D37-42A4-928F-5C93935D26A1",
    "arguments": [
        {
            "name": "cc",
            "value": "e94ad2cd-d590-4b39-8e46-bb4f8e293f85,068fa0c1-fa00-4f4f-8411-e968d921c3e7"
        },
        {
            "name": "customSubject",
            "value": "Reminder: {{userDisplayName}} is starting soon"
        },
        {
            "name": "customBody",
            "value": "Hello {{managerDisplayName}}\n\nthis is a reminder that {{userDisplayName}} is starting soon.\n\nRegards\nYour IT department"
        },
        {
            "name": "locale",
            "value": "en-us"
        }
    ]
}

Contenido relacionado