• Last edited on: 25 March 2021

Benutzer-API

Verwenden Sie die Benutzer-API, um die Benutzerdaten zu erstellen, zu aktualisieren oder abzufragen.

Verwenden Sie die Benutzer-APIs, um die Benutzerdaten zu erstellen, zu aktualisieren oder abzufragen. 

Die URL für den Zugriff auf die APIs lautet: https://<instance>.cso.coupahost.com/api/users

Weitere Informationen finden Sie unter Best Practices für die Integration.

Aktionen

Verb Pfad Aktion Beschreibung
GET /api/users Index Führt eine Aktion zum Abrufen aller Benutzer aus
POST /api/users erstellen Erstellt einen oder mehrere Benutzer.
PUT /api/users aktualisieren Aktualisiert einen oder mehrere Benutzer. Kann Massenaktualisierungen durchführen.
GET /api/users/:id zeigen Zeigt die Benutzerdaten an. 
PUT /api/users/:id aktualisieren Aktualisieren Sie jeweils einen Benutzer mithilfe der ID

Elemente

Dies sind die für die Benutzer-API verfügbaren Elemente

Feldname Feldbeschreibung Erford. Eindeutig? Zulässige Werte In Ausgang * Typ
ID

ID des Benutzers

  Ja     Ja Ganzzahl
Staat Status des Benutzers    

Blockiert, Aktiv, Deaktiviert, Entfernt (Groß-/Kleinschreibung beachten)

Ja Ja Zeichenfolge
Name Der Anmeldename des Benutzers. Einmal festgelegt kann nicht geändert werden.   Ja     Ja Zeichenfolge
Vorname Der Vorname des Benutzers       Ja    
Nachname Der Nachname des Benutzers       Ja    
Telefonnummer Telefonnummer des Benutzers       Ja Ja Zeichenfolge
Mobilnummer Die Mobilnummer des Benutzers       Ja    
E-Mail E-Mail des Benutzers. Einmal festgelegt, kann es nicht mehr geändert werden.         Ja Zeichenfolge
Unternehmens-ID Die Unternehmens-ID für den Benutzer. Einmal festgelegt, kann er nicht mehr geändert werden            
Straße Straßenteil der Benutzeradresse       Ja Ja Zeichenfolge
Postleitzahl Postleitzahlenteil der Benutzeradresse       Ja Ja Zeichenfolge
Ort Stadt Teil der Benutzeradresse       Ja Ja Zeichenfolge
Land Länderteil der Benutzeradresse       Ja Ja Zeichenfolge
Schlüsselwörter Dem Benutzer zugeordnete Schlüsselwörter       Ja Ja Zeichenfolge
Externer Benutzername Der dem Benutzer zugewiesene externe Benutzername.         Ja  
Akzeptiert-Vereinbarung Gibt an, ob der Benutzer erforderliche Vereinbarungen akzeptiert hat.       Ja Ja  
Informationen bereitstellen Gibt an, ob der Benutzer bei der nächsten Anmeldung Benutzerinformationen bereitstellen soll.       Ja Ja  
Passwort ändern Gibt an, ob der Benutzer sein Kennwort bei der nächsten Anmeldung ändern soll.       Ja    
Hinweis

 Antwort-Payload zeigt keine Nullwerte an.

Beispiele

In diesem Beispiel haben wir eine Benutzer-API abgefragt. Wir haben eine GET-to-URL durchgeführt: 

https://<instance>.cso.coupahost.com/api/users 

GET-Antwort des Benutzers

