REST API Reference

Back Next

Updating a user group

You can add users and roles to user groups and remove users and roles from user groups.

Add roles

To add a role to a user group, send a PUT request using one of the following URIs:

/public/core/v3/userGroups/<user group ID>/addRoles

/public/core/v3/userGroups/name/<user group name>/addRoles

Include an array of roles to add to the user group.

To add roles to a user group, you might send a request similar to the following example:

PUT <baseApiUrl>/public/core/v3/userGroups/cPYWk02I4aBeuLEvYRtaMS/addRoles
Content-Type: application/json
Accept: application/json
INFA-SESSION-ID: <sessionId>
{
    "roles" : ["Admin", "Business Manager"]
}

Remove roles

To remove a role from a user group, send a PUT request using one of the following URIs:

/public/core/v3/userGroups/<user group ID>/removeRoles

/public/core/v3/userGroups/name/<user group name>/removeRoles

Include an array of roles to remove from the user group.

To remove roles from a user group, you might send a request similar to the following example:

PUT <baseApiUrl>/public/core/v3/userGroups/cPYWk02I4aBeuLEvYRtaMS/removeRoles
Content-Type: application/json
Accept: application/json
INFA-SESSION-ID: <sessionId>
{
    "roles" : ["Admin", "Business Manager"]
}

Add users

To add a user to a user group, send a PUT request using one of the following URIs:

/public/core/v3/userGroups/<user group ID>/addUsers

/public/core/v3/userGroups/name/<user group name>/addUsers

Include an array of user names to add to the user group.

To add users to a user group, you might send a request similar to the following example:

PUT <baseApiUrl>/public/core/v3/userGroups/cPYWk02I4aBeuLEvYRtaMS/addUsers
Content-Type: application/json
Accept: application/json
INFA-SESSION-ID: <sessionId>
{
    "users" : ["LarryR", "ScottY"]
}

Remove users

To remove a user from a user group, send a PUT request using one of the following URIs:

/public/core/v3/userGroups/<user group ID>/removeUsers

/public/core/v3/userGroups/name/<user group name>/removeUsers

Include an array of user names to remove from the user group.

To remove users from a user group, you might send a request similar to the following example:

PUT <baseApiUrl>/public/core/v3/userGroups/cPYWk02I4aBeuLEvYRtaMS/removeUsers
Content-Type: application/json
Accept: application/json
INFA-SESSION-ID: <sessionId>
{
    "users" : ["LarryR", "ScottY"]
}