Benutzer erstellen #

Erstellt einen neuen Benutzer, der einem Kunden-Tenant zugewiesen ist.

POST /v1.0/customers/{CUSTOMER_TENANT_ID}/users

Bemerkungen #

Immer wenn ein neuer Benutzer erstellt wird, erhält er die Rolle "customer.user", die es ihm erlaubt, sich bei der Kundenportal. Dies sendet auch eine Aktivierungs-E-Mail an die angegebene Adresse, sobald der Nutzer wird erschaffen.

Beispiel #

Diese Anfrage erstellt einen neuen Benutzer mit folgenden Details:

Kunde: Im Kunden-Tenant mit der ID {CUSTOMER_TENANT_ID}
E-Mail: [email protected]
Anzeigename: "Neuer Benutzer",
Rollen:
- Benutzeradministrator (admin.user)
- Website-Nutzer (customer.user)
- Reporter-Supervisor-Ebene (customer.user.supervisorl1)
- Kundeneinstellungen (customer.settings)

Anfrage #

POST <https://api.uk.myreports.cloud/api/v1.0/customers/{CUSTOMER_TENANT_ID}/users> HTTP/1.1
Inhaltstyp: application/json
Akzeptanz-Gebühren: Wahr
Autorisierung: Inhaber {TOKEN}
Verbindung: am Leben bleiben
{
	"E-Mail": "[[email protected]](mailto:[email protected])",
	"displayName": "Neuer Benutzer",
	"Rollen": ["admin.user", "customer.user", "customer.user.supervisorl1", "customer.settings"]["admin.user", "customer.user", "customer.user.supervisorl1", "customer.settings"]
}

Reaktion #

HTTP/1.1 201 erstellt
Inhaltstyp: application/json; charset=utf-8
Inhalt-Länge: xx
Standort: <https://api.uk.myreports.cloud/api/v1.0/customers/{CUSTOMER_TENANT_ID}/users/{USER_ID}>
{
	"data": {
		"id": "{USER_ID}",
		"displayName": "Neuer Benutzer",
		"E-Mail": "[[email protected]](mailto:[email protected])",
		"primärMieter": "{CUSTOMER_TENANT_ID}",
		"Rollen": ["admin.user", "customer.user", "customer.user.supervisorl1", "customer.settings"]["admin.user", "customer.user", "customer.user.supervisorl1", "customer.settings"]
	},
	"Status": "Erfolg",
	"Zeitstempel": "2019-11-29T16:03:23.9251680Z"
}

Fehler #

Unautorisiert #

Wenn der Token nicht bereitgestellt wird, ungültig oder abgelaufen ist

HTTP/1.1 401 Unautorisiert

Schlechte Anfrage #

Wenn die angegebene Mieter-ID nicht im richtigen Format ist

HTTP/1.1 400 Bad Request
Datum: Do, 06. Feb 2020 12:45:27 GMT
Inhaltstyp: application/json; charset=utf-8
Inhalt-Länge: 149
{
	"Fehler": 400,
	"Nachricht": "Der Wert '<tenant id>'ist nicht gültig.",
	"status": "fehler",
	"Zeitstempel": "2020-02-06T12:45:27.5903465Z"
}

Wenn die Anzahl der Benutzerlizenzen überschritten wurde

HTTP/1.1 400 Bad Request
Datum: Do, 06. Feb 2020 12:45:27 GMT
Inhaltstyp: application/json; charset=utf-8
Inhalt-Länge: 149
{
	"Fehler": 400,
	"message": "Nicht genügend Benutzerlizenzen verfügbar.",
	"status": "fehler",
	"Zeitstempel": "2020-02-06T12:45:27.5903465Z"
}

Nicht gefunden #

Wenn es keine Kunden gibt, die eine passende Mieter-ID haben

HTTP/1.1 404 Nicht gefunden
Datum: Do, 06. Feb 2020 12:46:58 GMT
Inhaltstyp: application/json; charset=utf-8
Inhalt-Länge: 95
{
	"error": 404,
	"Nachricht": "Nicht gefunden",
	"status": "fehler",
	"Zeitstempel": "2020-02-06T12:46:58.7669535Z"
}

Zahlung erforderlich #

Wenn dieser Antrag zusätzliche Kosten verursachen könnte, siehe Charges.

HTTP/1.1 402 Zahlung erforderlich
Datum: Do, 06. Feb 2020 13:01:00 GMT
Inhaltstyp: application/json; charset=utf-8
Inhalt-Länge: 274
{
	"data": {
		"id": "{USER_ID}",
		"displayName": "Neuer Benutzer",
		"E-Mail": "[[email protected]](mailto:[email protected])",
		"primärMieter": "{CUSTOMER_TENANT_ID}",
		"Rollen": ["admin.user", "customer.user", "customer.user.supervisorl1", "customer.settings"]["admin.user", "customer.user", "customer.user.supervisorl1", "customer.settings"]
	},
	"Fehler": 402,
	"Nachricht": "Zusätzliche Kosten fallen an",
	"status": "fehler",
	"Zeitstempel": "2020-02-06T13:01:01.1302340Z"
}

Konflikt #

Wenn die E-Mail-Adresse dieses neuen Nutzers bereits für einen anderen Nutzer in diesem Kunden-Tenant ausgeht.

HTTP/1.1 409-Konflikt
Datum: Do, 06. Feb 2020 13:05:39 GMT
Inhaltstyp: application/json; charset=utf-8
Inhalt-Länge: 178
{
	"error": 409,
	"errorCode": "EmailConflict",
	"message": "Ein Benutzer mit der E-Mail-Adresse [[email protected]](mailto:[email protected]) existiert bereits.",
	"status": "fehler",
	"Zeitstempel": "2020-02-06T13:05:39.5486342Z"
}