Like what you see? Have a play with our trial version.

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Groups can be created using the POST /api/user-groups end-point Create User Group. The model for User Group creation is:

Code Block
{

  "groupName": "New Group",

  "groupDescription": "This a new group",

  "groupStatus": "OPEN",

  "isSecureGroup": "false"

}

After the successful creation of a group, the service will return a User Group model that contains the unique userGroupId of the new group. The userGroupId can then be used for identifying the group in other services. This service creates an empty group, group member components need to be added with the POST /api/user-groups/{groupId}/members end-point.

...

A list of new members can be posted using this end-point. The model that represents a group member is:

Code Block
{

    "entityType": "PERSON",

    "entityCode": "",

    "entityId": 13235,

    "membershipType": "INCLUDED"

}

EntityType can be one of PERSON,  GROUP,  LDAP or ROLE.

...