Aller au contenu principal

getUserGroupById

Récupère un groupe d'utilisateurs par son ID.

Description​

Récupère un groupe d'utilisateurs par son ID numérique et se résout en un IUserGroupEntity. Si aucun groupe n'a cet ID, se résout en un IError avec statusCode: 404 ("Group not found").

.getUserGroupById(

,

);

Schéma des paramètres​

Schema

id(required): number
ID du groupe d'utilisateurs.
exemple : 1

langCode: string
Code de langue. Par défaut : le langCode passé à defineOneEntry ("en_US" s'il n'y en a pas).
exemple : "en_US"

Exemples​

Exemple minimal​

const response = await UserGroups.getUserGroupById(1);

Exemple de réponse​

{
  "id": 1,
  "depth": 0,
  "parentId": null,
  "localizeInfos": {
    "title": "Guest"
  },
  "isVisible": true,
  "childrenCount": "0",
  "identifier": "guest",
  "isSync": false,
  "attributeValues": {},
  "version": 0
}

Schéma de réponse​

Schéma : IUserGroupEntity

id: number
ID du groupe d'utilisateurs.
exemple : 1

depth: number
Niveau du groupe dans l'arborescence : 0 pour un groupe de premier niveau, la depth du parent plus 1 pour un enfant.
exemple : 0

parentId: number | null
Identifiant du groupe parent, null pour un groupe de premier niveau.
exemple : null

localizeInfos: ILocalizeInfo
Titre localisé du groupe.

isVisible: boolean
Indique si le groupe est visible.
exemple : true

childrenCount: string
Nombre de groupes enfants. L'API l'envoie sous forme de chaîne, et non de nombre.
exemple : "0"

identifier: string
Identifiant textuel (marqueur) du groupe.
exemple : "guest"

isSync: boolean
Indique si l'index des attributs du groupe est construit pour la langue demandée. Lorsqu'il vaut false, un attributeValues vide signifie que les valeurs ne sont pas encore indexées, et non qu'il n'y en a aucune.
exemple : false

attributeValues: IAttributeValues
Valeurs d'attributs du groupe.

version: number
Numéro de version du groupe. Renvoyé uniquement par getUserGroupById() et getUserGroupByMarker() ; les méthodes de liste (getUserGroups(), getRootUserGroups(), getChildUserGroupsByMarker()) l'omettent.