exportUsers
Kategorie
| Abrufen von Metadaten |
Beschreibung
| Gibt Metadaten für die vollständige Liste aller Benutzer in der Instanz zurück. |
Zum Aufrufen sind Berechtigungen erforderlich
| Benutzeradministrator |
Auf Anforderung erforderliche Parameter
| Zugangsdaten |
Die Anforderung dieser Methode enthält nur ein Credentials-Tag zur Identifizierung und Autorisierung des aufrufenden Benutzers. Nach der Verifizierung gibt die Methode ein XML-Dokument zurück, das alle in der Instanz definierten Benutzer beschreibt.
Anforderungsformat
<?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>
Element „Zugangsdaten“.
| |||
Tag-Name
| -Zugangsdaten | ||
Beschreibung
| Alle API-Aufrufe müssen ein einzelnes Element mit den Zugangsdaten enthalten, um den Benutzer zu identifizieren, der die API aufruft. Der API-Aufruf wird dann als dieser Benutzer ausgeführt (jeder Audit-Trail oder jede Aktionshistorie im System zeigt, dass dieser Benutzer die Aktion ausgeführt hat). Daher muss der Benutzer über die erforderlichen Berechtigungen zum Ausführen der Aktion verfügen, damit der API-Aufruf ausgeführt werden kann erfolgreich ist. | ||
Attribute des Elements
| |||
Name des Attributs
| erforderlich?
| Wert
| Beispiel
|
anmelden | J | Der Anmeldename des Benutzers, der die API-Methode aufruft. Dieser Benutzer muss über die erforderlichen Berechtigungen zum Aufrufen der Methode verfügen. | sampleuser@company.com |
Kennwort | J | Das Kennwort des Benutzers, der die API-Methode aufruft. | my_password |
Gebietsschema | N | Geben Sie das Gebietsschema an, das verwendet werden soll, um eingehende Zahlen und Datumsangaben zu interpretieren und ausgehende Zahlen und Datumsangaben zu formatieren (mit dem entsprechenden Tausendertrennzeichen, den Monatsnamen und der Datumsformatierung). Das Gebietsschema wird auch verwendet, um die Sprache anzugeben, in der Systemmeldungen in der Antwort angezeigt werden sollen. Wenn nicht angegeben, wird en_US (amerikanisches Englisch) verwendet. | fr_FR |
instanceCode | N | Wenn der in den Zugangsdaten angegebene Benutzer Zugriff auf mehr als eine Instanz von hat, Adaptive Planning : Dieses Attribut kann verwendet werden, um anzugeben, dass der Benutzer auf eine andere Instanz als seine Standardinstanz zugreifen möchte. Wenn nicht angegeben, wird die Standardinstanz des Benutzers verwendet. Verwenden Sie die exportInstances-API, um die verfügbaren Instanzcodes zu ermitteln. | MYINSTANCE1 |
Inhalt des Elements
| |||
(Keine) | |||
Element einschließen Verfügbar in API v17 und früher. Nicht verfügbar in API v18 und höher. | |||
Tag-Name
| einschließen | ||
Beschreibung
| Stellt eine Reihe von Kennzeichen dar, die angeben, welche Aspekte der Benutzerinformationen in die Antwort aufgenommen oder daraus ausgeschlossen werden sollen. Dieses Element ist optional: Wenn es nicht vorhanden ist, sind die Standardwerte „true“ für ownerLevels und „false“ für ausgeblendete Versionen. | ||
Attribute des Elements
| |||
Name des Attributs
| erforderlich?
| Wert
| Beispiel
|
Gruppe(n) Verfügbar in API v23 und höher. | N | Entweder das Wort „true“ oder „false“. Gibt an, ob die Benutzerelemente in der Antwort ein Attribut groupIds enthalten. Bei wahr enthalten die groupIds in der Antwort eine durch Kommas getrennte Liste aller Gruppen, in denen der Benutzer ist. Wenn das Attribut nicht vorhanden ist oder sein Wert nicht „true“ oder „false“ ist, wird der Standardwert „false“ verwendet. | wahr |
ownedLevels Verfügbar in API v17 und früher. Nicht verfügbar in API v18 und höher. | N | Entweder das Wort „true“ oder „false“. Gibt an, ob die Benutzerelemente in der Antwort ownerLevels-Attribute enthalten sollen oder nicht. Wenn das Attribut nicht vorhanden ist oder sein Wert nicht „true“ oder „false“ ist, wird der Standardwert „true“ verwendet. | wahr |
hiddenVersions Verfügbar in API v17 und früher. Nicht verfügbar in API v18 und höher. | N | Entweder das Wort „true“ oder „false“. Gibt an, ob die Benutzerelemente in der Antwort ausgeblendeteVersionen enthalten sollen oder nicht. Wenn das Attribut nicht vorhanden ist oder sein Wert nicht „true“ oder „false“ ist, wird der Standardwert „false“ verwendet. | false |
Inhalt des Elements
| |||
(Keine) | |||
Antwortformat
<?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>
Antwortelement
| |||
Tag-Name
| -Antwort | ||
Attribute des Elements
| |||
Name des Attributs
| erforderlich?
| Wert
| Beispiel
|
Erfolg haben | J | Entweder wahr oder falsch, was angibt, ob der API-Aufruf erfolgreich war oder nicht. Selbst erfolgreiche Aufrufe können in ihrer Antwort Warnmeldungen enthalten. | wahr |
veraltet | N | Wenn dieses Attribut im Antwort-Tag vorhanden ist und auf „true“ gesetzt ist, zeigt es an, dass die Version der Methode oder API, die aufgerufen wird, veraltet und offiziell veraltet ist. Auch wenn es zu diesem Zeitpunkt noch funktioniert, kann es sein, dass Sie in Kürze nicht mehr funktionieren. In der Regel ist dieses Attribut nicht vorhanden. | false |
Inhalt des Elements
| |||
Ein einzelnes optionales Nachrichtenelement und genau ein erforderliches Ausgabeelement. | |||
Ausgabeelement
| |
Tag-Name
| Ausgabe |
Attribute des Elements
| |
(Keine) | |
Inhalt des Elements
| |
Ein einzelnes Kontenelement Dieser Ausgabe-Wraper ist ein Standard für alle API-Antworten und schließt die gültige Ausgabe jedes erfolgreichen API-Aufrufs ein. | |
Element „Benutzer“.
| |||
Tag-Name
| Benutzer(n) | ||
Beschreibung
| Container für ein oder mehrere Benutzerelemente. | ||
Attribute des Elements
| |||
Name des Attributs
| erforderlich?
| Wert
| Beispiel
|
Sequenznr Hinzugefügt in API v17, aber für zukünftige Verwendung reserviert. | |||
Inhalt des Elements
| |||
Ein oder mehrere Benutzerelemente. | |||
-Benutzerelement
| |||
Tag-Name
| Benutzer | ||
Beschreibung
| Stellt einen einzelnen Benutzer dar, der in der Antwort auf einen exportUsers-API-Aufruf zurückgegeben wird. | ||
Attribute des Elements
| |||
Name des Attributs
| erforderlich?
| Wert
| Beispiel
|
id | J | Die interne System-ID des Benutzers. | 19 |
GUID | J | Eine global eindeutige Kennung für den Benutzer. Diese Kennung wird sich für diesen Benutzer nie ändern, auch wenn sich seine Anmeldung oder sein Name in Zukunft ändern. | B9ADBCB81AA2F9BAE040307F02092C2E |
anmelden | J | Die Anmeldung für diesen Benutzer. | analytica@fakecompany.com |
E-Mail | J | Die E-Mail-Adresse für diesen Benutzer. Kann leer sein, wenn der Benutzer keine gültige E-Mail-Adresse konfiguriert hat. | analytica@fakecompany.com |
Name | J | Der Name dieses Benutzers. | Anna Analyzer |
Stelle
Verfügbar in API v39 und höher | N | Stelle für Benutzer. | "CEO" |
permissionSetId Verfügbar in API v25 und höher Nicht verfügbar in API v36 und höher | J | Die interne System-ID des Berechtigungssatzes, der diesem Benutzer zugewiesen ist. Siehe auch exportPermissionSets. | |
permissionSetIds
Verfügbar in API v36 und höher | J | Die internen System-IDs der diesem Benutzer zugewiesenen Berechtigungssätze. Siehe auch exportPermissionSets. | |
roleId Verfügbar in API v25 und älter Nicht verfügbar in API v25 und höher | J | Die interne System-ID der Rolle, die diesem Benutzer zugewiesen ist. Siehe auch exportRoles. | 3 |
ownedLevels Nicht verfügbar in API v18 | J | Dieses Attribut ist nur enthalten, wenn der in den Zugangsdaten der Anforderung enthaltene Benutzer über die Berechtigung „Level Administrator“ für den gesamten Organisationsbaum verfügt und die Anforderung angegeben hat, dass Ebenen mit Eigentümer eingeschlossen werden sollen. Falls vorhanden, ist der Wert dieses Attributs eine durch Kommas getrennte Liste interner System-IDs für Organisationsebenen, auf die diesem Benutzer direkter Zugriff gewährt wurde. Der Benutzer hat auch Zugriff auf alle untergeordneten Ebenen der hier aufgeführten Ebenen | 5,10,13 |
hiddenVersions Nicht verfügbar in API v18 | N (siehe Beschreibung) | Dieses Attribut ist nur enthalten, wenn der in den Zugangsdaten der Anforderung enthaltene Benutzer über die Berechtigung „Versionsadministrator“ verfügt und die Anforderung angegeben hat, dass ausgeblendete Versionen eingeschlossen werden sollen. Falls vorhanden, ist der Wert dieses Attributs eine durch Kommas getrennte Liste interner System-IDs für Versionen oder Versionsordner, die für diesen Benutzer ausgeblendet sind (deren übergeordnetes Element jedoch entweder nicht vorhanden oder nicht ausgeblendet ist). Der Benutzer wird auch keine untergeordneten Versionen der hier aufgeführten Versionen sehen können. | 121 |
alternateEmail
Verfügbar in API v39 und höher | N | Die alternative E-Mail-Adresse für diesen Benutzer. | "abc@greenco.com" |
samlFedId
Verfügbar in API v39 und höher | N | Die SAMLFederation-ID für diesen Benutzer. | "1234" |
timeZone | J | Die Zeitzone des Benutzers. | USA/pazifik |
Homepage
Verfügbar in API v39 und höher | N | Homepage für Benutzer. | "Willkommen" |
Land
Verfügbar in API v39 und höher | N | Ländercode für Benutzer (Alpha-2-Code). | "US" |
usState
Verfügbar in API v39 und höher | N | Code des Bundesstaates für Benutzer (Land muss USA sein). | "CA" |
Perspektive
Verfügbar in API v39 und höher | N | Perspektiven-ID des Benutzers. | "111" |
perspectiveName
Verfügbar in API v39 und höher | N | Perspektivenname der Perspektive des Benutzers. | "Perspektive testen" |
Dashboard
Verfügbar in API v39 und höher | N | Dashboard-ID für Benutzer – Erfordert eine Perspektiven-ID zum Festlegen der Dashboard-ID. Wenn eine Perspektiven-ID angegeben ist und eine Dashboard-ID nicht, wird die Dashboard-ID auf „0“ gesetzt. | "222" |
dashboardName
Verfügbar in API v39 und höher | N | Dashboard-Name des Dashboards des Benutzers. | "Dashboard testen" |
netsuiteLogin
Verfügbar in API v39 und höher | N | NetSuite-Anmeldung. | "abc@netsuite.com" |
salesforceLogin
Verfügbar in API v39 und höher | N | Salesforce-Anmeldung. | "abc@salesforce.com" |
Erstellungsdatum
Verfügbar in API v39 und höher | N | Der Datum/Zeit-Zeitstempel, an dem der Benutzer erstellt wurde. | "2023-08-15 08:02:16.0" |
lastLogin
Verfügbar in API v39 und höher | N | DateTime-Zeitstempel für die letzte Anmeldung des Benutzers. | "2023-11-13 22:22:39.0" |
Fehlgeschlagene Versuche
Verfügbar in API v39 und höher | N | Anzahl fehlgeschlagener Anmeldeversuche für diesen Benutzer (aufeinanderfolgende). | "0" |
gesperrt
Verfügbar in API v39 und höher | N | Ob der Benutzer gesperrt ist oder nicht angemeldet werden kann (aufgrund zu vieler fehlgeschlagener Anmeldungen). | "false" |
Inhalt des Elements
| |||
Ein Abonnementelement. | |||
Element „Abonnements“.
| |||
Tag-Name
| Abonnements | ||
Beschreibung
| Stellt die E-Mail-Abonnementeinstellungen für einen Benutzer dar. | ||
Attribute des Elements
| |||
Name des Attributs
| erforderlich?
| Wert
| Beispiel
|
No-Abonnements | J | Einstellung, die meldet, dass der Benutzer ein Opt-out für alle Abonnements gesetzt hat. „1“ bedeutet, dass der Benutzer ein Opt-out für alle Abonnements gesetzt hat. | 0 |
systemAlertsAndUpdates | J | Einstellung für das Abonnement von System-Alerts und -Updates, für die der Benutzer ein Opt-in gesetzt hat. 1 bedeutet, dass der Benutzer ein Opt-in gesetzt hat, und 0 bedeutet, dass er ein Opt-out gesetzt hat. | 1 |
customerNewsLetter | J | Einstellung für das Abonnement von Kunden-Newslettern, für das der Benutzer ein Opt-in gesetzt hat. 1 bedeutet, dass der Benutzer ein Opt-in gesetzt hat, und 0 bedeutet, dass er ein Opt-out gesetzt hat. | 1 |
localEvents | J | Einstellung für das Abonnement lokaler Ereignisse, für das der Benutzer ein Opt-in gesetzt hat. 1 bedeutet, dass der Benutzer ein Opt-in gesetzt hat, und 0 bedeutet, dass er ein Opt-out gesetzt hat. | 1 |
AusbildungTraining | J | Einstellung für das Abonnement von Ausbildungs- und Trainingsereignissen, für das der Benutzer ein Opt-in gesetzt hat. 1 bedeutet, dass der Benutzer ein Opt-in gesetzt hat, und 0 bedeutet, dass er ein Opt-out gesetzt hat. | 1 |
customerWebinars | J | Einstellung für das Abonnement von Kunden-Webinar-Ereignissen, für das der Benutzer ein Opt-in gesetzt hat. 1 bedeutet, dass der Benutzer ein Opt-in gesetzt hat, und 0 bedeutet, dass er ein Opt-out gesetzt hat. | 1 |
newProductsAndEnhancements | J | Einstellung für Benachrichtigungen zu neuen Produkten und Erweiterungen, die vom Benutzer aktiviert wurden. 1 bedeutet, dass der Benutzer ein Opt-in gesetzt hat, und 0 bedeutet, dass er ein Opt-out gesetzt hat. | 1 |
partnerNewsLetter | J | Einstellung für das Abonnement von Partner-Newslettern, für das der Benutzer ein Opt-in gesetzt hat. 1 bedeutet, dass der Benutzer ein Opt-in gesetzt hat, und 0 bedeutet, dass er ein Opt-out gesetzt hat. | 1 |
partnerWebinars | J | Einstellung für das Abonnement von Partner-Webinar-Ereignissen, für das der Benutzer ein Opt-in gesetzt hat. 1 bedeutet, dass der Benutzer ein Opt-in gesetzt hat, und 0 bedeutet, dass er ein Opt-out gesetzt hat. | 1 |
userGroups | J | Einstellung für die Benachrichtigung zu Benutzergruppenereignissen, für die der Benutzer ein Opt-in gesetzt hat. 1 bedeutet, dass der Benutzer ein Opt-in gesetzt hat, und 0 bedeutet, dass er ein Opt-out gesetzt hat. | 1 |
Befragungen | J | Einstellung für den Erhalt von Befragungen, für die der Benutzer ein Opt-in gesetzt hat. 1 bedeutet, dass der Benutzer ein Opt-in gesetzt hat, und 0 bedeutet, dass er ein Opt-out gesetzt hat. | 0 |
Inhalt des Elements
| |||
Keine | |||