User Management

Actions taken on a resource determine the type of action that can be performed.

The following table shows the actions that can be taken on each resource, including the URI and object type of the resource.

Segment

Resource

URI

$filter

$select

$top

$skip

$orderby

Group

group - by ID

/system/group/groupid

Help unavailable

Help available

Help unavailable

Help unavailable

Help unavailable

 

group - by user

/system/group/user/userid

Help available

Help available

Help available

Help available

Help available

 

group - all

/system/group

Help available

Help available

Help available

Help available

Help available

 

group hierarchy - all

/system/grouphierarchy

Help available

Help available

Help available

Help available

Help available

 

group - create

/system/group

Help unavailable

Help unavailable

Help unavailable

Help unavailable

Help unavailable

 

group - update

/system/group

Help unavailable

Help unavailable

Help unavailable

Help unavailable

Help unavailable

 

group - delete

/system/group/*groupid*

Help unavailable

Help unavailable

Help unavailable

Help unavailable

Help unavailable

 

group membership - all

/system/groupmembership

Help available

Help available

Help available

Help available

Help available

 

group - add member

/system/groupmember

Help unavailable

Help unavailable

Help unavailable

Help unavailable

Help unavailable

 

group - remove member

/system/groupmember

Help unavailable

Help unavailable

Help unavailable

Help unavailable

Help unavailable

 

group - add to role

/system/rolegroup

Help unavailable

Help unavailable

Help unavailable

Help unavailable

Help unavailable

 

group - remove from role

/system/rolegroup

Help unavailable

Help unavailable

Help unavailable

Help unavailable

Help unavailable

Role

role - all

/system/role

Help available

Help available

Help available

Help available

Help available

 

role - by user ID

/system/role/user/*userid*

Help available

Help available

Help available

Help available

Help available

 

role - memberships

/system/role

Help available

Help available

Help available

Help available

Help available

 

role - create

/system/role

Help unavailable

Help unavailable

Help unavailable

Help unavailable

Help unavailable

 

role - update

/system/role

Help unavailable

Help unavailable

Help unavailable

Help unavailable

Help unavailable

 

role - delete

/system/role/*roleid*

Help unavailable

Help unavailable

Help unavailable

Help unavailable

Help unavailable

Selected User Group

selected user group - by field id

/system/usergroupselection/fieldid

Help available

Help available

Help available

Help available

Help available

User

user - tasks

/system/task

Help available

(Only for IsComplete)

Help unavailable

Help available

Help available

Help unavailable

 

user - by id

/system/user/userid

Help unavailable Help available Help unavailable Help unavailable Help unavailable

 

user - by group

/system/user/group/groupid

Help available

Help available

Help available

Help available

Help available

 

user - all

/system/user

Help available

Help available

Help available

Help available

Help available

 

user - create

/system/user

Help unavailable

Help unavailable

Help unavailable

Help unavailable

Help unavailable

 

user - update

/system/user

Help unavailable

Help unavailable

Help unavailable

Help unavailable

Help unavailable

 

user - delete

/system/user/*userid*

Help unavailable

Help unavailable

Help unavailable

Help unavailable

Help unavailable

 

user - activate

/system/user/status/active/*userid*

Help unavailable

Help unavailable

Help unavailable

Help unavailable

Help unavailable

 

user - deactivate

/status/inactive/*userid*

Help unavailable

Help unavailable

Help unavailable

Help unavailable

Help unavailable

 

user - change password

/system/userpassword

Help unavailable

Help unavailable

Help unavailable

Help unavailable

Help unavailable

 

user - add to group

/system/usergroup

Help unavailable

Help unavailable

Help unavailable

Help unavailable

Help unavailable

 

user - remove from group

/system/usergroup

Help unavailable

Help unavailable

Help unavailable

Help unavailable

Help unavailable

 

user - add to role

/system/userrole

Help unavailable

Help unavailable

Help unavailable

Help unavailable

Help unavailable

 

user - remove from role

/system/userrole

Help unavailable

Help unavailable

Help unavailable

Help unavailable

Help unavailable

 

user contacts- all

/system/usercontact

Help available

Help available

Help available

Help available

Help available

 

user contacts - by user ID

/system/usercontact/*userid*

Help available

Help available

Help available

Help available

Help available

Note: The following properties are allowed with the $filter, $select, and the $orderby actions in the OData query on the field definition resources available in the table above:

  • Id
  • LevelId
  • Type
  • Name
  • Alias
  • IsActive
  • Guid
  • ASOStatus
  • SystemType
  • IsPrivate
  • IsContentReadOnly
  • EsFieldMappingId
  • UpdateInformation
  • FieldMap