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

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

@@ -0,0 +1,192 @@
+import Global from '/docs/cmd/_global.mdx';
+import Tabs from '@theme/Tabs';
+import TabItem from '@theme/TabItem';
+
+# aad user add
+
+Creates a new user
+
+## Usage
+
+```sh
+m365 aad user add [options]
+```
+
+## Options
+
+```md definition-list
+`--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.
+```
+
+<Global />
+
+## Remarks
+
+:::info
+
+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.
+
+:::
+
+This command allows using unknown options. For a comprehensive list of user properties, please refer to the [Graph documentation page](https://learn.microsoft.com/en-us/graph/api/resources/user?view=graph-rest-1.0#properties).
+
+If the specified option is not found, you will receive a `Resource 'xyz' does not exist or one of its queried reference-property objects are not present.` error.
+
+## 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
+
+<Tabs>
+  <TabItem value="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"
+  }
+  ```
+
+  </TabItem>
+  <TabItem value="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
+  ```
+
+  </TabItem>
+  <TabItem value="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
+  ```
+
+  </TabItem>
+  <TabItem value="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
+  ```
+
+  </TabItem>
+</Tabs>
+

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

@@ -0,0 +1,77 @@
+import Global from '/docs/cmd/_global.mdx';
+
+# aad user get
+
+Gets information about the specified user
+
+## Usage
+
+```sh
+m365 aad user get [options]
+```
+
+## Options
+
+```md definition-list
+`-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
+```
+
+<Global />
+
+## 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 by user name
+
+```sh
+m365 aad user get --userName AarifS@contoso.onmicrosoft.com
+```
+
+Get information about the user by email
+
+```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.mdx

@@ -0,0 +1,120 @@
+import Global from '/docs/cmd/_global.mdx';
+import Tabs from '@theme/Tabs';
+import TabItem from '@theme/TabItem';
+
+# aad user guest add
+
+Invite an external user to the organization
+
+## Usage
+
+```sh
+m365 aad user guest add [options]
+```
+
+## Options
+
+```md definition-list
+`--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.
+```
+
+<Global />
+
+## 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
+
+<Tabs>
+  <TabItem value="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"
+    }
+  }
+  ```
+
+  </TabItem>
+  <TabItem value="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
+  ```
+
+  </TabItem>
+  <TabItem value="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
+  ```
+
+  </TabItem>
+</Tabs>
+

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

@@ -0,0 +1,50 @@
+import Global from '/docs/cmd/_global.mdx';
+
+# 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
+
+```md definition-list
+`-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.
+```
+
+<Global />
+
+## 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 by a user name is in a data breach
+
+```sh
+m365 aad user hibp --userName account-exists@hibp-integration-tests.com --apiKey _YOUR-API-KEY_
+```
+
+Check if user by a user name 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.mdx

@@ -0,0 +1,125 @@
+import Global from '/docs/cmd/_global.mdx';
+import Tabs from '@theme/Tabs';
+import TabItem from '@theme/TabItem';
+
+# aad user license add
+
+Assigns a license to a user
+
+## Usage
+
+```sh
+m365 aad user license add [options]
+```
+
+## Options
+
+```md definition-list
+`--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.
+```
+
+<Global />
+
+## Remarks
+
+:::info
+
+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
+
+<Tabs>
+  <TabItem value="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"
+  }
+  ```
+
+  </TabItem>
+  <TabItem value="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
+  ```
+
+  </TabItem>
+  <TabItem value="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
+  ```
+
+  </TabItem>
+  <TabItem value="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
+  ```
+
+  </TabItem>
+</Tabs>
+

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

@@ -0,0 +1,115 @@
+import Global from '/docs/cmd/_global.mdx';
+import Tabs from '@theme/Tabs';
+import TabItem from '@theme/TabItem';
+
+# aad user license list
+
+Lists the license details for a given user
+
+## Usage
+
+```sh
+m365 aad user license list [options]
+```
+
+## Options
+
+```md definition-list
+`--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.
+```
+
+<Global />
+
+## 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
+
+<Tabs>
+  <TabItem value="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"
+        }
+      ]
+    }
+  ]
+  ```
+
+  </TabItem>
+  <TabItem value="Text">
+
+  ```text
+  id           : x4s03usaBkSMs5fbAhyttK6cK8RP6rdKlxeBV2I1zKw
+  skuId        : c42b9cae-ea4f-4ab7-9717-81576235ccac
+  skuPartNumber: DEVELOPERPACK_E5
+  ```
+
+  </TabItem>
+  <TabItem value="CSV">
+
+  ```csv
+  id,skuId,skuPartNumber
+  x4s03usaBkSMs5fbAhyttK6cK8RP6rdKlxeBV2I1zKw,c42b9cae-ea4f-4ab7-9717-81576235ccac,DEVELOPERPACK_E5
+  ```
+
+  </TabItem>
+  <TabItem value="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"}]
+  ```
+
+  </TabItem>
+</Tabs>
+