Users

The following resources are applicable:

/users

Mount Point: /v2/users

GET

Returns the list of all the users associated to the account of the currently connected user.

Response Body

element: usersResult
media types: application/xml
application/json

The list of requested User objects.

POST

Creates a new User based on the information provided in UserCreator parameter.

Request Body

element: userCreator
media types: application/xml

Provides the information for the new User to be created.

Response Body

element: user
media types: application/xml

The newly created User object.

/users/{userId}

Mount Point: /v2/users/{userId}

The following operations are supported on this resource:

GET

Returns the User specified by the "id" path parameter.

Parameters

name description type default
userId The id of the User requested. path

Response Body

element: user
media types: application/xml
application/json

The requested User object.

PUT

Updates the User specified by the "id" path parameter based on the information provided in the User parameter.

Parameters

name description type default
userId The id of the User to be updated. path

Request Body

element: user
media types: application/xml

(no documentation provided)

Response Body

element: user
media types: application/xml

The updated user.

DELETE

Deletes the User specified by the "id" path parameter.

Parameters

name description type default
userId The id of the User to be deleted. path

/users/{userId}/unlock

Mount Point: /v2/users/{userId}/unlock

POST

Unlock a User based on the userId provided in the path request.

Parameters

name description type default
userId The userId that refer to the user to unlock. path

Response Body

element: user
media types: application/xml
application/json

The user unlocked.

/users/findByName

Mount Point: /v2/users/findByName

GET

Returns the User specified by the "username" query parameter.

Parameters

name description type default
username The username of the User requested. query

Response Body

element: user
media types: application/xml
application/json

The requested User object.