Errori
L'API restituisce il successo standard HTTP o i codici di stato degli errori per tutte le operazioni. Per gli errori, la risposta includerà il corrispondente codice di errore, un breve messaggio che descrive la causa dell'errore e facoltativamente campi aggiuntivi che trasmettono informazioni specifiche per quell'errore.
Codici di stato
| code | name | description |
|---|---|---|
| 200 | OK | The request was processed succesfully. |
| 201 | Created | The request was processed successfully, and a new resource instance was created. |
| 400 | Bad Request | The API was unable to process the request as it was malformed in some way. |
| 401 | Unauthorized | The API was unable to find valid credentials in the request. |
| 403 | Forbidden | The credentials provided do not have sufficient permissions to perform the request. |
| 404 | Not Found | The requested resources cannot be found. |
| 429 | Too Many Requests | The request has not been processed as a rate limit has been reached. |
| 5xx | Internal Server Error | An unexpected error occurred while processing the event. |
Codici di errore
invalid-body
L'API non è stata in grado di elaborare il corpo della richiesta. Assicurati che il corpo della richiesta sia JSON valido.
invalid-parameter
Uno o più parametri nel corpo della richiesta non hanno superato i controlli di convalida. Questa risposta includerà un attributo params con maggiori dettagli sui parametri offensivi.
unconfigured
La tua organizzazione non ha la configurazione richiesta per l'API per completare questa richiesta. Il messaggio includerà dettagli su quale configurazione manca.
missing-scope
La tua organizzazione, la chiave o l'utente corrente non ha gli ambiti di permesso richiesti per eseguire questa richiesta.
limit-exceeded
La richiesta non può essere completata in quanto violerebbe un limite imposto alla tua organizzazione, chiave o utente corrente. Ad esempio, un utente che è limitato ad accedere a due account iCloud al mese riceverà questo errore se tenta di accedere a un terzo account.
session-expired
La sessione che stai tentando di utilizzare per questa richiesta è stata contrassegnata come scaduta dall'API. È necessario creare una nuova sessione valida prima di procedere.
invalid-credentials
Le credenziali fornite sono state respinte dal servizio esterno. O la fonte non esiste (ad es. Nome utente non valido) o il carico utile delle credenziali è errato (come una password errata).
source-locked
L'origine è stata bloccata dal servizio esterno e non è accessibile dall'API finché non viene sbloccata dall'utente. Il messaggio API fornirà le istruzioni su come eseguire questa operazione per il servizio pertinente.
code-required
L'origine alla quale si sta tentando di creare una sessione è abilitata per l'autenticazione a più fattori (MFA). L'API avrà attivato il processo MFA e dovrai fornire il codice presentato durante questo processo al tentativo successivo di creazione della sessione.
Per ulteriori dettagli sul flusso di creazione della sessione, consultare il riferimento del servizio per il servizio a cui si sta tentando di accedere.
code-rate-limited
L'utente ha tentato spesso di creare una sessione utilizzando un codice non valido ed è stato limitato dalla tariffa dal servizio. Si consiglia all'utente di attendere almeno un'ora prima di riprovare.
choice-required
La sorgente che stai tentando di accedere è la verifica in 2 passaggi (2SV) abilitata, un sottoinsieme di autenticazione a più fattori (MFA). Come parte di questa risposta, l'API fornirà un elenco di dispositivi su cui può attivare il processo 2SV; questo dispositivo riceverà il codice 2SV che sarà necessario per la fase successiva del processo.
Per ulteriori dettagli sul flusso di creazione della sessione, consultare il riferimento del servizio per il servizio a cui si sta tentando di accedere.
task-error
Si è verificato un errore di attività generico. Riprovare il poll o l'attività potrebbe risolvere il problema. Contatta l'assistenza se il problema persiste.
Codici di errore del servizio iCloud
icloud-terms-not-accepted
L'utente non ha accettato i più recenti Termini di servizio di iCloud. Possono accettare i termini accedendo all'App Store su un dispositivo iOS o macOS utilizzando il proprio account o accedendo a iCloud.com .
icloud-account-not-verified
L'indirizzo email principale associato all'account iCloud non è stato ancora verificato. L'utente deve completare il processo di verifica dell'email per attivare l'account. Il processo di verifica può essere gestito accedendo a appleid.apple.com .
icloud-service-not-activated
Il servizio iCloud necessario per completare l'operazione non è stato attivato sull'account iCloud in uso. Ad esempio, se l'utente non ha abilitato iCloud Photo Library sull'account, questo errore verrà generato quando si tenta di recuperare icpl.photos .
Assicurarsi che l'utente abbia attivato le impostazioni associate di un servizio per assicurarsi che sia attivato.
icloud-service-outage
Impossibile completare l'operazione a causa di un'interruzione di iCloud. Questi sono molto rari e in genere transitori - il tentativo di riprovare in pochi minuti dovrebbe avere successo. Tuttavia, se il problema persiste, cerca ulteriori informazioni nella pagina di stato di iCloud e nella pagina di stato dell'API e contatta l'assistenza.
