Ressources Groupes de RAD Server
Remonter à API administrative de RAD Server
La base de données EMS stocke les données relatives aux groupes d'utilisateurs enregistrés de votre application. Vous pouvez accéder à ces informations en utilisant la ressource Groupes recensée.
Vous pouvez utiliser les groupes EMS pour autoriser (ou refuser) à un groupe d'utilisateurs EMS l'accès à une ressource EMS particulière de votre serveur EMS (selon les informations d'identification de la requête HTTP).
- Remarque : Utilisez le composant TEMSClientAPI ou le composant TBackendGroups pour créer, mettre à jour ou supprimer un groupe EMS, ou pour ajouter des utilisateurs EMS à des groupes EMS existants.
Sommaire
Points de terminaison de la ressource Groupes
La ressource Groupes 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 |
|---|---|---|---|
|
GetGroups |
-- |
HTTP GET |
Récupérer toutes les données d'une ressource Groupes. |
|
GetGroup |
|
HTTP GET |
Récupérer toutes les données d'un groupe. |
|
GetGroupFields |
|
HTTP GET |
Pour récupérer les noms de champs de tous les groupes EMS. |
|
AddGroup |
-- |
HTTP POST |
Ajouter un nouveau groupe à la base de données EMS. |
|
UpdateGroup |
|
HTTP PUT |
Mettre à jour un groupe dans la base de données EMS. |
|
DeleteGroup |
|
HTTP DELETE |
Supprimer un groupe de la base de données EMS. |
Point de terminaison GetGroups
Renvoie la liste des données des groupes EMS.
Utilisez la méthode QueryGroups ou les composants TBackendGroups ou TBackendQuery et la ressource Groupes pour récupérer la liste des utilisateurs EMS.
En cas de réussite, la réponse du serveur EMS fournit la liste de tous les groupes EMS, avec des détails sur chaque groupe.
- name
- _meta (champs creator, created date et updated date)
- users
- Champs personnalisés (facultatif)
Exemple de réponse
Voici un exemple de réponse :
[
{
"name": "testgroup",
"_meta": {
"creator": "00000000-0000-0000-0000-000000000001",
"created": "2014-08-20T11:08:56.000Z"
},
"description": "Created by EMS setup.",
"users": [
"24EDA495-90FC-4BC4-9626-C87783357948"
]
},
{
"name": "admins",
"_meta": {
"creator": "00000000-0000-0000-0000-000000000001",
"created": "2014-08-20T11:08:56.000Z",
"updated": "2014-08-20T11:09:56.000Z"
},
"users": [
"24EDA495-90FC-4BC4-9626-C87783357948",
"AB4900CC-CD7A-4890-B20D-9A3E65B450C7"
]
}
]
Point de terminaison GetGroup
Renvoie les données d'un groupe EMS spécifié.
Votre requête doit fournir le champ suivant :
- name
Utilisez la méthode RetrieveGroup, les composants TBackendGroups ou TBackendQuery et le nom du groupe pour récupérer les données.
En cas de réussite, la réponse du serveur fournit le groupe EMS avec des détails.
- name
- _meta (champs creator, created et updated)
- users
- Champs personnalisés (facultatif)
Exemple de réponse
Voici un exemple de réponse à la requête du nom de groupe "testgroup" :
{
"name": "testgroup",
"_meta": {
"creator": "00000000-0000-0000-0000-000000000001",
"created": "2014-08-20T11:08:56.000Z"
},
"description": "Created by EMS setup.",
"users": [
"24EDA495-90FC-4BC4-9626-C87783357948"
]
}
Point de terminaison GetFields
Récupère les noms de champs de tous les groupes EMS depuis la base de données EMS.
Utilisez la méthode RetrieveGroupsFields pour récupérer les champs d'un groupe EMS.
En cas de réussite, la réponse du serveur EMS fournit tous les noms de champs des groupes EMS.
- name
- _meta (champs creator, created et updated)
- users
Exemple de réponse
Voici un exemple de réponse :
[
{
"name":"groupname"
},
{
"name":"_meta",
"fields":[
{
"name":"creator"
},
{
"name":"created"
},
{
"name":"updated"
}
]
},
{
"name":"users"
},
{
"name":"description",
"custom":true
}
]
Point de terminaison AddGroup
Ajoute un nouveau groupe à la base de données EMS.
Votre requête doit fournir le champ suivant :
- name
Utilisez la méthode TEMSClientAPI.CreateGroup ou la méthode CreateGroup du composant TBackendGroups pour ajouter un nouveau groupe EMS.
Point de terminaison UpdateGroup
Met à jour les données d'un groupe EMS existant qui est stocké dans la base de données EMS.
Votre requête doit fournir au moins le champ suivant :
- name
Utilisez la méthode TEMSClientAPI.UpdateGroup ou la méthode UpdateGroup du composant TBackendGroups pour mettre à jour les données d'un groupe EMS existant.
Point de terminaison DeleteGroup
Supprime un groupe EMS existant de la base de données EMS.
Votre requête doit fournir le champ suivant :
- name
Utilisez la méthode TEMSClientAPI.DeleteGroup ou la méthode DeleteGroup du composant TBackendGroups pour supprimer un groupe EMS existant.
Champs des groupes EMS
La ressource Groupes de la requête EMS et les réponses peuvent inclure toute combinaison des champs suivants :
| Elément | Exemple | Description |
|---|---|---|
"name"
|
"admins"
|
Nom de groupe EMS unique dans la base de données EMS. |
"_meta"
|
{
"creator": "00000000-0000-0000-0000-000000000001",
"created": "2014-08-20T11:08:56.000Z",
"updated": "2014-08-20T11:09:56.000Z"
}
|
|
"users"
|
[
"24EDA495-90FC-4BC4-9626-C87783357948",
"AB4900CC-CD7A-4890-B20D-9A3E65B450C7"
]
|
Liste des utilisateurs EMS qui appartiennent à ce groupe EMS. |
|
Champs personnalisés |
"myCustomField": "My Custom Field description"
|
Informations supplémentaires stockées pour le groupe EMS. |