getUserGroupById

Récupérer un objet de groupe d'utilisateurs unique par son identifiant.

Description

Cette méthode récupère un objet de groupe d'utilisateurs unique par son identifiant. Elle renvoie une promesse qui se résout en un objet IUserGroupEntity.

UserGroups.getUserGroupById(id, langCode);

Paramètres

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

langCode: string (optionnel)
Code de langue. Par défaut : "en_US".
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
Identifiant du groupe d'utilisateurs.
exemple : 1

depth: number
Profondeur d'imbrication par rapport au parent.
exemple : 0

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

localizeInfos: ILocalizeInfo
Titre du groupe, en tenant compte de la localisation.

isVisible: boolean
Indicateur de visibilité.
exemple : true

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

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

isSync: boolean
Indicateur de synchronisation.
exemple : false

attributeValues: IAttributeValues
Valeurs d'attribut du groupe.

version: number
Version de l'objet. Pas présent sur chaque instance.
exemple : NaN

---