aad app add¶

Creates new Azure AD app registration

Usage¶

m365 aad app add [options]

Options¶

-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.
-h, --help [help]: Output usage information. Optionally, specify which section of command's help you want to see. Allowed values are options, examples, remarks, response, full. Default is full.
--query [query]: JMESPath query string. See http://jmespath.org/ for more information and examples
-o, --output [output]: Output type. json,text,csv,md. Default json
--verbose: Runs command with verbose logging
--debug: Runs command with debug logging

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

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

m365 aad app add --manifest @manifest.json

Create new multitenant Azure AD app registration

m365 aad app add --name 'My AAD app' --multitenant

Create new Azure AD app registration for a web app with the specified redirect URIs

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

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)

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

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

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

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

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

 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.

m365 aad app add --name 'My AAD app' --save

Create new Azure AD app registration with a certificate

m365 aad app add --name 'My AAD app' --certificateDisplayName "Some certificate name" --certificateFile "c:\temp\some-certificate.cer"