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

package/docs/docs/cmd/aad/app/app-list.mdx

@@ -0,0 +1,184 @@
+import Global from '/docs/cmd/_global.mdx';
+import Tabs from '@theme/Tabs';
+import TabItem from '@theme/TabItem';
+
+# aad app list
+
+Retrieves a list of Azure AD app registrations
+
+## Usage
+
+```sh
+m365 aad app list [options]
+```
+
+## Options
+
+<Global />
+
+## Examples
+
+Retrieve a list of Azure AD app registrations
+
+```sh
+m365 aad app list
+```
+
+## Response
+
+<Tabs>
+  <TabItem value="JSON">
+
+  ```json
+  [
+    {
+      "id": "ff2798f7-1c7a-4607-8a7b-3d5e0c18c756",
+      "deletedDateTime": null,
+      "appId": "61ed4fab-a861-4307-bb87-a6a53dbe39f5",
+      "applicationTemplateId": null,
+      "disabledByMicrosoftStatus": null,
+      "createdDateTime": "2021-03-16T14:51:28Z",
+      "displayName": "TestAppPermissions",
+      "description": null,
+      "groupMembershipClaims": null,
+      "identifierUris": [],
+      "isDeviceOnlyAuthSupported": null,
+      "isFallbackPublicClient": null,
+      "notes": null,
+      "publisherDomain": "Contoso.onmicrosoft.com",
+      "serviceManagementReference": null,
+      "signInAudience": "AzureADMyOrg",
+      "tags": [],
+      "tokenEncryptionKeyId": null,
+      "samlMetadataUrl": null,
+      "defaultRedirectUri": null,
+      "certification": null,
+      "optionalClaims": null,
+      "addIns": [],
+      "api": {
+        "acceptMappedClaims": null,
+        "knownClientApplications": [],
+        "requestedAccessTokenVersion": null,
+        "oauth2PermissionScopes": [],
+        "preAuthorizedApplications": []
+      },
+      "appRoles": [],
+      "info": {
+        "logoUrl": null,
+        "marketingUrl": null,
+        "privacyStatementUrl": null,
+        "supportUrl": null,
+        "termsOfServiceUrl": null
+      },
+      "keyCredentials": [
+        {
+          "customKeyIdentifier": "7D20AB8DD09B653E9A3880F9046314B76917EF62",
+          "displayName": "CN=TestCertificate",
+          "endDateTime": "2022-01-01T00:00:00Z",
+          "key": null,
+          "keyId": "8928a06f-fa2d-4d92-98c3-b0f544804f64",
+          "startDateTime": "2020-01-01T00:00:00Z",
+          "type": "AsymmetricX509Cert",
+          "usage": "Verify"
+        }
+      ],
+      "parentalControlSettings": {
+        "countriesBlockedForMinors": [],
+        "legalAgeGroupRule": "Allow"
+      },
+      "passwordCredentials": [
+        {
+          "customKeyIdentifier": null,
+          "displayName": "TestSecret",
+          "endDateTime": "2022-03-16T14:58:45.602Z",
+          "hint": "~03",
+          "keyId": "714c9628-4bb8-4f08-84b4-7fd8d7a7b8c5",
+          "secretText": null,
+          "startDateTime": "2021-03-16T14:59:07.642Z"
+        }
+      ],
+      "publicClient": {
+        "redirectUris": []
+      },
+      "requiredResourceAccess": [
+        {
+          "resourceAppId": "00000003-0000-0000-c000-000000000000",
+          "resourceAccess": [
+            {
+              "id": "e1fe6dd8-ba31-4d61-89e7-88639da4683d",
+              "type": "Scope"
+            },
+            {
+              "id": "18228521-a591-40f1-b215-5fad4488c117",
+              "type": "Role"
+            },
+            {
+              "id": "09850681-111b-4a89-9bed-3f2cae46d706",
+              "type": "Role"
+            }
+          ]
+        }
+      ],
+      "verifiedPublisher": {
+        "displayName": null,
+        "verifiedPublisherId": null,
+        "addedDateTime": null
+      },
+      "web": {
+        "homePageUrl": null,
+        "logoutUrl": null,
+        "redirectUris": [],
+        "implicitGrantSettings": {
+          "enableAccessTokenIssuance": false,
+          "enableIdTokenIssuance": false
+        },
+        "redirectUriSettings": []
+      },
+      "spa": {
+        "redirectUris": []
+      }
+    }
+  ]
+  ```
+
+  </TabItem>
+  <TabItem value="Text">
+
+  ```text
+  appId                                 id                                    displayName                                                              signInAudience
+  ------------------------------------  ------------------------------------  -----------------------------------------------------------------------  ----------------------------------
+  61ed4fab-a861-4307-bb87-a6a53dbe39f5  ff2798f7-1c7a-4607-8a7b-3d5e0c18c756  TestAppPermissions                                                       AzureADMyOrg
+  ```
+
+  </TabItem>
+  <TabItem value="CSV">
+
+  ```csv
+  appId,id,displayName,signInAudience
+  61ed4fab-a861-4307-bb87-a6a53dbe39f5,ff2798f7-1c7a-4607-8a7b-3d5e0c18c756,TestAppPermissions,AzureADMyOrg
+  ```
+
+  </TabItem>
+  <TabItem value="Markdown">
+
+  ```md
+  # aad app list
+
+  Date: 2023-06-01
+
+  ## TestAppPermissions (ff2798f7-1c7a-4607-8a7b-3d5e0c18c756)
+
+  Property | Value
+  ---------|-------
+  id | ff2798f7-1c7a-4607-8a7b-3d5e0c18c756
+  appId | 61ed4fab-a861-4307-bb87-a6a53dbe39f5
+  createdDateTime | 2021-03-16T14:51:28Z
+  displayName | TestAppPermissions
+  isFallbackPublicClient | true
+  publisherDomain | contoso.onmicrosoft.com
+  signInAudience | AzureADMyOrg
+  ```
+
+  </TabItem>
+</Tabs>
+

