EMS-Ressource "Benutzer"

Aus RAD Studio
Wechseln zu: Navigation, Suche

Nach oben zu EMS Administrative API


In der EMS-Datenbank werden Daten über die registrierten Benutzer Ihrer Anwendung gespeichert. Mit der Ressource "Benutzer" können Sie auf diese Informationen zugreifen.

Hinweis: Verwenden Sie die Komponente TEMSClientAPI, TBackendUsers oder TBackendAuth, um EMS-Benutzerinformationen in Ihrer EMS-Datenbank zu registrieren, anzumelden, abzurufen, zu aktualisieren oder zu löschen.

Endpunkte der Ressource "Benutzer"

Die Ressource "Benutzer" stellt die folgenden EMS-Ressourcenendpunkte bereit:

Name der Endpunktmethode Ressourcensuffix HTTP-Anforderungstyp Verwendung

GetUsers

--

HTTP GET

Zum Abrufen aller Daten aus Benutzerressource.

GetUser

{ID}

HTTP GET

Zum Abrufen aller Daten für einen Benutzer.
ID ist der eindeutige EMS-Benutzerbezeichner (UserID) in der EMS-Datenbank.

GetFields

Felder

HTTP GET

Zum Abrufen aller Feldnamen der EMS-Benutzer (einschließlich der benutzerdefinierten Felder).

GetUserGroups

{ID}/Gruppen

HTTP GET

Zum Abrufen der EMS-Gruppen, zu denen der EMS-Benutzer gehört.
ID ist der eindeutige EMS-Benutzerbezeichner (UserID) in der EMS-Datenbank.

SignupUser

--

HTTP POST

Registriert einen geeigneten EMS-Benutzer beim EMS-Server.

LoginUser

--

HTTP POST

Meldet den angegebenen EMS-Benutzer beim EMS-Server an.

AddUser

--

HTTP POST

Zum Hinzufügen eines neuen Benutzers zu der EMS-Datenbank.

UpdateUser

{ID}

HTTP PUT

Zum Aktualisieren eines Benutzers aus der Ressource "Benutzer".
ID ist der eindeutige EMS-Benutzerbezeichner (UserID) in der EMS-Datenbank.

DeleteUser

{ID}

HTTP DELETE

Zum Löschen eines Elements aus einer Ressource.
ID ist der eindeutige EMS-Benutzerbezeichner (UserID) in der EMS-Datenbank.

Hinweis: _id entspricht dem EMS-Benutzerbezeichner in der EMS-Datenbank (UserID).

GetUsers-Endpunkt

Gibt eine Liste der EMS-Benutzerdaten zurück.

Bei Erfolg enthält die Antwort vom EMS-Server eine Liste aller EMS-Benutzer mit Einzelheiten zu jedem Benutzer.

  • username
  • _id (UserID)
  • _meta (Felder "creator", "created" und "updated")
  • Benutzerdefinierte Felder (optional)

Verwenden Sie die Methode QueryUsers, die Komponente TBackendUsers oder TBackendQuery und die Ressource "Benutzer", um die Liste der EMS-Benutzer abzurufen.

Beispielantwort

So könnte eine Antwort vom Server aussehen: 

[
    {
        "username": "test",
        "_id": "24EDA495-90FC-4BC4-9626-C87783357948",
        "_meta": {
            "creator": "24EDA495-90FC-4BC4-9626-C87783357948",
            "created": "2014-08-20T11:08:55.000Z"
        },
        "description": "Created by EMS setup.  Password is \"test\"."
    },
    {
        "username": "testuser",
        "_id": "AB4900CC-CD7A-4890-B20D-9A3E65B450C7",
        "_meta": {
            "creator": "24EDA495-90FC-4BC4-9626-C87783357948",
            "created": "2014-08-20T11:08:55.000Z",
            "updated": "2014-08-20T11:08:59.000Z"
        }
    }
]

GetUser-Endpunkt

Gibt die Daten für einen bestimmten (durch die id bezeichneten) EMS-Benutzer zurück.

Ihre Anforderung muss das folgende Feld enthalten:

  • _id (UserID)

Bei Erfolg enthält die Antwort vom EMS-Server die EMS-Benutzer mit den folgenden Einzelheiten:

  • username
  • _id (UserID)
  • _meta (Felder "creator", "created" und "updated")
  • Benutzerdefinierte Felder (optional)

Verwenden Sie die Methode RetrieveUser, die Komponente TBackendUsers oder TBackendQuery und einen bestimmten Benutzer, um diese Daten abzurufen.

Beispielantwort

Beispielantwort auf die Anforderung für Benutzer "82C6E6C0-A4BC-44B8-9434-A07DCE364CD4": 

{
    "username": "test",
    "_id": "82C6E6C0-A4BC-44B8-9434-A07DCE364CD4",
    "_meta": {
        "creator": "82C6E6C0-A4BC-44B8-9434-A07DCE364CD4",
        "created": "2014-08-20T09:51:10.000Z"
    },
    "description": "Created by EMS setup.  Password is \"test\"."
}