{
		"total": 3,
		"users": [
				{
						"id": "9219595862193003588",
						"state": "Active",
						"name": "dekke434",
						"first-name": "Arjan",
						"last-name": "Goud",
						"phone-number": "+310987898789",
						"mobile-number": "+31(0) 6 98876554",
						"email": "a.goud@deeder.com",
						"company-id": "9219592232917474305",
						"street": "IJsseldijk west 66",
						"zip-code": "2935AR",
						"city": "Ouderkerk aan den IJssel",
						"country": "Netherlands",
						"accepts-agreement": false,
						"provide-information": false,
						"change-password": false
				},
				{
						"id": "9219595145795283441",
						"state": "Active",
						"name": "deeed",
						"first-name": "Arjan",
						"last-name": "Deeed",
						"phone-number": "+313132323133",
						"email": "mh@test.nl",
						"company-id": "9219592331212583950",
						"country": "Netherlands",
						"accepts-agreement": false,
						"provide-information": true,
						"change-password": true
				},
				{
						"id": "9219592232917474526",
						"state": "Active",
						"name": "eurot494",
						"first-name": "Marjus",
						"last-name": "van Dee",
						"phone-number": "+31121212121",
						"mobile-number": "+31313131333",
						"email": "test@test.com",
						"company-id": "9219592232917474528",
						"street": "Brielselaan 69, Haven 1357",
						"zip-code": "3081AA",
						"city": "Rotterdam",
						"country": "Netherlands",
						"accepts-agreement": false,
						"provide-information": true,
						"change-password": false
				}
	 ]
}

Erstellen/Aktualisieren

Im Folgenden wird beschrieben, wie Sie die Coupa-API verwenden können, um Aktionen für Benutzer durchzuführen.

Erstellen

/api/users

Die folgende Payload erstellt zwei Benutzer.

Payload: 
{
		"users": [
				{
						"state": "Active",
						"name": "tester123456",
						"first-name": "tester",
						"last-name": "user1",
						"phone-number": "+1(111)-234-5678",
						"mobile-number": "+1(11)-123-3456",
						"email": "testeruser@tester.com",
						"company-id": "9220538753250662192",
						"street": "12345 bethoven road",
						"zip-code": "30811",
						"city": "Rotterdam",
						"country": "United States",
						"accepts-agreement": false,
						"provide-information": true,
						"change-password": false
				},
				 {
						"name": "tester12345",
						"first-name": "testing",
						"last-name": "user",
						"phone-number": "+1(111)-234-5678",
						"mobile-number": "+1(11)-123-3456",
						"email": "tester@tester.com",
						"company-id": "9220538753250662192",
						"street": "12345 bethoven road",
						"zip-code": "30811",
						"city": "Rotterdam",
						"country": "United States",
						"accepts-agreement": true,
						"provide-information": true,
						"change-password": false
				}
		]
}
Response: 201
{
		"result": [
				{
						"type": "api.post.added",
						"description": "2 objects created."
				}
		],
		"added": 2,
		"users": [
				{
						"id": "9220538753483272432"
				},
				{
						"id": "9220538753482068122"
				}
		]
}	 

update

/api/users

Die folgende Payload aktualisiert einen oder mehrere Benutzer. 

To update one or more User at a time: 
Payload:
{
		"users": [
				{
						"id": "9220538753483272432",
						"state": "Blocked",
						"email": "testeruser-upd@tester.com",
						"accepts-agreement": true,
						"provide-information": true,
						"change-password": false
				},
				{
						"id": "9220538753482068122",
						"state": "Blocked",
						"email": "tester-upd@tester.com",
						"accepts-agreement": false,
						"provide-information": true,
						"change-password": false
				}
		]
}

Response: 200 OK
{
		"result": [
				{
						"type": "api.put.updated",
						"description": "2 objects updated."
				}
		],
		"updated": 2
}
Hinweis

 Aktualisierungen erfolgen nachsichtig, d. h. wenn die Aktualisierung einer Ressource fehlschlägt, können die anderen erfolgreich sein. Benutzer-ID ist für Aktualisierungen erforderlich.

Erfolgreiche Anfragen werden zurückgegeben HTTP 200 Response. Der Text der Antwort enthält die erstellte Anforderung. Fehlgeschlagene Anfragen werden zurückgegeben HTTP 400 Bad Request. Der Text der Antwort enthält Validierungsfehler, die als XML formatiert sind.

Parts or all of this page might have been machine-translated. We apologize for any inaccuracies.

  • Table Of Contents