Ressources utilisateur de RAD Server

De RAD Studio
Aller à : navigation, rechercher

Remonter à API administrative de RAD Server


La base de données EMS stocke les données relatives aux utilisateurs enregistrés de votre application. Vous pouvez accéder à ces informations en utilisant la ressource Utilisateurs recensée.

Remarque : Utilisez les composants TEMSClientAPI, TBackendUsers ou TBackendAuth pour s'inscrire, se connecter, récupérer, mettre à jour ou supprimer des informations sur les utilisateurs EMS de votre base de données EMS.

Points de terminaison de la ressource Utilisateurs

La ressource Utilisateurs expose les points de terminaison de ressource EMS suivants :

Méthode du point de terminaison Suffixe de la ressource Type de requête HTTP Usage

GetUsers

--

HTTP GET

Récupérer toutes les données d'une ressource Utilisateurs.

GetUser

{id}

HTTP GET

Récupérer toutes les données d'un utilisateur.
id est l'identificateur d'utilisateur EMS unique (UserID) dans la base de données EMS.

GetUserFields

fields

HTTP GET

Récupérer tous les noms de champs des utilisateurs EMS (dont les champs personnalisés).

GetUserGroups

{id}/groups

HTTP GET

Pour récupérer les groupes EMS auxquels appartient l'utilisateur EMS.
id est l'identificateur d'utilisateur EMS unique (UserID) dans la base de données EMS.

SignupUser

--

HTTP POST

S'inscrit sur le serveur EMS avec un utilisateur EMS approprié.

LoginUser

--

HTTP POST

Se connecte au serveur EMS avec un utilisateur EMS spécifique.

AddUser

--

HTTP POST

Ajouter un nouvel utilisateur à la base de données EMS.

UpdateUser

{id}

HTTP PUT

Mettre à jour un utilisateur à partir de la ressource Utilisateurs.
id est l'identificateur d'utilisateur EMS unique (UserID) dans la base de données EMS.

DeleteUser

{id}

HTTP DELETE

Supprimer un élément d'une ressource.
id est l'identificateur d'utilisateur EMS unique (UserID) dans la base de données EMS.

Remarque : _id correspond à l'identificateur d'utilisateur EMS dans la base de données EMS (UserID).

Point de terminaison GetUsers

Renvoie la liste des données des utilisateurs EMS.

En cas de réussite, la réponse du serveur EMS fournit la liste de tous les utilisateurs EMS, avec des détails sur chaque utilisateur.

  • username
  • _id (UserID)
  • _meta (les champs creator, created et updated)
  • Champs personnalisés (facultatif)

Utilisez la méthode QueryUsers, le composant TBackendUsers ou TBackendQuery et la ressource Utilisateurs pour récupérer la liste des utilisateurs EMS.

Exemple de réponse

Voici un exemple de réponse : 

[
    {
        "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"
        }
    }
]

Point de terminaison GetUser

Renvoie les données d'un utilisateur EMS spécifique (identifié par id).

Votre requête doit fournir le champ suivant :

  • _id (UserID)

En cas de réussite, la réponse du serveur EMS fournit les utilisateurs EMS avec les détails suivants :

  • username
  • _id (UserID)
  • _meta (les champs creator, created et updated)
  • Champs personnalisés (facultatif)

Utilisez la méthode RetrieveUser, le composant TBackendUsers ou TBackendQuery et un utilisateur spécifique pour récupérer ses données.

Exemple de réponse

Voici un exemple de réponse à la requête d'utilisateur "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\"."
}

Point de terminaison GetFields

Récupère tous les noms de champs des Utilisateurs EMS (dont les champs personnalisés).

En cas de réussite, la réponse du serveur EMS fournit les utilisateurs EMS avec, au minimum, les détails suivants :

  • username
  • _id (UserID)
  • _meta (les champs creator, created et updated)
  • Champs personnalisés (facultatif)

Utilisez la méthode RetrieveUsersFields pour récupérer tous les noms de champs.

Exemple de réponse

Voici un exemple de réponse : 

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

Point de terminaison GetUserGroups

Récupère les groupes EMS auxquels l'utilisateur EMS (identifié par id) appartient.

Votre requête doit fournir le champ suivant :

  • _id (UserID)

En cas de réussite, la réponse du serveur EMS fournit la liste de tous les utilisateurs EMS, avec des détails sur chaque utilisateur.

Utilisez la méthode RetrieveUserGroups pour récupérer la liste des groupes EMS auxquels l'utilisateur appartient.

Exemple de réponse

Voici un exemple de réponse à la requête d'utilisateur "82C6E6C0-A4BC-44B8-9434-A07DCE364CD4" : 

[  
   "testgroup",
   "Admins"
]

Point de terminaison SignupUser

S'inscrit sur le serveur EMS avec un utilisateur EMS approprié.

Votre requête doit fournir les champs suivants :

  • username
  • password

Utilisez la méthode SignupUser de TEMSClientAPI ou la méthode Signup du composant TBackendAuth pour inscrire un nouvel utilisateur EMS dans le serveur EMS.

Point de terminaison LoginUser

Se connecte au serveur EMS avec un utilisateur EMS spécifique.

Votre requête doit fournir les champs suivants :

  • username
  • password

Utilisez la méthode LoginUser de TEMSClientAPI ou la méthode Login du composant TBackendAuth pour connecter un utilisateur EMS existant au serveur EMS.

Point de terminaison AddUser

Ajoute un nouvel utilisateur EMS à la base de données EMS.

Votre requête doit fournir les champs suivants :

  • username
  • password

Utilisez la méthode AddUser ou la méthode CreateUserAPI du composant TBackendUsers pour ajouter de nouveaux utilisateurs EMS.

Point de terminaison UpdateUser

Met à jour les informations stockées dans la base de données EMS relatives à un utilisateur EMS spécifique (identifié par id).

Votre requête doit fournir les champs suivants :

  • _id (UserID)
  • Champs personnalisés à mettre à jour

Utilisez la méthode UpdateUser ou la méthode UpdateUserDetails du composant TBackendAuth pour mettre à jour les champs personnalisés relatifs à un utilisateur EMS existant.

Point de terminaison DeleteUser

Supprime l'utilisateur EMS spécifié par id.

Votre requête doit fournir le champ suivant :

  • _id (UserID)

Utilisez la méthode DeleteUser ou la méthode DeleteUser du composant TBackendUsers pour supprimer un utilisateur EMS.

Champs Utilisateurs EMS

La ressource Utilisateurs de la requête EMS et les réponses peuvent inclure toute combinaison des champs suivants :

Elément Exemple Description 
"username"

"testuser"

Nom d'utilisateur EMS dans la base de données EMS 

"_id"

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

Identificateur unique (UserID) d'un utilisateur EMS dans la base de données EMS 

"meta"

{
      "creator": "24EDA495-90FC-4BC4-9626-C87783357948",
      "created": "2014-08-20T11:08:55.000Z",
      "updated": "2014-08-20T11:08:59.000Z"
}
  • creator : Créateur de l'utilisateur EMS dans la base de données EMS.
  • created : Heure de création de l'utilisateur EMS.
  • updated : Heure de mise à jour de l'utilisateur EMS.

Champs personnalisés 

"myCustomField": "My Custom Field description"

Informations supplémentaires stockées pour l'utilisateur EMS.

Voir aussi

Récupérée de « https://docwiki.embarcadero.com/RADStudio/Athens/f/index.php?title=Ressources_utilisateur_de_RAD_Server&oldid=212841 »