> ## Documentation Index
> Fetch the complete documentation index at: https://docs.pinkfish.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# microsoft-active-directory-lifecycle

> Active Directory Lifecycle — onboarding invitations, OneDrive handoff, and deleted item recovery

**Server path:** `/microsoft-active-directory-lifecycle` | **Type:** Application | **PCID required:** Yes

## Tools

| Tool                                                                                                                                                    | Description                             |
| ------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------- |
| [`microsoft_active_directory_lifecycle_create_invitation`](#microsoft_active_directory_lifecycle_create_invitation)                                     | Invite an external user (B2B guest)     |
| [`microsoft_active_directory_lifecycle_invite_drive_root`](#microsoft_active_directory_lifecycle_invite_drive_root)                                     | Grant access to the root of a drive     |
| [`microsoft_active_directory_lifecycle_list_deleted_groups`](#microsoft_active_directory_lifecycle_list_deleted_groups)                                 | List soft-deleted Microsoft 365 groups  |
| [`microsoft_active_directory_lifecycle_list_deleted_users`](#microsoft_active_directory_lifecycle_list_deleted_users)                                   | List soft-deleted users                 |
| [`microsoft_active_directory_lifecycle_permanently_delete_directory_object`](#microsoft_active_directory_lifecycle_permanently_delete_directory_object) | Permanently delete a directory object   |
| [`microsoft_active_directory_lifecycle_restore_deleted_directory_object`](#microsoft_active_directory_lifecycle_restore_deleted_directory_object)       | Restore a soft-deleted directory object |

***

## microsoft\_active\_directory\_lifecycle\_create\_invitation

Invite an external user (B2B guest)

**Parameters:**

| Parameter                 | Type    | Required | Default | Description                                                  |
| ------------------------- | ------- | -------- | ------- | ------------------------------------------------------------ |
| `invitedUserDisplayName`  | string  | No       | —       | Invited User Display Name                                    |
| `invitedUserEmailAddress` | string  | Yes      | —       | Email address of the user to invite                          |
| `invitedUserMessageInfo`  | object  | No       | —       | Invited User Message Info                                    |
| `inviteRedirectUrl`       | string  | Yes      | —       | URL the user is redirected to after redeeming the invitation |
| `sendInvitationMessage`   | boolean | No       | —       | Send Invitation Message                                      |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "invitedUserDisplayName": {
        "type": "string",
        "description": "Invited User Display Name"
      },
      "invitedUserEmailAddress": {
        "type": "string",
        "description": "Email address of the user to invite"
      },
      "invitedUserMessageInfo": {
        "type": "object",
        "description": "Invited User Message Info",
        "properties": {
          "customizedMessageBody": {
            "type": "string",
            "description": "Customized Message Body"
          }
        }
      },
      "inviteRedirectUrl": {
        "type": "string",
        "description": "URL the user is redirected to after redeeming the invitation"
      },
      "sendInvitationMessage": {
        "type": "boolean",
        "description": "Send Invitation Message"
      }
    },
    "required": [
      "PCID",
      "invitedUserEmailAddress",
      "inviteRedirectUrl"
    ]
  }
  ```
</Expandable>

***

## microsoft\_active\_directory\_lifecycle\_invite\_drive\_root

Grant access to the root of a drive

**Parameters:**

| Parameter            | Type      | Required | Default | Description                                    |
| -------------------- | --------- | -------- | ------- | ---------------------------------------------- |
| `drive_id`           | string    | Yes      | —       | Drive ID (typically the user's drive ID)       |
| `expirationDateTime` | string    | No       | —       | Expiration Date Time                           |
| `message`            | string    | No       | —       | Optional message to include                    |
| `recipients`         | object\[] | Yes      | —       | The recipients value                           |
| `requireSignIn`      | boolean   | Yes      | —       | Require Sign In                                |
| `roles`              | string\[] | Yes      | —       | Permission roles, e.g. \['read'] or \['write'] |
| `sendInvitation`     | boolean   | Yes      | —       | Send Invitation                                |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "drive_id": {
        "type": "string",
        "description": "Drive ID (typically the user's drive ID)"
      },
      "expirationDateTime": {
        "type": "string",
        "description": "Expiration Date Time"
      },
      "message": {
        "type": "string",
        "description": "Optional message to include"
      },
      "recipients": {
        "type": "array",
        "items": {
          "type": "object",
          "properties": {
            "email": {
              "type": "string",
              "description": "The email value"
            }
          }
        },
        "description": "The recipients value"
      },
      "requireSignIn": {
        "type": "boolean",
        "description": "Require Sign In"
      },
      "roles": {
        "type": "array",
        "items": {
          "type": "string"
        },
        "description": "Permission roles, e.g. ['read'] or ['write']"
      },
      "sendInvitation": {
        "type": "boolean",
        "description": "Send Invitation"
      }
    },
    "required": [
      "PCID",
      "drive_id",
      "recipients",
      "requireSignIn",
      "roles",
      "sendInvitation"
    ]
  }
  ```
</Expandable>

***

## microsoft\_active\_directory\_lifecycle\_list\_deleted\_groups

List soft-deleted Microsoft 365 groups

**Parameters:**

| Parameter | Type    | Required | Default | Description     |
| --------- | ------- | -------- | ------- | --------------- |
| `$top`    | integer | No       | —       | The \$top value |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "$top": {
        "type": "integer",
        "description": "The $top value"
      }
    },
    "required": [
      "PCID"
    ]
  }
  ```
</Expandable>

***

## microsoft\_active\_directory\_lifecycle\_list\_deleted\_users

List soft-deleted users

**Parameters:**

| Parameter | Type    | Required | Default | Description        |
| --------- | ------- | -------- | ------- | ------------------ |
| `$top`    | integer | No       | —       | The \$top value    |
| `$filter` | string  | No       | —       | The \$filter value |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "$top": {
        "type": "integer",
        "description": "The $top value"
      },
      "$filter": {
        "type": "string",
        "description": "The $filter value"
      }
    },
    "required": [
      "PCID"
    ]
  }
  ```
</Expandable>

***

## microsoft\_active\_directory\_lifecycle\_permanently\_delete\_directory\_object

Permanently delete a directory object

**Parameters:**

| Parameter             | Type   | Required | Default | Description         |
| --------------------- | ------ | -------- | ------- | ------------------- |
| `directory_object_id` | string | Yes      | —       | Directory Object Id |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "directory_object_id": {
        "type": "string",
        "description": "Directory Object Id"
      }
    },
    "required": [
      "PCID",
      "directory_object_id"
    ]
  }
  ```
</Expandable>

***

## microsoft\_active\_directory\_lifecycle\_restore\_deleted\_directory\_object

Restore a soft-deleted directory object

**Parameters:**

| Parameter             | Type   | Required | Default | Description                        |
| --------------------- | ------ | -------- | ------- | ---------------------------------- |
| `directory_object_id` | string | Yes      | —       | ID of the deleted directory object |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "directory_object_id": {
        "type": "string",
        "description": "ID of the deleted directory object"
      }
    },
    "required": [
      "PCID",
      "directory_object_id"
    ]
  }
  ```
</Expandable>