@pnp/cli-microsoft365 6.8.0-beta.f473be5 → 6.9.0-beta.148279d

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

@@ -0,0 +1,297 @@
+import Global from '/docs/cmd/_global.mdx';
+import Tabs from '@theme/Tabs';
+import TabItem from '@theme/TabItem';
+
+# aad app add
+
+Creates new Azure AD app registration
+
+## Usage
+
+```sh
+m365 aad app add [options]
+```
+
+## Options
+
+```md definition-list
+`-n, --name [name]`
+: Name of the app. Specify either `name` or `manifest` but not both.
+
+`--multitenant`
+: Specify, to make the app available to other tenants.
+
+`-r, --redirectUris [redirectUris]`
+: Comma-separated list of redirect URIs. Requires `platform` to be specified.
+
+`-p, --platform [platform]`
+: Platform for which the `redirectUris` should be configured. Allowed values `spa`, `web`, `publicClient`.
+
+`--implicitFlow`
+: Specify, to indicate that the authorization endpoint should return ID and access tokens.
+
+`-s, --withSecret`
+: When specified, will create a secret named `Default` and set it to expire 1 year in the future.
+
+`--apisDelegated [apisDelegated]`
+: Comma-separated list of delegated permissions to register with the app.
+
+`--apisApplication [apisApplication]`
+: Comma-separated list of application permissions to register with the app.
+
+`-u, --uri [uri]`
+: Application ID URI.
+
+`--scopeName [scopeName]`
+: Name of the scope to add. Requires `uri` to be specified.
+
+`--scopeConsentBy [scopeConsentBy]`
+: Specifies if the scope can be consented only by admins or by admins and users. Allowed values `admins`, `adminsAndUsers`. Default `admins`.
+
+`--scopeAdminConsentDisplayName [scopeAdminConsentDisplayName]`
+: Scope admin consent display name.
+
+`--scopeAdminConsentDescription [scopeAdminConsentDescription]`
+: Scope admin consent description.
+
+`--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`.
+
+`--grantAdminConsent`
+: When specified, grants application & delegated permissions through admin consent.
+
+`--manifest [manifest]`
+: Azure AD app manifest as retrieved from the Azure Portal to create the app registration from. Specify either `name` or `manifest` but not both.
+
+`--save`
+: Use to store the information about the created app in a local file.
+```
+
+<Global />
+
+## Remarks
+
+You can use this command to create a new Azure AD app registration either by specifying the different configuration settings through the corresponding options or by using the manifest.
+
+If you don't use the manifest, you must specify the name of the Azure AD app registration using the `name` option. If you use the manifest, you can skip the `name` option assuming the manifest contains the `displayName` property.
+
+You can also use the manifest to provision some of the configuration settings of your Azure AD app. All properties specified in the manifest are optional and will set if specified.
+
+If you specify the manifest along with some options, values specified in the options will override settings from the manifest. One exception is the name specified in the `name` option which will be overridden by the `displayName` property from the manifest if specified.
+
+The following properties specified in the manifest retrieved from Azure AD are not supported by this command:
+
+- accessTokenAcceptedVersion
+- disabledByMicrosoftStatus
+- errorUrl
+- oauth2RequirePostResponse
+- oauth2AllowUrlPathMatching
+- orgRestrictions
+- samlMetadataUrl
+
+When specifying the value for the `uri`, you can use the `_appId_` token, to include the ID of the newly generated Azure AD app registration in the Application ID URI, eg. URI `api://caf406b91cd4.ngrok.io/_appId_` will become `api://caf406b91cd4.ngrok.io/ab3bd119-faf7-4db5-ba99-eb7e748f778a` where the last portion is the app ID of the created Azure AD app registration.
+
+When using the `withSecret` option, this command will automatically generate a secret named `Default` and set it to expire 1 year in the future.
+
+After creating the Azure AD app registration, this command returns the app ID and object ID of the created app registration. If you used the `withSecret` option, it will also return the generated secret.
+
+If you want to store the information about the created Azure AD app registration, use the `--save` option. This is useful when you build solutions connected to Microsoft 365 and want to easily manage app registrations used with your solution. When you use the `--save` option, after you create the app registration, the command will write its ID and name to the `.m365rc.json` file in the current directory. If the file already exists, it will add the information about the to it, allowing you to track multiple apps. If the file doesn't exist, the command will create it.
+
+When specifying `--grantAdminConsent` option, a service principal will be created for the app registration.
+
+## Examples
+
+Create new Azure AD app registration with the specified name
+
+```sh
+m365 aad app add --name 'My AAD app'
+```
+
+Create new Azure AD app registration from the manifest retrieved from the Azure Portal stored in a local file named _manifest.json_
+
+```sh
+m365 aad app add --manifest @manifest.json
+```
+
+Create new multitenant Azure AD app registration
+
+```sh
+m365 aad app add --name 'My AAD app' --multitenant
+```
+
+Create new Azure AD app registration for a web app with the specified redirect URIs
+
+```sh
+m365 aad app add --name 'My AAD app' --redirectUris 'https://myapp.azurewebsites.net,http://localhost:4000' --platform web
+```
+
+Create new Azure AD app registration for a desktop app
+
+```sh
+m365 aad app add --name 'My AAD app' --redirectUris 'https://login.microsoftonline.com/common/oauth2/nativeclient' --platform publicClient
+```
+
+Create new Azure AD app registration with an auto-generated secret (secret returned in the command output)
+
+```sh
+m365 aad app add --name 'My AAD app' --withSecret
+```
+
+Create new Azure AD app registration for a daemon app with specified Microsoft Graph application permissions
+
+```sh
+m365 aad app add --name 'My AAD app' --withSecret --apisApplication 'https://graph.microsoft.com/Group.ReadWrite.All,https://graph.microsoft.com/Directory.Read.All'
+```
+
+Create new Azure AD app registration for a single-page app with specified Microsoft Graph delegated permissions
+
+```sh
+m365 aad app add --name 'My AAD app' --platform spa --redirectUris 'https://myspa.azurewebsites.net,http://localhost:8080' --apisDelegated 'https://graph.microsoft.com/Calendars.Read,https://graph.microsoft.com/Directory.Read.All' --implicitFlow
+```
+
+Create new Azure AD app registration with Application ID URI set to a fixed value
+
+```sh
+m365 aad app add --name 'My AAD app' --uri https://contoso.onmicrosoft.com/myapp
+```
+
+Create new Azure AD app registration with Application ID URI set to a value that contains the ID of the app registration, designated with the `_appId_` token and a custom API scope that can be consented by both admins and users
+
+```sh
+m365 aad app add --name 'My AAD app' --uri api://caf406b91cd4.ngrok.io/_appId_ --scopeName access_as_user --scopeAdminConsentDescription 'Access as a user' --scopeAdminConsentDisplayName 'Access as a user' --scopeConsentBy adminsAndUsers
+```
+
+Create new Azure AD app registration for a daemon app with specified Microsoft Graph application permissions, including admin consent
+
+```sh
+ m365 aad app add --name 'My AAD app' --apisApplication 'https://graph.microsoft.com/Group.ReadWrite.All' --grantAdminConsent
+```
+
+Create new Azure AD app registration with the specified name. Store information about the created app registration in the _.m365rc.json_ file in the current directory.
+
+```sh
+m365 aad app add --name 'My AAD app' --save
+```
+
+Create new Azure AD app registration with a certificate
+
+```sh
+m365 aad app add --name 'My AAD app' --certificateDisplayName "Some certificate name" --certificateFile "c:\temp\some-certificate.cer"
+```
+
+## Response
+
+### Standard response
+
+<Tabs>
+  <TabItem value="JSON">
+
+  ```json
+  {
+    "appId": "68e9f0dd-c743-4693-9ba4-d78e91bd13cc",
+    "objectId": "d4d7d33a-d40e-4606-b67d-de6cdbfaa01f",
+    "tenantId": "1e852b49-bf4b-4ba5-bcd4-a8c4706c8ed4"
+  }
+  ```
+
+  </TabItem>
+  <TabItem value="Text">
+
+  ```text
+  appId   : 908db832-dac2-4622-98b3-b492fdc74f80
+  objectId: 089066cc-2c81-4188-9b6b-7b86e861a169
+  tenantId: 1e852b49-bf4b-4ba5-bcd4-a8c4706c8ed4
+  ```
+
+  </TabItem>
+  <TabItem value="CSV">
+
+  ```csv
+  appId,objectId,tenantId
+  9db26abb-dd17-48f1-b790-765d14d834b6,5c803709-e0b8-4a4f-a43f-f4ad39fdee45,1e852b49-bf4b-4ba5-bcd4-a8c4706c8ed4
+  ```
+
+  </TabItem>
+  <TabItem value="Markdown">
+
+  ```md
+  # aad app add --name "My AAD app"
+
+  Date: 2023-06-01
+
+  ## 8e60ecac-34b4-404c-832d-f1c77bc27b78
+
+  Property | Value
+  ---------|-------
+  appId | f86600df-9842-4f25-b7cf-242f3736b137
+  objectId | 8e60ecac-34b4-404c-832d-f1c77bc27b78
+  tenantId | 1e852b49-bf4b-4ba5-bcd4-a8c4706c8ed4
+  ```
+
+  </TabItem>
+</Tabs>
+
+### `withSecret` response
+
+When we make use of the option `withSecret` the response will differ. 
+
+<Tabs>
+  <TabItem value="JSON">
+
+  ```json
+  {
+    "appId": "efb2ec4c-d247-446b-9efd-0f8141652711",
+    "objectId": "c8bdc471-ba5a-45c9-b725-5fc83bfc9c59",
+    "tenantId": "1e852b49-bf4b-4ba5-bcd4-a8c4706c8ed4",
+    "secrets": [
+      {
+        "displayName": "Default",
+        "value": "Bhc8Q~EhE26SCWAxSlKpfwTkbfdHtsXxVJNTtagT"
+      }
+    ]
+  }
+  ```
+
+  </TabItem>
+  <TabItem value="Text">
+
+  ```text
+  appId   : 748e1b24-8fa6-4f54-a3f2-5f84ffcffdbe
+  objectId: 6aa9fde7-d58a-4211-a84a-b7252ac6087b
+  secrets : [{"displayName":"Default","value":"6JA8Q~_4SzAbj3bQgzap~vNscazQzXBBEcxDHdd5"}]
+  tenantId: 1e852b49-bf4b-4ba5-bcd4-a8c4706c8ed4
+  ```
+
+  </TabItem>
+  <TabItem value="CSV">
+
+  ```csv
+  appId,objectId,tenantId
+  06700d67-0c97-402a-8c09-802049ffd70f,1eb0491f-1c88-490f-b2b3-18dc501938a1,1e852b49-bf4b-4ba5-bcd4-a8c4706c8ed4
+  ```
+
+  </TabItem>
+  <TabItem value="Markdown">
+
+  ```md
+  # aad app add --name "My AAD app" --withSecret "true"
+
+  Date: 2023-06-01
+
+  ## a5cb917a-ebf3-4c3c-82db-90aa122495b4
+
+  Property | Value
+  ---------|-------
+  appId | 3d1a4664-2634-4b35-9e42-1fa24abfda89
+  objectId | a5cb917a-ebf3-4c3c-82db-90aa122495b4
+  tenantId | 1e852b49-bf4b-4ba5-bcd4-a8c4706c8ed4
+  ```
+
+  </TabItem>
+</Tabs>

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