package/docs/docs/cmd/aad/app/app-remove.mdx

@@ -0,0 +1,59 @@
+import Global from '/docs/cmd/_global.mdx';
+
+# aad app remove
+
+Removes an Azure AD app registration
+
+## Usage
+
+```sh
+m365 aad app remove [options]
+```
+
+## Options
+
+```md definition-list
+`--appId [appId]`
+: Application (client) ID of the Azure AD application registration to remove. Specify either `appId`, `objectId` or `name` but not multiple.
+
+`--objectId [objectId]`
+: Object ID of the Azure AD application registration to remove. Specify either `appId`, `objectId` or `name` but not multiple.
+
+`--name [name]`
+: Name of the Azure AD application registration to remove. Specify either `appId`, `objectId` or `name` but not multiple.
+
+`--confirm`
+: Don't prompt for confirmation to remove the app.
+```
+
+<Global />
+
+## Remarks
+
+For best performance use the `objectId` option to reference the Azure AD application registration to remove. If you use `appId` or `name`, this command will first need to find the corresponding object ID for that application.
+
+If the command finds multiple Azure AD application registrations with the specified app name, it will prompt you to disambiguate which app it should use, listing the discovered object IDs.
+
+## Examples
+
+Remove the Azure AD application registration by its app (client) ID.
+
+```sh
+m365 aad app remove --appId d75be2e1-0204-4f95-857d-51a37cf40be8
+```
+
+Remove the Azure AD application registration by its object ID.
+
+```sh
+m365 aad app remove --objectId d75be2e1-0204-4f95-857d-51a37cf40be8
+```
+
+Remove the Azure AD application registration by its name. Will NOT prompt for confirmation before deleting.
+
+```sh
+m365 aad app remove --name "My app" --confirm
+```
+
+## Response
+
+The command won't return a response on success.

package/docs/docs/cmd/aad/app/app-role-add.mdx

