iCloud Authentication

Multi-Factor Authentication

If your Apple account has two-factor authentication (multifactor authentication, MFA) enabled, you will be prompted for a code when you run the script. Two-factor authentication will expire after an interval set by Apple, at which point you will have to re-authenticate. This interval is currently two months. Apple requires MFA for all new accounts.

You can receive an email notification when two-factor authentication expires by passing the --smtp-username and --smtp-password options. Emails will be sent to --smtp-username by default, or you can send to a different email address with --notification-email.

If you want to send notification emails using your Gmail account, and you have enabled two-factor authentication, you will need to generate an App Password at https://myaccount.google.com/apppasswords

MFA Providers

Added in version 1.21.0.

There are two ways to provide MFA code to icloudpd:

  • Using console

  • Using web interface

The choice can be made with --mfa-provider parameter.

Default: console

FIDO

Authentication to iCloud with hardware keys (FIDO) is not supported.

ADP

Advanced Data Protection (ADP) for iCloud accounts is not supported because icloudpd simulates web access, which is disabled with ADP.

Occasional Errors

Some authentication errors may be resolved by clearing .pycloud subfolder in the user’s home directory. Example

System Keyring

You can store your password in the system keyring using the icloud command-line tool:

$ icloud --username jappleseed@apple.com
ICloud Password for jappleseed@apple.com:
Save password in keyring? (y/N)

If you have stored a password in the keyring, you will not be required to provide a password when running the script.

If you would like to delete a password stored in your system keyring, you can clear a stored password using the --delete-from-keyring command-line option:

icloud --username jappleseed@apple.com --delete-from-keyring

Note

Use icloud, not icloudpd

Password Providers

Added in version 1.20.0.

Added in version 1.21.0: WebUI support

Passwords for iCloud access can be supplied by user in four ways:

  • Using --password command line parameter

  • Using keyring

  • Using console

  • Using web interface

It is possible to specify which of these three ways icloudpd should use, by specifying them with --password-provider parameter. More than one can be specified and the order of providers matches the order then will be checked for password. E.g. --password-provider keyring --password-provider console means that icloudpd will check password in keyring first and then, if no password found, ask for password in the console.

Keyring password provider, if specified, saves valid password back into keyring.

Console and Web UI are not compatible with each other. Console or WebUI providers, if specified, must be last in the list of providers because they cannot be skipped.

Default set and order of providers are: parameter, keyring, console