GetFields-Endpunkt

Zum Abrufen aller Feldnamen der EMS-Benutzer (einschließlich der benutzerdefinierten Felder).

Bei Erfolg enthält die Antwort vom EMS-Server die EMS-Benutzer mit (zumindest) den folgenden Einzelheiten:

  • username
  • _id (UserID)
  • _meta (Felder "creator", "created" und "updated")
  • Benutzerdefinierte Felder (optional)

Verwenden Sie die Methode RetrieveUsersFields, um alle Feldnamen abzurufen.

Beispielantwort

So könnte eine Antwort vom Server aussehen: 

[  
   {  
      "name":"username"
   },
   {  
      "name":"_id"
   },
   {  
      "name":"_meta",
      "fields":[  
         {  
            "name":"creator"
         },
         {  
            "name":"created"
         },
         {  
            "name":"updated"
         }
      ]
   },
   {  
      "name":"description",
      "custom":true
   }
]

GetUserGroups-Endpunkt

Zum Abrufen der EMS-Gruppen, zu denen der EMS-Benutzer (angegeben in ID) gehört.

Ihre Anforderung muss das folgende Feld enthalten:

  • _id (UserID)

Bei Erfolg enthält die Antwort vom EMS-Server die Liste der EMS-Gruppennamen, zu denen der Benutzer gehört.

Verwenden Sie die Methode RetrieveUserGroups, um die Liste der EMS-Gruppen, zu denen der Benutzer gehört, abzurufen.

Beispielantwort

Beispielantwort auf die Anforderung für Benutzer "AB5D4B63-79F9-40A4-A34D-4D2D26ECF170": 

[  
   "testgroup",
   "Admins"
]

SingupUser-Endpunkt

Registriert einen geeigneten EMS-Benutzer beim EMS-Server.

Ihre Anforderung muss die folgenden Felder enthalten:

  • username
  • password

Verwenden Sie die Methode SignupUser der Komponente TEMSClientAPI oder die Methode Signup der Komponente TBackendAuth, um beim EMS-Server einen neuen EMS-Benutzer zu registrieren.

LoginUser-Endpunkt

Meldet den angegebenen EMS-Benutzer beim EMS-Server an.

Ihre Anforderung muss die folgenden Felder enthalten:

  • username
  • password

Verwenden Sie die Methode LoginUser der Komponente TEMSClientAPI oder die Methode Login der Komponente TBackendAuth, um einen vorhandenen EMS-Benutzer beim EMS-Server anzumelden.

AddUser-Endpunkt

Fügt der EMS-Datenbank einen neuen EMS-Benutzer hinzu.

Ihre Anforderung muss die folgenden Felder enthalten:

  • username
  • password

Verwenden Sie die Methode AddUser oder die Methode CreateUserAPI der Komponente TBackendUsers, um neue EMS-Benutzer hinzuzufügen.

UpdateUser-Endpunkt

Aktualisiert die in der EMS-Datenbank gespeicherten Informationen für einen bestimmten (durch die id bezeichneten) EMS-Benutzer.

Ihre Anforderung muss die folgenden Felder enthalten:

  • _id (UserID)
  • username
  • Benutzerdefinierte Felder für die Aktualisierung

Verwenden Sie die Methode UpdateUser oder die Methode UpdateUserDetails der Komponente TBackendAuth, um die benutzerdefinierten Felder eines vorhandenen EMS-Benutzers zu aktualisieren.

DeleteUser-Endpunkt

Löscht den EMS-Benutzer mit der angegebenen id.

Ihre Anforderung muss das folgende Feld enthalten:

  • _id (UserID)
  • username

Verwenden Sie die Methode DeleteUser oder die Methode DeleteUser der Komponente TBackendUsers, um einen EMS-Benutzer zu löschen.

Felder für EMS-Benutzer

Benutzerressourcen in EMS-Anforderungen und -Antworten können eine beliebige Kombination der folgenden Felder enthalten:

Element Beispiel Beschreibung 
"username"

"testuser"

EMS-Benutzername in der EMS-Datenbank 

"_id"

"AB4900CC-CD7A-4890-B20D-9A3E65B450C7"

Eindeutiger Bezeichner eines EMS-Benutzers (UserID) in der EMS-Datenbank 

"meta"

{
      "creator": "24EDA495-90FC-4BC4-9626-C87783357948",
      "created": "2014-08-20T11:08:55.000Z",
      "updated": "2014-08-20T11:08:59.000Z"
}
  • creator: Ersteller des EMS-Benutzers in der EMS-Datenbank.
  • created: Erstellungsdatum des EMS-Benutzers.
  • updated: Zeitpunkt, an dem der EMS-Benutzer aktualisiert wurde.

Benutzerdefinierte Felder 

"myCustomField": "My Custom Field description"

Weitere für den EMS-Benutzer gespeicherte Informationen

Siehe auch

Abgerufen von „http://docwiki.embarcadero.com/RADStudio/Seattle/d/index.php?title=EMS-Ressource_%22Benutzer%22&oldid=181631“