getUserGroups

Obtén todos los grupos de usuarios.

Descripción

Obtiene todos los grupos de usuarios del proyecto como un array plano, sin tener en cuenta el anidamiento. Se resuelve en un array de objetos IUserGroupEntity.

.getUserGroups(

);

Esquema de parámetros

Schema

langCode: string
Código de idioma. Predeterminado: el langCode pasado a defineOneEntry ("en_US" si no se pasó ninguno).
ejemplo: "en_US"

Ejemplos

Ejemplo mínimo

const response = await UserGroups.getUserGroups();

Con un código de idioma

const response = await UserGroups.getUserGroups('en_US');

Ejemplo de respuesta

[
  {
    "id": 1,
    "depth": 0,
    "parentId": null,
    "localizeInfos": {
      "title": "Guest"
    },
    "isVisible": true,
    "childrenCount": "0",
    "identifier": "guest",
    "isSync": false,
    "attributeValues": {}
  },
  {
    "id": 2,
    "depth": 0,
    "parentId": null,
    "localizeInfos": {
      "title": "sd"
    },
    "isVisible": true,
    "childrenCount": "0",
    "identifier": "wewe",
    "isSync": false,
    "attributeValues": {}
  }
]

Esquema de respuesta

Esquema: IUserGroupEntity[]

id: número
ID del grupo de usuarios.
ejemplo: 1

depth: número
Nivel del grupo en el árbol: 0 para un grupo de nivel superior, el depth del padre más 1 para un hijo.
ejemplo: 0

parentId: número | null
Identificador del grupo padre; null para un grupo de nivel superior.
ejemplo: null

localizeInfos: ILocalizeInfo
Título localizado del grupo.

isVisible: booleano
Indica si el grupo es visible.
ejemplo: true

childrenCount: string
Número de grupos hijos. La API lo envía como cadena, no como número.
ejemplo: "0"

identifier: cadena
Identificador de texto (marcador) del grupo.
ejemplo: "guest"

isSync: booleano
Si el índice de atributos del grupo está creado para el idioma solicitado. Cuando es false, un attributeValues vacío significa que los valores aún no están indexados, no que no haya ninguno.
ejemplo: false

attributeValues: IAttributeValues
Valores de los atributos del grupo.

version: número
Número de versión del grupo. Solo lo devuelven getUserGroupById() y getUserGroupByMarker(); los métodos de lista (getUserGroups(), getRootUserGroups(), getChildUserGroupsByMarker()) lo omiten.

---