Comparaison des versions

Légende

  • Ces lignes ont été ajoutées. Ce mot a été ajouté.
  • Ces lignes ont été supprimées. Ce mot a été supprimé.
  • La mise en forme a été modifiée.
Sv translation
languagefr
Remarque

Cette page n'est plus actualisée. À partir de BlueMind 4.8, veuillez consulter la nouvelle documentation BlueMind

Présentation

Vous trouverez sur cette page des exemples d'utilisation et de mise en pratique de l'API utilisateur

Volet

Sur cette page :

Sommaire
maxLevel2

Création d'un utilisateur

La création d'un utilisateur couvre toutes les actions nécessaire pour créer un utilisateur opérationnel :

  • Création au niveau de la base de données
  • Association de l'utilisateur avec un domaine
  • Création de la boîte au lettre 
  • Création du calendrier par défaut
  • Création d'une vue de calendrier par défaut
  • Création des carnets d'adresses "Mes contacts" et "Contacts collectés"

https://forge.bluemind.net/staging/doc/openui-models/web-resources/?bm_version=4.1.42252#!/net.bluemind.user.api.IUser/put_users_domainUid_uid

Exemple en HTTP

MéthodeURL
PUThttps://<domain>/api/users/<domain>/<uid>

domain = le domaine

uid = identifiant unique de l'utilisateur

Body
Bloc de code
{
	"emails": [{
		"address": "john@<domain>",
		"allAliases": false,
		"isDefault": true
	}],
	"login": "john",
	"password": "doe",
	"contactInfos": {
		"identification": {
			"name": {
				"familyNames": "Doe",
				"givenNames": "John"
			},
			"photo": false
		}
	},
	"routing": "internal",
	"accountType": "FULL"
}

Exemple en Curl

Bloc de code
curl -X GET --header 'Content-Type: application/json' 
--header 'X-BM-ApiKey: <auth_key>' 
--header 'Accept: application/json' 
--header 'X-BM-ApiKey: <auth_key>' 
-d '{
	"emails": [{
		"address": "john@<domain>",
		"allAliases": false,
		"isDefault": true
	}],
	"login": "john",
	"password": "doe",
	"contactInfos": {
		"identification": {
			"name": {
				"familyNames": "Doe",
				"givenNames": "John"
			},
			"photo": false
		}
	},
	"routing": "internal",
	"accountType": "FULL"
}' https://<domain>/api/users/<domain>/<uid>

Exemple en Java (en utilisant le client généré Bluemind)

Bloc de code
IUser userService = serviceProvider.instance(IUser.class, domain); 
User user = new User();
user.login = "john";
user.password = "doe";
user.routing = Routing.internal;
user.emails = Arrays.asList(Email.create(login + "@" + domain, true));
user.contactInfos = new VCard();
user.contactInfos.identification.name = new Name();
user.contactInfos.identification.name.givenNames = login;
String userUid = UUID.randomUUID().toString();
userService.create(userUid, user);
Sv translation
languagede
Remarque

Diese Seite ist nicht mehr aktuell. Ab der Version BlueMind 4.8 finden Sie alle Infos in der neuen Dokumentation

Präsentation

Auf dieser Seite finden Sie Beispiele für die Verwendung und Implementierung der Benutzer-API

Volet

Auf dieser Seite:

Sommaire
maxLevel2

Anlegen eines Benutzers

Das Erstellen eines Benutzers umfasst alle Aktionen, die zum Anlegen eines betriebsbereiten Benutzers erforderlich sind:

  • Erstellung auf Datenbankebene
  • Benutzerzuordnung zu einer Domain
  • Erstellung des Posteingangs 
  • Erstellung des Standardkalenders
  • Erstellung einer Standard-Kalenderansicht
  • Erstellung der Adressbücher "Meine Kontakte" und "Gesammelte Kontakte"

https://forge.bluemind.net/staging/doc/openui-models/web-resources/?bm_version=4.1.42252#!/net.bluemind.user.api.IUser/put_users_domainUid_uid

Beispiel in HTTP

MethodeURL
PUThttps://<domain>/api/users/<domain>/<uid>

domain = die Domain

uid = eindeutige Benutzer-ID

Body
Bloc de code
{
	"emails": [{
		"address": "john@<domain>",
		"allAliases": false,
		"isDefault": true
	}],
	"login": "john",
	"password": "doe",
	"contactInfos": {
		"identification": {
			"name": {
				"familyNames": "Doe",
				"givenNames": "John"
			},
			"photo": false
		}
	},
	"routing": "internal",
	"accountType": "FULL"
}

Beispiel in Curl

Bloc de code
curl -X GET --header 'Content-Type: application/json' 
--header 'X-BM-ApiKey: <auth_key>' 
--header 'Accept: application/json' 
--header 'X-BM-ApiKey: <auth_key>' 
-d '{
	"emails": [{
		"address": "john@<domain>",
		"allAliases": false,
		"isDefault": true
	}],
	"login": "john",
	"password": "doe",
	"contactInfos": {
		"identification": {
			"name": {
				"familyNames": "Doe",
				"givenNames": "John"
			},
			"photo": false
		}
	},
	"routing": "internal",
	"accountType": "FULL"
}' https://<domain>/api/users/<domain>/<uid>

Beispiel in Java (unter Verwendung des von Bluemind generierten Clients)

Bloc de code
IUser userService = serviceProvider.instance(IUser.class, domain); 
User user = new User();
user.login = "john";
user.password = "doe";
user.routing = Routing.internal;
user.emails = Arrays.asList(Email.create(login + "@" + domain, true));
user.contactInfos = new VCard();
user.contactInfos.identification.name = new Name();
user.contactInfos.identification.name.givenNames = login;
String userUid = UUID.randomUUID().toString();
userService.create(userUid, user);