Users and Groups

Users and Groups

The /user API provides access to user information.

• Unrestricted read access to this API is restricted to users with the view.admin.user.edit feature access role.
• Restricted access to this API is available to all users to access their own information.
• Write access to this API is restricted to users with the view.admin.user.edit feature access role.

/user/:user_id

http://localhost/jarvis-agent/n2int-angular/api/user/

• GET Provides access to all users, or for users without the view.admin.user.edit role, the current user. Parameters:
  • user_id The ID of the user whose data should be returned. Passed as URL component. Optional.
  • user_name The name of the user whose data should be returned. Passed as a URL parameter. Optional. Case sensitive.
• POST Allows new users to be created, subject to role restrictions.
• PUT Allows existing users to be updated, subject to role restrictions.
• DELETE Allows users to be deleted, subject to role restrictions. Note that deletion is not the same as being marked as inactive, a task done through PUT and POST.

Note that updates for non-administrator users are performed through the following API rather that through this API.

/user/current

http://localhost/jarvis-agent/n2int-angular/api/user/current

• PUT Allows the currently authenticated user’s preferences to be updated. This is the appropriate write API for users without the view.admin.user.edit role to update user details.

/user/password

http://localhost/jarvis-agent/n2int-angular/api/user/password

• GET Provides users with an API endpoint to change their password. For users without the view.admin.user.edit role the only user whose password can be changed is their own. Users with this role may change any password. Parameters:
  • user_name The name of the user whose password is to be changed.
  • password The new password for the user. This password is to be encoded in base64.

/security_group/:group_id

http://localhost/jarvis-agent/n2int-angular/api/security_group

• GET Provides a list of all available security groups. This API is available to all authenticated users.
• POST Allows new groups to be created, subject to role restrictions.
• PUT Allows existing groups to be updated, subject to role restrictions.

/security_feature_group

http://localhost/jarvis-agent/n2int-angular/api/security_feature_group

• GET Provides a list of all available feature access groups. This API is available to all authenticated users.