Schnittstelle zur Erstellung von Benutzern und Organisationen durch Drittapplikationen

Über die MessageQueue RabbitMQ erlauben wir die Erstellung von Benutzern von Organisationen durch Drittapplikationen. Folgende Werte können so übergeben werden.

Upsert Document

Upsert Message

{
  "Id": "GUID",
  "Active": true,
  "SendActivationLink": true,
  "FirstName": "Peter",
  "LastName": "Muster",
  "Email": "peter.muster@egeli-informatik.ch",
  "UserName": "peter.muster",
  "UserClaims": [
    {
      "Type": "elego.role",
      "Value": "Superuser"
    },
    ...
  ],
  "Phone": "+41 123 456 79",
  "Mobile": "+41 987 654 21",
  "Localization": "ch-DE",
  "DateOfBirth": "1988-06-01",
  "Gender": 1,
  "Role": 0,
  "TenantKey": "mytenant",
  "TenantName": "My Tenant",
  "Address": {
    "Street": "Raiffeisenplatz",
    "HouseNumber": "8",
    "AdditionalAddressLine": null,
    "PostBox": null,
    "PostalCode": "9000",
    "City": "St. Gallen",
    "Country": "Switzerland"
  },
  "TenantClaim": [
    {
      "Type": "tenant.license",
      "Value": "foo"
    },
    ...
  ],
  "MfaForTenantRequired": true,
  "ParentTenantKey": "eis"
}

Beschreibungen

Gender

Option	Bedeutung
0	undefined
1	männlich
2	weiblich

Role

Option	Bedeutung
0	User
1	TenantAdministrator
2	Administrator
3	RootAdministrator

TenantKey und TenantName

Mit dem Tenantkey wird die übergeordnete Organisation des Benutzers angegeben. Wenn die Organisation noch nicht existiert, wird sie neu angelegt. Ändert sich der TenantName, wird dieser angepasst. Ändert sich der Tenantkey eines Benutzers, ist die Message ungültig.

MfaForTenantRequired

Mit der Option MfaForTenantRequired wird die Opt-In Möglichkeit für MFA geboten. Wenn true als Rückgabewert geliefert wird, werden alle Benutzer der Organisation auf MFA umgestellt werden. Eine Opt-Out Option gibt es über die Schnittstelle nicht, dies muss über das User Management verwaltet werden.

Option	Bedeutung
false	Default, hat keinen Einfluss auf die MFA Einstellungen der übermittelten Organisation
true	Aktiviert MFA für Organisation des übermittelten Benutzers

UserClaims und TenantClaims

Mit den UserClaims und TenantClaims können auf Stufe User oder Tenant Claims gesetzt werden.

Claims über MessageQueue setzen

Damit die Claims gespeichert werden, müssen zuvor die entsprechenden Claim Definitionen erstellt werden, ansonsten ist die übermittelte Message untültig.

Wert	Beschreibung	Beispiel
Type	Name des Claims	elego.role
Value	Wert	Superuser

ParentTenantClaim

Mit dem ParentTenantClaim können Organisationen und Suborganisationen im User Management automatisch abgebildet werde. Der ParentTenantClaim muss dem Key eines bestehenden Tenants entsprechen.