@@ -0,0 +1,68 @@
+import Global from '/docs/cmd/_global.mdx';
+
+# aad app role add
+
+Adds role to the specified Azure AD app registration
+
+## Usage
+
+```sh
+m365 aad app role add [options]
+```
+
+## Options
+
+```md definition-list
+`--appId [appId]`
+: Application (client) ID of the Azure AD application registration to which to add the role. Specify either `appId`, `appObjectId` or `appName`
+
+`--appObjectId [appObjectId]`
+: Object ID of the Azure AD application registration to which to add the role. Specify either `appId`, `appObjectId` or `appName`
+
+`--appName [appName]`
+: Name of the Azure AD application registration to which to add the role. Specify either `appId`, `appObjectId` or `appName`
+
+`-n, --name <name>`
+: Name of the role to add
+
+`-d, --description <description>`
+: Description of the role to add
+
+`-m, --allowedMembers <allowedMembers>`
+: Types of members that can be added to the group. Allowed values: `usersGroups`, `applications`, `both`
+
+`-c, --claim <claim>`
+: Claim value
+```
+
+<Global />
+
+## Remarks
+
+For best performance use the `appObjectId` option to reference the Azure AD application registration for which to add the role. If you use `appId` or `appName`, this command will first need to find the corresponding object ID for that application.
+
+If the command finds multiple Azure AD application registrations with the specified app name, it will prompt you to disambiguate which app it should use, listing the discovered object IDs.
+
+## Examples
+
+Add role to the Azure AD application registration specified by its object ID
+
+```sh
+m365 aad app role add --appObjectId d75be2e1-0204-4f95-857d-51a37cf40be8 --name Managers --description "Managers" --allowedMembers usersGroups --claim managers
+```
+
+Add role to the Azure AD application registration specified by its app (client) ID
+
+```sh
+m365 aad app role add --appId e75be2e1-0204-4f95-857d-51a37cf40be8 --name Managers --description "Managers" --allowedMembers usersGroups --claim managers
+```
+
+Add role to the Azure AD application registration specified by its name
+
+```sh
+m365 aad app role add --appName "My app" --name Managers --description "Managers" --allowedMembers usersGroups --claim managers
+```
+
+## Response
+
+The command won't return a response on success.

package/docs/docs/cmd/aad/app/app-role-list.mdx

@@ -0,0 +1,115 @@
+import Global from '/docs/cmd/_global.mdx';
+import Tabs from '@theme/Tabs';
+import TabItem from '@theme/TabItem';
+
+# aad app role list
+
+Gets Azure AD app registration roles
+
+## Usage
+
+```sh
+m365 aad app role list [options]
+```
+
+## Options
+
+```md definition-list
+`--appId [appId]`
+: Application (client) ID of the Azure AD application registration for which to retrieve roles. Specify either `appId`, `appObjectId` or `appName`
+
+`--appObjectId [appObjectId]`
+: Object ID of the Azure AD application registration for which to retrieve roles. Specify either `appId`, `appObjectId` or `appName`
+
+`--appName [appName]`
+: Name of the Azure AD application registration for which to retrieve roles. Specify either `appId`, `appObjectId` or `appName`
+```
+
+<Global />
+
+## Remarks
+
+For best performance use the `appObjectId` option to reference the Azure AD application registration for which to retrieve roles. If you use `appId` or `appName`, this command will first need to find the corresponding object ID for that application.
+
+If the command finds multiple Azure AD application registrations with the specified app name, it will prompt you to disambiguate which app it should use, listing the discovered object IDs.
+
+## Examples
+
+Get roles for the Azure AD application registration specified by its object ID
+
+```sh
+m365 aad app role list --appObjectId d75be2e1-0204-4f95-857d-51a37cf40be8
+```
+
+Get roles for the Azure AD application registration specified by its app (client) ID
+
+```sh
+m365 aad app role list --appId e75be2e1-0204-4f95-857d-51a37cf40be8
+```
+
+Get roles for the Azure AD application registration specified by its name
+
+```sh
+m365 aad app role list --appName "My app"
+```
+
+## Response
+
+<Tabs>
+  <TabItem value="JSON">
+
+  ```json
+  [
+    {
+      "allowedMemberTypes": [
+        "User"
+      ],
+      "description": "Managers",
+      "displayName": "Managers",
+      "id": "0a545986-9142-4c88-909c-34f3c11abbc4",
+      "isEnabled": true,
+      "origin": "Application",
+      "value": "managers"
+    }
+  ]
+  ```
+
+  </TabItem>
+  <TabItem value="Text">
+
+  ```text
+  displayName  description  id
+  -----------  -----------  ------------------------------------
+  Managers     Managers     0a545986-9142-4c88-909c-34f3c11abbc4
+  ```
+
+  </TabItem>
+  <TabItem value="CSV">
+
+  ```csv
+  description,displayName,id,isEnabled,origin,value
+  Managers,Managers,0a545986-9142-4c88-909c-34f3c11abbc4,1,Application,managers
+  ```
+
+  </TabItem>
+  <TabItem value="Markdown">
+
+  ```md
+  # aad app role list --appObjectId "29d99e17-96b7-46aa-816d-b52bfeeafeb9"
+
+  Date: 2023-06-01
+
+  ## Managers (0a545986-9142-4c88-909c-34f3c11abbc4)
+
+  Property | Value
+  ---------|-------
+  description | Managers
+  displayName | Managers
+  id | 0a545986-9142-4c88-909c-34f3c11abbc4
+  isEnabled | true
+  origin | Application
+  value | managers
+  ```
+
+  </TabItem>
+</Tabs>

