@pnp/cli-microsoft365 6.3.0-beta.64eb7da → 6.3.0-beta.80fcd21

package/docs/docs/cmd/aad/user/user-add.md

@@ -0,0 +1,168 @@
+# aad user add
+
+Creates a new user
+
+## Usage
+
+```sh
+m365 aad user add [options]
+```
+
+## Options
+
+`--displayName <displayName>`
+: The name to display in the address book for the user.
+
+`--userName <userName>`
+: The user principal name (someuser@contoso.com).
+
+`--accountEnabled [accountEnabled]`
+: Whether the account is enabled. Possible values: `true`, `false`. Default value is `true`.
+
+`--mailNickname [mailNickname]`
+: The mail alias for the user. By default this value will be extracted from `userName`.
+
+`--password [password]`
+: The password for the user. When not specified, a password will be generated.
+
+`--firstName [firstName]`
+: The given name (first name) of the user. Maximum length is 64 characters.
+
+`--lastName [lastName]`
+: The user's surname (family name or last name). Maximum length is 64 characters.
+
+`--forceChangePasswordNextSignIn`
+: Whether the user should change his/her password on the next login.
+
+`--forceChangePasswordNextSignInWithMfa`
+: Whether the user should change his/her password on the next login and setup MFA.
+
+`--usageLocation [usageLocation]`
+: A two letter [country code](https://learn.microsoft.com/en-us/partner-center/commercial-marketplace-co-sell-location-codes#country-and-region-codes) (ISO standard 3166). Required for users that will be assigned licenses.
+
+`--officeLocation [officeLocation]` 
+: The office location in the user's place of business.
+
+`--jobTitle [jobTitle]`
+: The user's job title. Maximum length is 128 characters.
+
+`--companyName [companyName]`
+: The company name which the user is associated. The maximum length is 64 characters.
+
+`--department [department]`
+: The name for the department in which the user works. Maximum length is 64 characters.
+
+`--preferredLanguage [preferredLanguage]`
+: The preferred language for the user. Should follow [ISO 639-1 Code](https://learn.microsoft.com/en-us/openspecs/office_standards/ms-oe376/6c085406-a698-4e12-9d4d-c3b0ee3dbc4a). Example: `en-US`.
+
+`--managerUserId [managerUserId]`
+: User ID of the user's manager. Specify `managerUserId` or `managerUserName` but not both.
+
+`--managerUserName [managerUserName]`
+: User principal name of the manager. Specify `managerUserId` or `managerUserName` but not both.
+
+--8<-- "docs/cmd/_global.md"
+
+## Remarks
+
+!!! important
+    To use this command you must be a Global administrator, User administrator or Privileged Authentication administrator
+
+!!! note
+    After running this command, it may take a minute before the user is effectively created in the tenant.
+
+## Examples
+
+Create a user and let him/her update the password at first login
+
+```sh
+m365 aad user add --displayName "John Doe" --userName "john.doe@contoso.com" --password "SomePassw0rd" --forceChangePasswordNextSignIn
+```
+
+Create a user with job information
+
+```sh
+m365 aad user add --displayName "John Doe" --userName "john.doe@contoso.com" --password "SomePassw0rd" --firstName John --lastName Doe --jobTitle "Sales Manager" --companyName Contoso --department Sales --officeLocation Vosselaar --forceChangePasswordNextSignIn
+```
+
+Create a user with language information
+
+```sh
+m365 aad user add --displayName "John Doe" --userName "john.doe@contoso.com" --preferredLanguage "nl-BE" --usageLocation BE --forceChangePasswordNextSignIn
+```
+
+Create a user with a manager
+
+```sh
+m365 aad user add --displayName "John Doe" --userName "john.doe@contoso.com" --managerUserName "adele@contoso.com"
+```
+
+## Response
+
+=== "JSON"
+
+    ```json
+    {
+      "id": "990e2425-f595-43bc-85ed-b89a44093793",
+      "businessPhones": [],
+      "displayName": "John Doe",
+      "givenName": "John",
+      "jobTitle": "Sales Manager",
+      "mail": null,
+      "mobilePhone": null,
+      "officeLocation": "Vosselaar",
+      "preferredLanguage": "nl-BE",
+      "surname": "Doe",
+      "userPrincipalName": "john.doe@contoso.com",
+      "password": "SomePassw0rd"
+    }
+    ```
+
+=== "Text"
+
+    ```text
+    businessPhones   : []
+    displayName      : John Doe
+    givenName        : John
+    id               : 990e2425-f595-43bc-85ed-b89a44093793
+    jobTitle         : Sales Manager
+    mail             : null
+    mobilePhone      : null
+    officeLocation   : Vosselaar
+    password         : SomePassw0rd
+    preferredLanguage: nl-BE
+    surname          : Doe
+    userPrincipalName: john.doe@contoso.com
+    ```
+
+=== "CSV"
+
+    ```csv
+    id,businessPhones,displayName,givenName,jobTitle,mail,mobilePhone,officeLocation,preferredLanguage,surname,userPrincipalName,password
+    990e2425-f595-43bc-85ed-b89a44093793,[],John Doe,John,Sales Manager,,,Vosselaar,nl-BE,Doe,john.doe@contoso.com,SomePassw0rd
+    ```
+
+=== "Markdown"
+
+    ```md
+    # aad user add --displayName "John Doe" --userName "john.doe@contoso.com" --password "SomePassw0rd" --firstName "John" --lastName "Doe" --jobTitle "Sales Manager" --officeLocation "Vosselaar" --preferredLanguage "nl-BE"
+
+    Date: 16/02/2023
+
+    ## John Doe (990e2425-f595-43bc-85ed-b89a44093793)
+
+    Property | Value
+    ---------|-------
+    id | 990e2425-f595-43bc-85ed-b89a44093793
+    businessPhones | []
+    displayName | John Doe
+    givenName | John
+    jobTitle | Sales Manager
+    mail | null
+    mobilePhone | null
+    officeLocation | Vosselaar
+    preferredLanguage | nl-BE
+    surname | Doe
+    userPrincipalName | john.doe@contoso.com
+    password | SomePassw0rd
+    ```

package/docs/docs/cmd/aad/user/user-license-add.md

@@ -0,0 +1,108 @@
+# aad user license add
+
+Assigns a license to a user
+
+## Usage
+
+```sh
+m365 aad user license add [options]
+```
+
+## Options
+
+`--userId [userId]`
+: The ID of the user. Specify either `userId` or `userName` but not both.
+
+`--userName [userName]`
+: User principal name of the user. Specify either `userId` or `userName` but not both.
+
+`--ids <ids>`
+: A comma separated list of IDs that specify the licenses to add.
+
+--8<-- "docs/cmd/_global.md"
+
+## Remarks
+
+!!! important
+    The user must have a `usageLocation` value in order to assign a license to it.
+
+## Examples
+
+Assign specific licenses to a specific user by UPN
+
+```sh
+m365 user license add --userName "john.doe@contoso.com" --ids "45715bb8-13f9-4bf6-927f-ef96c102d394,bea13e0c-3828-4daa-a392-28af7ff61a0f"
+```
+
+Assign specific licenses from a specific user by ID
+
+```sh
+m365 user license add --userId "5c241023-2ba5-4ea8-a516-a2481a3e6c51" --ids "45715bb8-13f9-4bf6-927f-ef96c102d394,bea13e0c-3828-4daa-a392-28af7ff61a0f"
+```
+
+## Response
+
+=== "JSON"
+
+    ```json
+    {
+      "businessPhones": [],
+      "displayName": "John Doe",
+      "givenName": null,
+      "jobTitle": null,
+      "mail": "John@contoso.onmicrosoft.com",
+      "mobilePhone": null,
+      "officeLocation": null,
+      "preferredLanguage": null,
+      "surname": null,
+      "userPrincipalName": "John@contoso.onmicrosoft.com",
+      "id": "eb77fbcf-6fe8-458b-985d-1747284793bc"
+    }
+    ```
+
+=== "Text"
+
+    ```text
+    businessPhones   : []
+    displayName      : John Doe
+    givenName        : null
+    id               : eb77fbcf-6fe8-458b-985d-1747284793bc
+    jobTitle         : null
+    mail             : John@contoso.onmicrosoft.com
+    mobilePhone      : null
+    officeLocation   : null
+    preferredLanguage: null
+    surname          : null
+    userPrincipalName: John@contoso.onmicrosoft.com
+    ```
+
+=== "CSV"
+
+    ```csv
+    businessPhones,displayName,givenName,jobTitle,mail,mobilePhone,officeLocation,preferredLanguage,surname,userPrincipalName,id
+    [],John Doe,,,John@contoso.onmicrosoft.com,,,,,John@contoso.onmicrosoft.com,eb77fbcf-6fe8-458b-985d-1747284793bc
+    ```
+
+=== "Markdown"
+
+    ```md
+    # aad user license add --userName "John@contoso.onmicrosoft.com" --ids "f30db892-07e9-47e9-837c-80727f46fd3d,606b54a9-78d8-4298-ad8b-df6ef4481c80"
+
+    Date: 16/2/2023
+
+    ## John Doe (eb77fbcf-6fe8-458b-985d-1747284793bc)
+
+    Property | Value
+    ---------|-------
+    businessPhones | []
+    displayName | John Doe
+    givenName | null
+    jobTitle | null
+    mail | John@contoso.onmicrosoft.com
+    mobilePhone | null
+    officeLocation | null
+    preferredLanguage | null
+    surname | null
+    userPrincipalName | John@contoso.onmicrosoft.com
+    id | eb77fbcf-6fe8-458b-985d-1747284793bc
+    ```

package/docs/docs/cmd/aad/user/user-license-list.md

@@ -0,0 +1,98 @@
+# aad user license list
+
+Lists the license details for a given user
+
+## Usage
+
+```sh
+m365 aad user license list [options]
+```
+
+## Options
+
+`--userId [userId]`
+: The ID of the user. Specify either `userId` or `userName` but not both.
+
+`--userName [userName]`
+: User principal name of the user. Specify either `userId` or `userName` but not both.
+
+--8<-- "docs/cmd/_global.md"
+
+## Remarks
+
+!!! tip
+    If you don't specify any option, the command will list the license details of the current logged in user. This does not work when using application permissions.
+
+## Examples
+
+List license details of the current logged in user.
+
+```sh
+m365 aad user license list
+```
+
+List license details of a specific user by its UPN.
+
+```sh
+m365 aad user license list --userName john.doe@contoso.com
+```
+
+List license details of a specific user by its ID.
+
+```sh
+m365 aad user license list --userId 59f80e08-24b1-41f8-8586-16765fd830d3
+```
+
+## Response
+
+=== "JSON"
+
+    ```json
+    [
+      {
+        "id": "x4s03usaBkSMs5fbAhyttK6cK8RP6rdKlxeBV2I1zKw",
+        "skuId": "c42b9cae-ea4f-4ab7-9717-81576235ccac",
+        "skuPartNumber": "DEVELOPERPACK_E5",
+        "servicePlans": [
+          {
+            "servicePlanId": "7547a3fe-08ee-4ccb-b430-5077c5041653",
+            "servicePlanName": "YAMMER_ENTERPRISE",
+            "provisioningStatus": "Success",
+            "appliesTo": "User"
+          }
+        ]
+      }
+    ]
+    ```
+
+=== "Text"
+
+    ```text
+    id           : x4s03usaBkSMs5fbAhyttK6cK8RP6rdKlxeBV2I1zKw
+    skuId        : c42b9cae-ea4f-4ab7-9717-81576235ccac
+    skuPartNumber: DEVELOPERPACK_E5
+    ```
+
+=== "CSV"
+
+    ```csv
+    id,skuId,skuPartNumber
+    x4s03usaBkSMs5fbAhyttK6cK8RP6rdKlxeBV2I1zKw,c42b9cae-ea4f-4ab7-9717-81576235ccac,DEVELOPERPACK_E5
+    ```
+
+=== "Markdown"
+
+    ```md
+    # aad user license list --userId "0c9c625f-faa9-4c3b-8cd8-d874b869f78c"
+
+    Date: 2/19/2023
+
+    ## x4s03usaBkSMs5fbAhyttK6cK8RP6rdKlxeBV2I1zKw
+
+    Property | Value
+    ---------|-------
+    id | x4s03usaBkSMs5fbAhyttK6cK8RP6rdKlxeBV2I1zKw
+    skuId | c42b9cae-ea4f-4ab7-9717-81576235ccac
+    skuPartNumber | DEVELOPERPACK\_E5
+    servicePlans | [{"servicePlanId":"7547a3fe-08ee-4ccb-b430-5077c5041653","servicePlanName":"YAMMER\_ENTERPRISE","provisioningStatus":"Success","appliesTo":"User"}]
+    ```

package/docs/docs/cmd/aad/user/user-license-remove.md

@@ -0,0 +1,43 @@
+# aad user license remove
+
+Removes a license from a user
+
+## Usage
+
+```sh
+m365 aad user license remove [options]
+```
+
+## Options
+
+`--userId [userId]`
+: The ID of the user. Specify either `userId` or `userName` but not both.
+
+`--userName [userName]`
+: 	User principal name of the user. Specify either `userId` or `userName` but not both.
+
+`--ids <ids>`
+: A comma separated list of IDs that specify the licenses to remove.
+
+`--confirm`
+: Don't prompt for confirmation.
+
+--8<-- "docs/cmd/_global.md"
+
+## Examples
+
+Remove specific licenses from a specific user by UPN
+
+```sh
+m365 user license remove --userName "john.doe@contoso.com" --ids "45715bb8-13f9-4bf6-927f-ef96c102d394,bea13e0c-3828-4daa-a392-28af7ff61a0f"
+```
+
+Remove specific licenses from a specific user by ID
+
+```sh
+m365 user license remove --userId 5c241023-2ba5-4ea8-a516-a2481a3e6c51 --ids "45715bb8-13f9-4bf6-927f-ef96c102d394,bea13e0c-3828-4daa-a392-28af7ff61a0f"
+```
+
+## Response
+
+The command won't return a response on success.

package/docs/docs/cmd/aad/user/user-recyclebinitem-clear.md

@@ -0,0 +1,42 @@
+# aad user recyclebinitem clear
+
+Removes all users from the tenant recycle bin
+
+## Usage
+
+```sh
+m365 aad user recyclebinitem clear [options]
+```
+
+## Options
+
+`--confirm`
+: Don't prompt for confirmation.
+
+--8<-- "docs/cmd/_global.md"
+
+## Remarks
+
+!!! important
+    To use this command you must be a Global administrator, User administrator or Privileged Authentication administrator.
+
+!!! note
+    After running this command, it may take a minute before all deleted users are effectively removed from the tenant.
+
+## Examples
+
+Removes all users from the tenant recycle bin
+
+```sh
+m365 aad user recyclebinitem clear
+```
+
+Removes all users from the tenant recycle bin without confirmation prompt
+
+```sh
+m365 aad user recyclebinitem clear --confirm
+```
+
+## Response
+
+The command won't return a response on success.

package/docs/docs/cmd/aad/user/user-recyclebinitem-list.md

@@ -0,0 +1,82 @@
+# aad user recyclebinitem list
+
+Lists users from the recycle bin in the current tenant
+
+## Usage
+
+```sh
+m365 aad user recyclebinitem list [options]
+```
+
+## Options
+
+--8<-- "docs/cmd/_global.md"
+
+## Examples
+
+List all removed users
+
+```sh
+m365 aad user recyclebinitem list
+```
+
+## Response
+
+=== "JSON"
+
+    ```json
+    [
+      {
+        "businessPhones": [],
+        "displayName": "John Doe",
+        "givenName": "John Doe",
+        "jobTitle": "Developer",
+        "mail": "john@contoso.com",
+        "mobilePhone": "0476345130",
+        "officeLocation": "Washington",
+        "preferredLanguage": "nl-BE",
+        "surname": "John",
+        "userPrincipalName": "7e06b56615f340138bf879874d52e68ajohn@contoso.com",
+        "id": "7e06b566-15f3-4013-8bf8-79874d52e68a"
+      }
+    ]
+    ```
+
+=== "Text"
+
+    ```text
+    id                                    displayName  userPrincipalName
+    ------------------------------------  -----------  -----------------------------------------------
+    7e06b566-15f3-4013-8bf8-79874d52e68a  John Doe     7e06b56615f340138bf879874d52e68ajohn@contoso.com
+    ```
+
+=== "CSV"
+
+    ```csv
+    id,displayName,userPrincipalName
+    7e06b566-15f3-4013-8bf8-79874d52e68a,John Doe,7e06b56615f340138bf879874d52e68ajohn@contoso.com
+    ```
+
+=== "Markdown"
+
+    ```md
+    # aad user recyclebinitem list
+
+    Date: 14/02/2023
+
+    ## John Doe (7e06b566-15f3-4013-8bf8-79874d52e68a)
+
+    Property | Value
+    ---------|-------
+    businessPhones | []
+    displayName | John Doe
+    givenName | John Doe
+    jobTitle | Developer
+    mail | john@contoso.com
+    mobilePhone | 0476345130
+    officeLocation | Washington
+    preferredLanguage | nl-BE
+    surname | John
+    userPrincipalName | 7e06b56615f340138bf879874d52e68ajohn@contoso.com
+    id | 7e06b566-15f3-4013-8bf8-79874d52e68a
+    ```

package/docs/docs/cmd/aad/user/user-recyclebinitem-remove.md

@@ -0,0 +1,45 @@
+# aad user recyclebinitem remove
+
+Removes a user from the recycle bin in the current tenant
+
+## Usage
+
+```sh
+m365 aad user recyclebinitem remove [options]
+```
+
+## Options
+
+`--id <id>`
+: ID of the deleted user.
+
+`--confirm`
+: Don't prompt for confirmation.
+
+--8<-- "docs/cmd/_global.md"
+
+## Remarks
+
+!!! important
+    To use this command you must be a Global administrator, User administrator or Privileged Authentication administrator.
+
+!!! note
+    After running this command, it may take a minute before the deleted user is effectively removed from the tenant.
+
+## Examples
+
+Removes a specific user from the recycle bin
+
+```sh
+m365 aad user recyclebinitem remove --id 59f80e08-24b1-41f8-8586-16765fd830d3
+```
+
+Removes a specific user from the recycle bin without confirmation prompt
+
+```sh
+m365 aad user recyclebinitem remove --id 59f80e08-24b1-41f8-8586-16765fd830d3 --confirm
+```
+
+## Response
+
+The command won't return a response on success.

package/docs/docs/cmd/aad/user/user-recyclebinitem-restore.md

@@ -0,0 +1,99 @@
+# aad user recyclebinitem restore
+
+Restores a user from the recycle bin in the current tenant
+
+## Usage
+
+```sh
+m365 aad user recyclebinitem restore [options]
+```
+
+## Options
+
+`--id <id>`
+: ID of the deleted user.
+
+--8<-- "docs/cmd/_global.md"
+
+## Remarks
+
+!!! important
+    To use this command you must be a Global administrator, User administrator or Privileged Authentication administrator
+
+!!! note
+    After running this command, it may take a minute before the user will reappear in the active users.
+
+## Examples
+
+Restore user from the recycle bin
+
+```sh
+m365 aad user recyclebinitem restore --id 990e2425-f595-43bc-85ed-b89a44093793
+```
+
+## Response
+
+=== "JSON"
+
+    ```json
+    {
+      "id": "990e2425-f595-43bc-85ed-b89a44093793",
+      "businessPhones": [],
+      "displayName": "John Doe",
+      "givenName": "John",
+      "jobTitle": "Sales Manager",
+      "mail": null,
+      "mobilePhone": null,
+      "officeLocation": null,
+      "preferredLanguage": "nl-BE",
+      "surname": "Doe",
+      "userPrincipalName": "john.doe@contoso.com",
+    }
+    ```
+
+=== "Text"
+
+    ```text
+    businessPhones   : []
+    displayName      : John Doe
+    givenName        : John
+    id               : 990e2425-f595-43bc-85ed-b89a44093793
+    jobTitle         : Sales Manager
+    mail             : null
+    mobilePhone      : null
+    officeLocation   : null
+    preferredLanguage: nl-BE
+    surname          : Doe
+    userPrincipalName: john.doe@contoso.com
+    ```
+
+=== "CSV"
+
+    ```csv
+    id,businessPhones,displayName,givenName,jobTitle,mail,mobilePhone,officeLocation,preferredLanguage,surname,userPrincipalName
+    990e2425-f595-43bc-85ed-b89a44093793,[],John Doe,John,Sales Manager,,,,nl-BE,Doe,john.doe@contoso.com
+    ```
+
+=== "Markdown"
+
+    ```md
+    # user recyclebin restore --id 990e2425-f595-43bc-85ed-b89a44093793
+
+    Date: 16/02/2023
+
+    ## John Doe (990e2425-f595-43bc-85ed-b89a44093793)
+
+    Property | Value
+    ---------|-------
+    id | 990e2425-f595-43bc-85ed-b89a44093793
+    businessPhones | []
+    displayName | John Doe
+    givenName | John
+    jobTitle | Sales Manager
+    mail | null
+    mobilePhone | null
+    officeLocation | null
+    preferredLanguage | nl-BE
+    surname | Doe
+    userPrincipalName | john.doe@contoso.com
+    ```