@@ -0,0 +1,280 @@
+import Global from '/docs/cmd/_global.mdx';
+import Tabs from '@theme/Tabs';
+import TabItem from '@theme/TabItem';
+
+# aad app get
+
+Gets an Azure AD app registration
+
+## Usage
+
+```sh
+m365 aad app get [options]
+```
+
+## Options
+
+```md definition-list
+`--appId [appId]`
+: Application (client) ID of the Azure AD application registration to get. Specify either `appId`, `objectId` or `name`
+
+`--objectId [objectId]`
+: Object ID of the Azure AD application registration to get. Specify either `appId`, `objectId` or `name`
+
+`--name [name]`
+: Name of the Azure AD application registration to get. Specify either `appId`, `objectId` or `name`
+
+`--save`
+: Use to store the information about the created app in a local file
+```
+
+<Global />
+
+## Remarks
+
+For best performance use the `objectId` option to reference the Azure AD application registration to get. 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.
+
+If you want to store the information about the Azure AD app registration, use the `--save` option. This is useful when you build solutions connected to Microsoft 365 and want to easily manage app registrations used with your solution. When you use the `--save` option, after you get the app registration, the command will write its ID and name to the `.m365rc.json` file in the current directory. If the file already exists, it will add the information about the App registration to it if it's not already present, allowing you to track multiple apps. If the file doesn't exist, the command will create it.
+
+## Examples
+
+Get the Azure AD application registration by its app (client) ID
+
+```sh
+m365 aad app get --appId d75be2e1-0204-4f95-857d-51a37cf40be8
+```
+
+Get the Azure AD application registration by its object ID
+
+```sh
+m365 aad app get --objectId d75be2e1-0204-4f95-857d-51a37cf40be8
+```
+
+Get the Azure AD application registration by its name
+
+```sh
+m365 aad app get --name "My app"
+```
+
+Get the Azure AD application registration by its name. Store information about the retrieved app registration in the _.m365rc.json_ file in the current directory.
+
+```sh
+m365 aad app get --name "My app" --save
+```
+
+## Response
+
+<Tabs>
+  <TabItem value="JSON">
+
+  ```json
+  {
+    "id": "0d2eb848-da5f-4131-b739-941150b3a43d",
+    "deletedDateTime": null,
+    "appId": "9eb465b4-eed9-4fb2-aa7a-4dfe18a52a4d",
+    "applicationTemplateId": null,
+    "disabledByMicrosoftStatus": null,
+    "createdDateTime": "2021-07-22T09:19:45Z",
+    "displayName": "helloworld",
+    "description": null,
+    "groupMembershipClaims": null,
+    "identifierUris": [
+      "api://helloworldfe087840.z13.web.core.windows.net/9eb465b4-eed9-4fb2-aa7a-4dfe18a52a4d"
+    ],
+    "isDeviceOnlyAuthSupported": null,
+    "isFallbackPublicClient": null,
+    "notes": null,
+    "publisherDomain": "contoso.onmicrosoft.com",
+    "serviceManagementReference": null,
+    "signInAudience": "AzureADMyOrg",
+    "tags": [],
+    "tokenEncryptionKeyId": null,
+    "samlMetadataUrl": null,
+    "defaultRedirectUri": null,
+    "certification": null,
+    "servicePrincipalLockConfiguration": null,
+    "requestSignatureVerification": null,
+    "addIns": [],
+    "api": {
+      "acceptMappedClaims": null,
+      "knownClientApplications": [],
+      "requestedAccessTokenVersion": 2,
+      "oauth2PermissionScopes": [
+        {
+          "adminConsentDescription": "Allows Teams to call the app’s web APIs as the current user.",
+          "adminConsentDisplayName": "Teams can access app’s web APIs",
+          "id": "90e24c9e-6bb5-4a59-82b3-7f744e3bcb4c",
+          "isEnabled": true,
+          "type": "User",
+          "userConsentDescription": "Enable Teams to call this app’s web APIs with the same rights that you have",
+          "userConsentDisplayName": "Teams can access app’s web APIs and make requests on your behalf",
+          "value": "access_as_user"
+        }
+      ],
+      "preAuthorizedApplications": [
+        {
+          "appId": "1fec8e78-bce4-4aaf-ab1b-5451cc387264",
+          "delegatedPermissionIds": [
+            "90e24c9e-6bb5-4a59-82b3-7f744e3bcb4c"
+          ]
+        },
+        {
+          "appId": "5e3ce6c0-2b1f-4285-8d4b-75ee78787346",
+          "delegatedPermissionIds": [
+            "90e24c9e-6bb5-4a59-82b3-7f744e3bcb4c"
+          ]
+        }
+      ]
+    },
+    "appRoles": [],
+    "info": {
+      "logoUrl": null,
+      "marketingUrl": null,
+      "privacyStatementUrl": null,
+      "supportUrl": null,
+      "termsOfServiceUrl": null
+    },
+    "keyCredentials": [],
+    "optionalClaims": {
+      "accessToken": [
+        {
+          "additionalProperties": [],
+          "essential": false,
+          "name": "idtyp",
+          "source": null
+        }
+      ],
+      "idToken": [],
+      "saml2Token": []
+    },
+    "parentalControlSettings": {
+      "countriesBlockedForMinors": [],
+      "legalAgeGroupRule": "Allow"
+    },
+    "passwordCredentials": [
+      {
+        "customKeyIdentifier": null,
+        "displayName": null,
+        "endDateTime": "2023-07-22T09:19:47.8601311Z",
+        "hint": "QBU",
+        "keyId": "24ae17c4-c593-4ddc-a15e-440071204813",
+        "secretText": null,
+        "startDateTime": "2021-07-22T09:19:47.8601311Z"
+      }
+    ],
+    "publicClient": {
+      "redirectUris": []
+    },
+    "requiredResourceAccess": [
+      {
+        "resourceAppId": "00000003-0000-0000-c000-000000000000",
+        "resourceAccess": [
+          {
+            "id": "e1fe6dd8-ba31-4d61-89e7-88639da4683d",
+            "type": "Scope"
+          }
+        ]
+      }
+    ],
+    "verifiedPublisher": {
+      "displayName": null,
+      "verifiedPublisherId": null,
+      "addedDateTime": null
+    },
+    "web": {
+      "homePageUrl": null,
+      "logoutUrl": null,
+      "redirectUris": [
+        "https://helloworldfe087840.z13.web.core.windows.net/auth-end.html"
+      ],
+      "implicitGrantSettings": {
+        "enableAccessTokenIssuance": false,
+        "enableIdTokenIssuance": false
+      },
+      "redirectUriSettings": [
+        {
+          "uri": "https://helloworldfe087840.z13.web.core.windows.net/auth-end.html",
+          "index": null
+        }
+      ]
+    },
+    "spa": {
+      "redirectUris": []
+    }
+  }
+  ```
+
+  </TabItem>
+  <TabItem value="Text">
+
+  ```text
+  addIns                           : []
+  api                              : {"acceptMappedClaims":null,"knownClientApplications":[],"requestedAccessTokenVersion":2,"oauth2PermissionScopes":[{"adminConsentDescription":"Allows Teams to call the app’s web APIs as the current user.","adminConsentDisplayName":"Teams can access app’s web APIs","id":"90e24c9e-6bb5-4a59-82b3-7f744e3bcb4c","isEnabled":true,"type":"User","userConsentDescription":"Enable Teams to call this app’s web APIs with the same rights that you have","userConsentDisplayName":"Teams can access app’s web APIs and make requests on your behalf","value":"access_as_user"}],"preAuthorizedApplications":[{"appId":"1fec8e78-bce4-4aaf-ab1b-5451cc387264","delegatedPermissionIds":["90e24c9e-6bb5-4a59-82b3-7f744e3bcb4c"]},{"appId":"5e3ce6c0-2b1f-4285-8d4b-75ee78787346","delegatedPermissionIds":["90e24c9e-6bb5-4a59-82b3-7f744e3bcb4c"]}]}
+  appId                            : 9eb465b4-eed9-4fb2-aa7a-4dfe18a52a4d
+  appRoles                         : []
+  applicationTemplateId            : null
+  certification                    : null
+  createdDateTime                  : 2021-07-22T09:19:45Z
+  defaultRedirectUri               : null
+  deletedDateTime                  : null
+  description                      : null
+  disabledByMicrosoftStatus        : null
+  displayName                      : helloworld
+  groupMembershipClaims            : null
+  id                               : 0d2eb848-da5f-4131-b739-941150b3a43d
+  identifierUris                   : ["api://helloworldfe087840.z13.web.core.windows.net/9eb465b4-eed9-4fb2-aa7a-4dfe18a52a4d"]
+  info                             : {"logoUrl":null,"marketingUrl":null,"privacyStatementUrl":null,"supportUrl":null,"termsOfServiceUrl":null}
+  isDeviceOnlyAuthSupported        : null
+  isFallbackPublicClient           : null
+  keyCredentials                   : []
+  notes                            : null
+  optionalClaims                   : {"accessToken":[{"additionalProperties":[],"essential":false,"name":"idtyp","source":null}],"idToken":[],"saml2Token":[]}
+  parentalControlSettings          : {"countriesBlockedForMinors":[],"legalAgeGroupRule":"Allow"}
+  passwordCredentials              : [{"customKeyIdentifier":null,"displayName":null,"endDateTime":"2023-07-22T09:19:47.8601311Z","hint":"QBU","keyId":"24ae17c4-c593-4ddc-a15e-440071204813","secretText":null,"startDateTime":"2021-07-22T09:19:47.8601311Z"}]
+  publicClient                     : {"redirectUris":[]}
+  publisherDomain                  : contoso.onmicrosoft.com
+  requestSignatureVerification     : null
+  requiredResourceAccess           : [{"resourceAppId":"00000003-0000-0000-c000-000000000000","resourceAccess":[{"id":"e1fe6dd8-ba31-4d61-89e7-88639da4683d","type":"Scope"}]}]
+  samlMetadataUrl                  : null
+  serviceManagementReference       : null
+  servicePrincipalLockConfiguration: null
+  signInAudience                   : AzureADMyOrg
+  spa                              : {"redirectUris":[]}
+  tags                             : []
+  tokenEncryptionKeyId             : null
+  verifiedPublisher                : {"displayName":null,"verifiedPublisherId":null,"addedDateTime":null}
+  web                              : {"homePageUrl":null,"logoutUrl":null,"redirectUris":["https://helloworldfe087840.z13.web.core.windows.net/auth-end.html"],"implicitGrantSettings":{"enableAccessTokenIssuance":false,"enableIdTokenIssuance":false},"redirectUriSettings":[{"uri":"https://helloworldfe087840.z13.web.core.windows.net/auth-end.html","index":null}]}
+  ```
+
+  </TabItem>
+  <TabItem value="CSV">
+
+  ```csv
+  id,appId,createdDateTime,displayName,publisherDomain,signInAudience
+  0d2eb848-da5f-4131-b739-941150b3a43d,9eb465b4-eed9-4fb2-aa7a-4dfe18a52a4d,2021-07-22T09:19:45Z,helloworld,contoso.onmicrosoft.com,AzureADMyOrg
+  ```
+
+  </TabItem>
+  <TabItem value="Markdown">
+
+  ```md
+  # aad app get --appId "9eb465b4-eed9-4fb2-aa7a-4dfe18a52a4d"
+
+  Date: 2023-06-01
+
+  ## helloworld (0d2eb848-da5f-4131-b739-941150b3a43d)
+
+  Property | Value
+  ---------|-------
+  id | 0d2eb848-da5f-4131-b739-941150b3a43d
+  appId | 9eb465b4-eed9-4fb2-aa7a-4dfe18a52a4d
+  createdDateTime | 2021-07-22T09:19:45Z
+  displayName | helloworld
+  publisherDomain | contoso.onmicrosoft.com
+  signInAudience | AzureADMyOrg
+  ```
+
+  </TabItem>
+</Tabs>