@pnp/cli-microsoft365 6.9.0-beta.289ab69 → 6.9.0-beta.3158148

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

@@ -1,73 +0,0 @@
-# aad user get
-
-Gets information about the specified user
-
-## Usage
-
-```sh
-m365 aad user get [options]
-```
-
-## Options
-
-`-i, --id [id]`
-: The ID of the user to retrieve information for. Use either `id`, `userName` or `email`, but not all.
-
-`-n, --userName [userName]`
-: The name of the user to retrieve information for. Use either `id`, `userName` or `email`, but not all.
-
-`--email [email]`
-: The email of the user to retrieve information for. Use either `id`, `userName` or `email`, but not all.
-
-`-p, --properties [properties]`
-: Comma-separated list of properties to retrieve
-
---8<-- "docs/cmd/_global.md"
-
-## Remarks
-
-You can retrieve information about a user, either by specifying that user's id, user name (`userPrincipalName`), or email (`mail`), but not all.
-
-If the user with the specified id, user name, or email doesn't exist, you will get a `Resource 'xyz' does not exist or one of its queried reference-property objects are not present.` error.
-
-## Examples
-
-Get information about the user with id _1caf7dcd-7e83-4c3a-94f7-932a1299c844_
-
-```sh
-m365 aad user get --id 1caf7dcd-7e83-4c3a-94f7-932a1299c844
-```
-
-Get information about the user with user name _AarifS@contoso.onmicrosoft.com_
-
-```sh
-m365 aad user get --userName AarifS@contoso.onmicrosoft.com
-```
-
-Get information about the user with email _AarifS@contoso.onmicrosoft.com_
-
-```sh
-m365 aad user get --email AarifS@contoso.onmicrosoft.com
-```
-
-For the user with id _1caf7dcd-7e83-4c3a-94f7-932a1299c844_ retrieve the user name, e-mail address and full name
-
-```sh
-m365 aad user get --id 1caf7dcd-7e83-4c3a-94f7-932a1299c844 --properties "userPrincipalName,mail,displayName"
-```
-
-Get information about the currently logged user using the Id token
-
-```sh
-m365 aad user get --id "@meId"
-```
-
-Get information about the currently logged in user using the UserName token
-
-```sh
-m365 aad user get --userName "@meUserName"
-```
-
-## More information
-
-- Microsoft Graph User properties: [https://developer.microsoft.com/en-us/graph/docs/api-reference/v1.0/resources/user#properties](https://developer.microsoft.com/en-us/graph/docs/api-reference/v1.0/resources/user#properties)

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

@@ -1,107 +0,0 @@
-# aad user guest add
-
-Invite an external user to the organization
-
-## Usage
-
-```sh
-m365 aad user guest add [options]
-```
-
-## Options
-
-`--emailAddress <emailAddress>`
-: The email address of the user.
-
-`--displayName [displayName]`
-: The display name of the user.
-
-`--inviteRedirectUrl [inviteRedirectUrl]`
-: The URL the user should be redirected to once the invitation is redeemed. If not specified, default URL https://myapplications.microsoft.com will be set.
-
-`--welcomeMessage [welcomeMessage]`
-: Personal welcome message which will be added to the email along with the default email.
-
-`--ccRecipients [ccRecipients]`
-: Additional recipients the invitation message should be sent to. Currently only 1 additional recipient is supported.
-
-`--messageLanguage [messageLanguage]`
-: The language you want to send the default message in. The language format should be in [ISO 639](https://learn.microsoft.com/en-us/openspecs/office_standards/ms-oi29500/ed06cf15-306c-43be-9053-ca81ca51e656). The default is `en-US`.
-
-`--sendInvitationMessage`
-: Indicates whether an email should be sent to the user.
-
---8<-- "docs/cmd/_global.md"
-
-## Examples
-
-Invite a user via email and set the display name
-
-```sh
-m365 aad user guest add --emailAddress john.doe@contoso.com --displayName "John Doe" --sendInvitationMessage
-```
-
-Invite a user with a custom email and custom redirect url
-
-```sh
-m365 aad user guest add --emailAddress john.doe@contoso.com --welcomeMessage "Hi John, welcome to the organization!" --inviteRedirectUrl https://contoso.sharepoint.com --sendInvitationMessage
-```
-
-Invite a user and send an invitation mail in Dutch
-
-```sh
-m365 aad user guest add --emailAddress john.doe@contoso.com --messageLanguage nl-BE --sendInvitationMessage
-```
-
-## Response
-
-=== "JSON"
-
-    ```json
-    {
-      "id": "35f7f726-c541-4aef-a64e-a7b6868fe47f",
-      "inviteRedeemUrl": "https://login.microsoftonline.com/redeem?rd=https%3a%2f%2finvitations.microsoft.com%2fredeem%2f%3ftenant%3db373bc30-03b3-49bc-be72-9dd3e9027da8%26user%3d35f7f726-c541-4aef-a64e-a7b6868fe47f%26ticket%3dCjO3u3ZpQF2uthfZETfZ8gURzod5egvYI0uhaSN1Loo%25253d%26ver%3d2.0",
-      "invitedUserDisplayName": "John Doe",
-      "invitedUserType": "Guest",
-      "invitedUserEmailAddress": "john.doe@contoso.com",
-      "sendInvitationMessage": true,
-      "resetRedemption": false,
-      "inviteRedirectUrl": "https://myapplications.microsoft.com/",
-      "status": "PendingAcceptance",
-      "invitedUserMessageInfo": {
-        "messageLanguage": "en-US",
-        "customizedMessageBody": "Hi John, welcome to the organization!",
-        "ccRecipients": [
-          {
-            "emailAddress": {
-              "name": null,
-              "address": "maria.jones@contoso.com"
-            }
-          }
-        ]
-      },
-      "invitedUser": {
-        "id": "5257b5b2-4056-4a45-a05e-df5c92d53e6e"
-      }
-    }
-    ```
-
-=== "Text"
-
-    ```text
-    id                     : 35f7f726-c541-4aef-a64e-a7b6868fe47f
-    inviteRedeemUrl        : https://login.microsoftonline.com/redeem?rd=https%3a%2f%2finvitations.microsoft.com%2fredeem%2f%3ftenant%3db373bc30-03b3-49bc-be72-9dd3e9027da8%26user%3d35f7f726-c541-4aef-a64e-a7b6868fe47f%26ticket%3dCjO3u3ZpQF2uthfZETfZ8gURzod5egvYI0uhaSN1Loo%25253d%26ver%3d2.0
-    invitedUserDisplayName : John Doe
-    invitedUserEmailAddress: liwidit556@adroh.com
-    invitedUserType        : Guest
-    resetRedemption        : false
-    sendInvitationMessage  : true
-    status                 : PendingAcceptance
-    ```
-
-=== "CSV"
-
-    ```csv
-    id,inviteRedeemUrl,invitedUserDisplayName,invitedUserEmailAddress,invitedUserType,resetRedemption,sendInvitationMessage,status
-    35f7f726-c541-4aef-a64e-a7b6868fe47f,https://login.microsoftonline.com/redeem?rd=https%3a%2f%2finvitations.microsoft.com%2fredeem%2f%3ftenant%3db373bc30-03b3-49bc-be72-9dd3e9027da8%26user%3d35f7f726-c541-4aef-a64e-a7b6868fe47f%26ticket%3dCjO3u3ZpQF2uthfZETfZ8gURzod5egvYI0uhaSN1Loo%25253d%26ver%3d2.0,John Doe,liwidit556@adroh.com,Guest,,1,PendingAcceptance
-    ```

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

@@ -1,46 +0,0 @@
-# aad user hibp
-
-Allows you to retrieve all accounts that have been pwned with the specified username
-
-## Usage
-
-```sh
-m365 aad user hibp [options]
-```
-
-## Options
-
-`-n, --userName <userName>`
-: The name of the user to retrieve information for.
-
-`--apiKey, <apiKey>`
-: Have I been pwned `API Key`. You can buy it from [https://haveibeenpwned.com/API/Key](https://haveibeenpwned.com/API/Key)
-
-`--domain, [domain]`
-: Limit the returned breaches only contain results with the domain specified.
-
---8<-- "docs/cmd/_global.md"
-
-## Remarks
-
-If the user with the specified user name doesn't involved in any breach, you will get a `No pwnage found` message when running in debug or verbose mode.
-
-If `API Key` is invalid, you will get a `Required option apiKey not specified` error.
-
-## Examples
-
-Check if user with user name _account-exists@hibp-integration-tests.com_ is in a data breach
-
-```sh
-m365 aad user hibp --userName account-exists@hibp-integration-tests.com --apiKey _YOUR-API-KEY_
-```
-
-Check if user with user name _account-exists@hibp-integration-tests.com_ is in a data breach against the domain specified
-
-```sh
-m365 aad user hibp --userName account-exists@hibp-integration-tests.com --apiKey _YOUR-API-KEY_ --domain adobe.com
-```
-
-## More information
-
-- Have I been pwned API documentation: [https://haveibeenpwned.com/API/v3](https://haveibeenpwned.com/API/v3)

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

@@ -1,108 +0,0 @@
-# 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

@@ -1,98 +0,0 @@
-# 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

@@ -1,43 +0,0 @@
-# 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-list.md

@@ -1,63 +0,0 @@
-# aad user list
-
-Lists users matching specified criteria
-
-## Usage
-
-```sh
-m365 aad user list [options]
-```
-
-## Options
-
-`-p, --properties [properties]`
-: Comma-separated list of properties to retrieve
-
-`-d, --deleted`
-: Use to retrieve deleted users
-
---8<-- "docs/cmd/_global.md"
-
-## Remarks
-
-Using the `--properties` option, you can specify a comma-separated list of user properties to retrieve from the Microsoft Graph. If you don't specify any properties, the command will retrieve user's display name and account name.
-
-To filter the list of users, include additional options that match the user property that you want to filter with. For example `--displayName Patt` will return all users whose `displayName` starts with `Patt`. Multiple filters will be combined using the `and` operator.
-
-Certain properties cannot be returned within a user collection. The following properties are only supported when retrieving an single user using: `aboutMe, birthday, hireDate, interests, mySite, pastProjects, preferredName, responsibilities, schools, skills, mailboxSettings`.
-
-## Examples
-
-List all users in the tenant
-
-```sh
-m365 aad user list
-```
-
-List all recently deleted users in the tenant
-
-```sh
-m365 aad user list --deleted
-```
-
-List all users in the tenant. For each one return the display name and e-mail address
-
-```sh
-m365 aad user list --properties "displayName,mail"
-```
-
-Show users whose display name starts with _Patt_
-
-```sh
-m365 aad user list --displayName Patt
-```
-
-Show all account managers whose display name starts with _Patt_
-
-```sh
-m365 aad user list --displayName Patt --jobTitle 'Account manager'
-```
-
-## More information
-
-- Microsoft Graph User properties: [https://developer.microsoft.com/en-us/graph/docs/api-reference/v1.0/resources/user#properties](https://developer.microsoft.com/en-us/graph/docs/api-reference/v1.0/resources/user#properties)

package/docs/docs/cmd/aad/user/user-password-validate.md

@@ -1,29 +0,0 @@
-# aad user password validate
-
-Check a user's password against the organization's password validation policy
-
-## Usage
-
-```sh
-m365 aad user password validate [options]
-```
-
-## Options
-
-`-p, --password <password>`
-: The password to be validated.
-
---8<-- "docs/cmd/_global.md"
-
-## Remarks
-
-!!! attention
-    This command is based on an API that is currently in preview and is subject to change once the API reached general availability.
-
-## Examples
-
-Validate password _cli365P@ssW0rd_ against the organization's password validation policy
-
-```sh
-m365 aad user password validate --password "cli365P@ssW0rd"
-```

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

@@ -1,42 +0,0 @@
-# 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

@@ -1,82 +0,0 @@
-# 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
-    ```