exportUsers
Categoria | Recupero dei metadati |
Descrizione | Restituisce i metadati per l'elenco completo di tutti gli utenti nell'istanza. |
Autorizzazioni necessarie per richiamare | Amministratore utente |
Parametri obbligatori su richiesta | Credenziali |
La richiesta di questo metodo contiene solo un tag di credenziali per identificare e autorizzare l'utente chiamante. Una volta verificato, il metodo restituisce un documento XML che descrive l'insieme completo di tutti gli utenti definiti nell'istanza.
Formato richiesta
<?xml version='1.0' encoding='UTF-8'?> <call method="exportUsers" callerName="a string that identifies your client application"> <credentials login="sampleuser@company.com" password="my_pwd"/> </call>
elemento credenziali | |||
Nome tag | credenziali | ||
Descrizione | Tutte le chiamate API devono contenere un singolo elemento di credenziali per identificare l'utente che richiama l'API. La chiamata API viene quindi eseguita come utente (qualsiasi audit trail o storico delle azioni nel sistema mostrerà che l'azione è stata eseguita dall'utente) e pertanto l'utente deve disporre delle autorizzazioni necessarie per eseguire l'azione affinché la chiamata API avere esito positivo. | ||
Attributi dell'elemento | |||
Nome attributo | Obbligatorio? | Valore | Esempio |
accedere | S | Il nome di accesso dell'utente che richiama il metodo API. L'utente deve disporre delle autorizzazioni necessarie per richiamare il metodo. | sampleuser@company.com |
password | S | La password dell'utente che richiama il metodo API. | my_password |
impostazioni internazionali | N | Specificare le impostazioni internazionali da utilizzare per interpretare i numeri e le date in entrata e per formattare i numeri e le date in uscita (utilizzando il separatore delle migliaia, i nomi dei mesi e la formattazione della data appropriati). Le impostazioni internazionali vengono utilizzate anche per specificare la lingua in cui devono essere visualizzati i messaggi di sistema nella risposta. Se non viene specificato, viene utilizzato en_US (inglese americano). | fr_FR |
instanceCode | N | Se l'utente specificato nelle credenziali ha accesso a più istanze di Adaptive Planning , questo attributo può essere utilizzato per specificare che l'utente intende accedere a un'istanza diversa da quella predefinita. Se non viene specificata, verrà utilizzata l'istanza predefinita dell'utente. Per determinare i codici di istanza disponibili, utilizzare l'API exportInstances. | MYINSTANCE1 |
Contenuto dell'elemento | |||
(nessuno) | |||
elemento include Disponibile nell'API v17 e versioni precedenti. Non disponibile nell'API v18+. | |||
Nome tag | includere | ||
Descrizione | Rappresenta un insieme di flag che indicano quali aspetti delle informazioni degli utenti devono essere inclusi o esclusi dalla risposta. Questo elemento è facoltativo: se non è presente, i valori predefiniti sono true perownedLevels e false per hiddenVersions. | ||
Attributi dell'elemento | |||
Nome attributo | Obbligatorio? | Valore | Esempio |
gruppi Disponibile nell'API v23+. | N | La parola vera o falsa. Indica se gli elementi utente nella risposta includono un attributo groupIds. Se è vero, il valore groupIds nella risposta contiene un elenco separato da virgole di tutti i gruppi in cui si trova l'utente. Se l'attributo non è presente o se il suo valore è diverso da vero o falso, viene utilizzato il valore predefinito false. | true |
possedutoLevels Disponibile nell'API v17 e versioni precedenti. Non disponibile nell'API v18+. | N | La parola vera o falsa. Indica se gli elementi utente nella risposta devono includere o meno gli attributiownedLevels. Se l'attributo non è presente o se il suo valore è diverso da true o false, viene utilizzato il valore predefinito true. | true |
hiddenVersions Disponibile nell'API v17 e versioni precedenti. Non disponibile nell'API v18+. | N | La parola vera o falsa. Indica se gli elementi utente nella risposta devono includere o meno gli attributi hiddenVersions. Se l'attributo non è presente o se il suo valore è diverso da vero o falso, viene utilizzato il valore predefinito false. | falso |
Contenuto dell'elemento | |||
(nessuno) | |||
Formato risposta
<?xml version='1.0' encoding='UTF-8'?> <response success="true"> <output> <users seqNo="55"> <user id="19" guid="B9ADBCB81AA2F9BAE040307F02092C2E" login="analytica@fakecompany.com" email="analytica@fakecompany.com" name="Anna Analyzer" permissionSetId="3" timeZone="US/Pacific"/> <user id="123" guid="AAFF5218D55ABB9234660001BEC117A9" login="randomuser@fakecompany.com" email="randomuser@fakecompany.com" name="J. Random User" permissionSetId="2" timeZone="US/Pacific"/> </users> </output> </response>
elemento di risposta | |||
Nome tag | risposta | ||
Attributi dell'elemento | |||
Nome attributo | Obbligatorio? | Valore | Esempio |
successo | S | Vero o falso, a indicare se la chiamata API è riuscita o meno. Anche le chiamate riuscite possono contenere messaggi di avviso nella risposta. | true |
obsoleto | N | Se presente nel tag di risposta e impostato su true, questo attributo indica che la versione del metodo o dell'API richiamata è diventata obsoleta ed è ufficialmente obsoleta. Sebbene continui a funzionare in questo momento, potrebbe cessare di funzionare in breve tempo. In genere, questo attributo non è presente. | falso |
Contenuto dell'elemento | |||
Un singolo elemento di messaggi facoltativo ed esattamente un elemento di output obbligatorio. | |||
elemento di output | |
Nome tag | output |
Attributi dell'elemento | |
(nessuno) | |
Contenuto dell'elemento | |
Un singolo elemento di conti. Questo wrapper di output è standard in tutte le risposte API e racchiude l'output valido di qualsiasi chiamata API riuscita. | |
elemento users | |||
Nome tag | utenti | ||
Descrizione | Contenitore per uno o più elementi utente. | ||
Attributi dell'elemento | |||
Nome attributo | Obbligatorio? | Valore | Esempio |
seqNo Aggiunto nell'API v17 ma riservato per un utilizzo futuro. | |||
Contenuto dell'elemento | |||
Uno o più elementi utente. | |||
elemento utente | |||
Nome tag | utente | ||
Descrizione | Rappresenta un singolo utente restituito nella risposta a una chiamata API exportUsers. | ||
Attributi dell'elemento | |||
Nome attributo | Obbligatorio? | Valore | Esempio |
ID | S | Il numero ID di sistema interno per l'utente. | 19 |
guid | S | Identificatore univoco globale per l'utente. Questo identificativo non cambierà mai per questo utente, anche se il nome o l'accesso verranno modificati in futuro. | B9ADBCB81AA2F9BAE040307F02092C2E |
accedere | S | L'account di accesso per questo utente. | analytica@fakecompany.com |
email | S | L'indirizzo e-mail dell'utente. Può essere vuoto se l'utente non ha configurato un indirizzo e-mail valido. | analytica@fakecompany.com |
nome | S | Il nome dell'utente. | Anna Analyzer |
posizione
Disponibile nell'API v39+ | N | Posizione per l'utente | "CEO" |
permissionSetId Disponibile nell'API v25+ Non disponibile nell'API v36+ | S | L'ID di sistema interno del set di autorizzazioni assegnato all'utente. Consultare anche exportPermissionSets. | |
permissionSetIds
Disponibile nell'API v36+ | S | Gli ID di sistema interni degli insiemi di autorizzazioni assegnati a questo utente. Consultare anche exportPermissionSets. | |
roleId Disponibile in API v25 e versioni precedenti Non disponibile nell'API v25+ | S | L'ID sistema interno del ruolo assegnato a questo utente. Consultare anche exportRoles. | 3 |
possedutoLevels Non disponibile nell'API v18 | S | Questo attributo è incluso solo se l'utente incluso nelle credenziali della richiesta dispone dell'autorizzazione di Amministratore di livello per l'intera struttura ad albero dell'organizzazione e la richiesta ha indicato di includere i livelli di proprietà. Se incluso, il valore di questo attributo è un elenco separato da virgole di ID di sistema interni per i livelli organizzazione a cui l'utente ha avuto accesso diretto. L'utente avrà anche accesso a tutti i livelli figlio dei livelli elencati qui | 5,10,13 |
hiddenVersions Non disponibile nell'API v18 | N (vedi descrizione) | Questo attributo è incluso solo se l'utente incluso nelle credenziali della richiesta dispone dell'autorizzazione di Amministratore versione e la richiesta ha indicato che le versioni nascoste devono essere incluse. Se incluso, il valore di questo attributo è un elenco separato da virgole di ID di sistema interni per le versioni o le cartelle di versioni nascoste all'utente (ma il cui padre è inesistente o non nascosto). L'utente non sarà inoltre in grado di visualizzare le versioni figlio delle versioni elencate qui. | 121 |
alternateEmail
Disponibile nell'API v39+ | N | L'indirizzo e-mail alternativo dell'utente. | "abc@greenco.com" |
samlFedId
Disponibile nell'API v39+ | N | L'ID SAMLFederation per questo utente. | "1234" |
timeZone | S | Il fuso orario dell'utente. | USA/Pacifico |
home page
Disponibile nell'API v39+ | N | Home page per l'utente | "Benvenuto" |
paese
Disponibile nell'API v39+ | N | Prefisso internazionale per utente (codice alfa-2). | "US" |
usState
Disponibile nell'API v39+ | N | Codice stato per utente (il paese deve essere USA). | "CA" |
prospettiva
Disponibile nell'API v39+ | N | ID prospettiva per l'utente | "111" |
prospectName
Disponibile nell'API v39+ | N | Nome prospettiva della prospettiva dell'utente. | "Prospettiva di prova" |
dashboard
Disponibile nell'API v39+ | N | ID dashboard per utente: è necessario che l'ID prospettiva imposti l'ID dashboard, se l'ID prospettiva è specificato e l'ID dashboard non lo è, l'ID dashboard è impostato su null. | "222" |
dashboardName
Disponibile nell'API v39+ | N | Nome del dashboard dell'utente. | "Test dashboard" |
netsuiteLogin
Disponibile nell'API v39+ | N | Accesso a Netsuite. | "abc@netsuite.com" |
salesforceLogin
Disponibile nell'API v39+ | N | Accesso a Salesforce | "abc@salesforce.com" |
createDate
Disponibile nell'API v39+ | N | Data e ora in cui è stato creato l'utente. | "15/08/2023 08:02:16.0" |
lastLogin
Disponibile nell'API v39+ | N | Data e ora dell'ultimo accesso dell'utente. | "13/11/2023 22:22:39,0" |
FailureAttempts
Disponibile nell'API v39+ | N | Numero di tentativi di accesso non riusciti per questo utente (consecutivi). | "0" |
bloccato
Disponibile nell'API v39+ | N | Se l'utente è bloccato/non può accedere (a causa di troppi accessi non riusciti). | "falso" |
Contenuto dell'elemento | |||
Un elemento di iscrizioni. | |||
elemento iscrizioni | |||
Nome tag | abbonamenti | ||
Descrizione | Rappresenta le impostazioni di sottoscrizione e-mail per un utente. | ||
Attributi dell'elemento | |||
Nome attributo | Obbligatorio? | Valore | Esempio |
nosubscriptions | S | L'impostazione per segnalare che l'utente ha disattivato tutte le sottoscrizioni. 1 significa che l'utente ha disattivato tutte le sottoscrizioni. | 0 |
systemAlertsAndUpdates | S | Impostazione per gli avvisi di sistema e l'abbonamento agli aggiornamenti scelto dall'utente. 1 significa che l'utente ha abilitato e 0 significa che ha disabilitato. | 1 |
customerNewsLetter | S | Impostazione per l'abbonamento alla newsletter del cliente scelto dall'utente. 1 significa che l'utente ha abilitato e 0 significa che ha disabilitato. | 1 |
localEvents | S | Impostazione per l'abbonamento a eventi locali scelto dall'utente. 1 significa che l'utente ha abilitato e 0 significa che ha disabilitato. | 1 |
educationTraining | S | Impostazione per l'abbonamento a eventi di istruzione e formazione scelto dall'utente. 1 significa che l'utente ha abilitato e 0 significa che ha disabilitato. | 1 |
customerWebinars | S | Impostazione per l'iscrizione agli eventi webinar del cliente scelta dall'utente. 1 significa che l'utente ha abilitato e 0 significa che ha disabilitato. | 1 |
newProductsAndEnhancements | S | Impostazione per la notifica di nuovi prodotti e miglioramenti scelta dall'utente. 1 significa che l'utente ha abilitato e 0 significa che ha disabilitato. | 1 |
partnerNewsLetter | S | Impostazione per l'abbonamento alla newsletter del partner scelto dall'utente. 1 significa che l'utente ha abilitato e 0 significa che ha disabilitato. | 1 |
partnerWebinars | S | Impostazione per l'abbonamento a eventi webinar partner scelto dall'utente. 1 significa che l'utente ha abilitato e 0 significa che ha disabilitato. | 1 |
userGroups | S | Impostazione per la notifica degli eventi dei gruppi di utenti scelta dall'utente. 1 significa che l'utente ha abilitato e 0 significa che ha disabilitato. | 1 |
sondaggi | S | Impostazione per la ricezione dei sondaggi scelta dall'utente. 1 significa che l'utente ha abilitato e 0 significa che ha disabilitato. | 0 |
Contenuto dell'elemento | |||
nessuno | |||