Skip to content

login

Log in to Office 365

Usage

login [options]

Options

Option Description
--help output usage information
-t, --authType [authType] The type of authentication to use. Allowed values certificate|deviceCode|password. Default deviceCode
-u, --userName [userName] Name of the user to authenticate. Required when authType is set to password
-p, --password [password] Password for the user. Required when authType is set to password
-c, --certificateFile [certificateFile] Path to the file with certificate private key. Required when authType is set to certificate
--thumbprint [thumbprint] Certificate thumbprint. Required when authType is set to certificate
-o, --output [output] Output type. json|text. Default text
--verbose Runs command with verbose logging
--debug Runs command with debug logging

Remarks

Using the login command you can log in to Office 365.

By default, the login command uses device code OAuth flow to log in to Office 365. Alternatively, you can authenticate using a user name and password or certificate, which are convenient for CI/CD scenarios, but which come with their own limitations. See the Office 365 CLI manual for more information.

When logging in to Office 365, the login command stores in memory the access token and the refresh token. Both tokens are cleared from memory after exiting the CLI or by calling the logout command.

When logging in to Office 365 using the user name and password, next to the access and refresh token, the Office 365 CLI will store the user credentials so that it can automatically re-authenticate if necessary. Similarly to the tokens, the credentials are removed by re-authenticating using the device code or by calling the logout command.

When logging in to Office 365 using a certificate, the Office 365 CLI will store the contents of the certificate so that it can automatically re-authenticate if necessary. The contents of the certificate are removed by re-authenticating using the device code or by calling the logout command.

To log in to Office 365 using a certificate, you will typically create a custom Azure AD application. To use this application with the Office 365 CLI, you will set the OFFICE365CLI_AADAPPID environment variable to the application's ID and the OFFICE365CLI_TENANT environment variable to the ID of the Azure AD tenant, where you created the Azure AD application.

Examples

Log in to Office 365 using the device code

login

Log in to Office 365 using the device code in debug mode including detailed debug information in the console output

login --debug

Log in to Office 365 using a user name and password

login --authType password --userName user@contoso.com --password pass@word1

Log in to Office 365 using a PEM certificate

login --authType certificate --certificateFile /Users/user/dev/localhost.pem --thumbprint 47C4885736C624E90491F32B98855AA8A7562AF1

Log in to Office 365 using a personal information exchange (.pfx) file

login --authType certificate --certificateFile /Users/user/dev/localhost.pfx --thumbprint 47C4885736C624E90491F32B98855AA8A7562AF1 --password 'pass@word1'