package/docs/docs/cmd/aad/app/app-role-remove.mdx

@@ -0,0 +1,78 @@
+import Global from '/docs/cmd/_global.mdx';
+
+# aad app role remove
+
+Removes role from the specified Azure AD app registration
+
+## Usage
+
+```sh
+m365 aad app role remove [options]
+```
+
+## Options
+
+```md definition-list
+`--appId [appId]`
+: Application (client) ID of the Azure AD application registration from which role should be removed. Specify either `appId`, `appObjectId` or `appName`
+
+`--appObjectId [appObjectId]`
+: Object ID of the Azure AD application registration from which role should be removed. Specify either `appId`, `appObjectId` or `appName`
+
+`--appName [appName]`
+: Name of the Azure AD application registration from which role should be removed. Specify either `appId`, `appObjectId` or `appName`
+
+`-n, --name [name]`
+: Name of the role to remove. Specify either `name`, `id` or `claim`
+
+`-i, --id [id]`
+: Id of the role to remove. Specify either `name`, `id` or `claim`
+
+`-c, --claim [claim]`
+: Claim value of the role to remove. Specify either `name`, `id` or `claim`
+
+`--confirm`
+: Don't prompt for confirmation to remove the role.
+```
+
+<Global />
+
+## Remarks
+
+For best performance use the `appObjectId` option to reference the Azure AD application registration from which to remove the role. If you use `appId` or `appName`, this command will first need to find the corresponding object ID for that application.
+
+If the command finds multiple Azure AD application registrations with the specified app name, it will prompt you to disambiguate which app it should use, listing the discovered object IDs.
+
+If the command finds multiple roles with the specified role name, it will prompt you to disambiguate which role it should use, listing the claim values.
+
+If the role to be removed is 'Enabled', this command will disable the role first and then remove.
+
+## Examples
+
+Remove role from a Azure AD application registration using object ID and role name options. Will prompt for confirmation before deleting the role.
+
+```sh
+m365 aad app role remove --appObjectId d75be2e1-0204-4f95-857d-51a37cf40be8 --name "Get Product"
+```
+
+Remove role from a Azure AD application registration using app (client) ID and role claim options. Will prompt for confirmation before deleting the role.
+
+```sh
+m365 aad app role remove --appId e75be2e1-0204-4f95-857d-51a37cf40be8 --claim "Product.Get"
+```
+
+Remove role from a Azure AD application registration using app name and role claim options. Will prompt for confirmation before deleting the role.
+
+```sh
+m365 aad app role remove --appName "My app" --claim "Product.Get"
+```
+
+Remove role from a Azure AD application registration using object ID and role id options. Will NOT prompt for confirmation before deleting the role.
+
+```sh
+m365 aad app role remove --appObjectId d75be2e1-0204-4f95-857d-51a37cf40be8 --id 15927ce6-1933-4b2f-b029-4dee3d53f4dd --confirm
+```
+
+## Response
+
+The command won't return a response on success.

