Skip to end of metadata
Go to start of metadata

The following API calls are available for the Portal subsystem:

  • GET Available Applications List
  • ADD/Modify/Remove User to/from the Application Administrator Role
  • Add/Modify/Remove USER to/from the Application USER Roles
  • GET Application List where user currently have Administrator Roles
  • GET Application User Roles List

For more information, see the Portal API specification.

REST APIs Exposed for Admin User Management

Service APIs





Method



Path



Server side method description

GET

/roles

getAvailableRoles()

RESTful service method to fetch available roles

GET

/user/{loginId}/roles

getUserRoles(java.lang.String loginId)

RESTful service method to fetch individual user's roles using user's loginId

POST

/user

pushUser(java.lang.String userJson)

RESTful service method to save new user - expects user details in json string

POST

/user/{loginId}

editUser(java.lang.String loginId, java.lang.String userJson)

RESTful service method to edit existing user - expects user details in json string

POST

/user/{loginId}/roles

pushUserRole(java.lang.String loginId, java.lang.String rolesJson)

RESTful service method to save user roles using user's login Id and details in roles Json string

GET

/user/{loginId}

getUser(String loginId)

RESTful service method to fetch one user

GET

/users

getUsers()

RESTful service method to fetch all users


*Multi-Language Functionality API List (in Casablanca release):

GET  /auxapi/languageSetting/user/{loginId}                    Gets login user language setting in Portal

PUT  /auxapi/languageSetting/user/loginId}                     Updates login user language setting in Portal

POST  /auxapi/language                                                          Adds a language option in Portal

DELETE  /auxapi/language                                                     Deletes a language option in Portal

GET  /auxapi/languages                                                          Gets all language options in Portal

  • No labels