UserResource

Resource to get Users. The list of users returned will always be filtered by user permission: A user may only see users that are members of the same groups or subgroups of the groups, the user is member of

The following resources are applicable:

/user/list

Mount Point: /CNPortletapp/rest/user/list

GET

Get a list of users, optionally filtered, sorted and paged

Parameters

name description type default
skipCount number of elements to be skipped (paging) query 0
maxItems maximum number of elements returned (paging) query -1
id id(s) for filtering query
login login string(s) for filtering query
firstname firstname string(s) for filtering query
lastname lastname string(s) for filtering query
email email string(s) for filtering query
group group id(s) for filtering query
search additionally search in users logins, firstNames, lastNames and emails query
sortby name of an attribute to sort query
sortorder sort order query asc
groups true to add groups to the users, false (default) otherwise query false

Response Body

element: userListResponse
media types: */*
application/xml
application/json

list of users

/user/me

Mount Point: /CNPortletapp/rest/user/me

GET

Get the current user (me) By default, the user's groups are not returned.

Parameters

name description type default
groups Whether to list the user's groups query false

Response Body

element: userLoadResponse
media types: */*
application/xml
application/json

current user

/user/me/data

Mount Point: /CNPortletapp/rest/user/me/data

GET

Get complete user data

Response Body

element: userDataResponse
media types: application/json

Response containing the complete user data

/user/me/data/{key}

Mount Point: /CNPortletapp/rest/user/me/data/{key}

The following operations are supported on this resource:

POST

Save user data for the given key

Parameters

name description type default
key key of the user data to save path

Request Body

element: jsonData
media types: application/json

user data in JSON format

Response Body

element: genericResponse
media types: application/json

Generic response

GET

Get user data for the given key

Parameters

name description type default
key key of the user data path

Response Body

element: userDataResponse
media types: application/json

Response containing the value

DELETE

Delete the user data for the given key

Parameters

name description type default
key key of the user data path

Response Body

element: genericResponse
media types: application/json

Generic response

/user/save/{id}

Mount Point: /CNPortletapp/rest/user/save/{id}

POST

Saves the user into GCN.

Parameters

name description type default
id Id of the user to save. path

Request Body

element: userSaveRequest
media types: */*
application/xml
application/json

user save request

Response Body

element: genericResponse
media types: */*
application/xml
application/json

GenericResponse