package/docs/docs/cmd/aad/app/app-set.mdx

@@ -0,0 +1,97 @@
+import Global from '/docs/cmd/_global.mdx';
+
+# aad app set
+
+Updates Azure AD app registration
+
+## Usage
+
+```sh
+m365 aad app set [options]
+```
+
+## Options
+
+```md definition-list
+`--appId [appId]`
+: Application (client) ID of the Azure AD application registration to update. Specify either `appId`, `objectId` or `name`
+
+`--objectId [objectId]`
+: Object ID of the Azure AD application registration to update. Specify either `appId`, `objectId` or `name`
+
+`--name [name]`
+: Name of the Azure AD application registration to update. Specify either `appId`, `objectId` or `name`
+
+`-u, --uri [uri]`
+: Comma-separated list of Application ID URIs to update
+
+`-r, --redirectUris [redirectUris]`
+: Comma-separated list of redirect URIs to add to the app registration. Requires `platform` to be specified
+
+`-p, --platform [platform]`
+: Platform for which the `redirectUri` should be configured. Allowed values `spa`, `web`, `publicClient`
+
+`--redirectUrisToRemove [redirectUrisToRemove]`
+: Comma-separated list of existing redirect URIs to remove. Specify, when you want to replace existing redirect URIs with another
+
+`--certificateFile [certificateFile]`
+: Path to the file with certificate public key. Specify either `certificateFile` or `certificateBase64Encoded`
+
+`--certificateBase64Encoded [certificateBase64Encoded]`
+: Base64-encoded string with certificate public key. Specify either `certificateFile` or `certificateBase64Encoded`
+
+`--certificateDisplayName [certificateDisplayName]`
+: Display name for the certificate. If not given, the displayName will be set to the certificate subject. When specified, also specify either `certificateFile` or `certificateBase64Encoded`
+```
+
+<Global />
+
+## Remarks
+
+For best performance use the `objectId` option to reference the Azure AD application registration to update. If you use `appId` or `name`, this command will first need to find the corresponding object ID for that application.
+
+If the command finds multiple Azure AD application registrations with the specified app name, it will prompt you to disambiguate which app it should use, listing the discovered object IDs.
+
+When a certificate is specified it will be added to the list of certificates of the app without changing existing certificates.
+
+## Examples
+
+Update the app URI of the Azure AD application registration specified by its object ID
+
+```sh
+m365 aad app set --objectId d75be2e1-0204-4f95-857d-51a37cf40be8 --uri https://contoso.com/e75be2e1-0204-4f95-857d-51a37cf40be8
+```
+
+Update the app URI of the Azure AD application registration specified by its app (client) ID
+
+```sh
+m365 aad app set --appId e75be2e1-0204-4f95-857d-51a37cf40be8 --uri https://contoso.com/e75be2e1-0204-4f95-857d-51a37cf40be8
+```
+
+Update the app URI of the Azure AD application registration specified by its name
+
+```sh
+m365 aad app set --name "My app" --uri https://contoso.com/e75be2e1-0204-4f95-857d-51a37cf40be8
+```
+
+Add a new redirect URI for SPA authentication
+
+```sh
+m365 aad app set --objectId 95cfe30d-ed44-4f9d-b73d-c66560f72e83 --redirectUris https://contoso.com/auth --platform spa
+```
+
+Replace one redirect URI with another for SPA authentication
+
+```sh
+m365 aad app set --objectId 95cfe30d-ed44-4f9d-b73d-c66560f72e83 --redirectUris https://contoso.com/auth --platform spa --redirectUrisToRemove https://contoso.com/old-auth
+```
+
+Add a certificate to the app
+
+```sh
+m365 aad app set --appId e75be2e1-0204-4f95-857d-51a37cf40be8 --certificateDisplayName "Some certificate name" --certificateFile "c:\temp\some-certificate.cer"
+```
+
+## Response
+
+The command won't return a response on success.