UserResource

REST end point for manipulating individual internally managed users.

The following resources are part of this group:

/security/user

Mount Point: /api/security/user

POST

This end point will add a new administrative user to the internally managed users authentication provider.

Request Body

element: user
media types: application/xml

this end point expects a single user element element containing the details and credentials of the user to be added

Status Codes

code description
202 Accepted
400 The given user is invalid
401 Authentication required
403 Authorization required - access forbidden
500 Internal server error

/security/user/{userName}

Mount Point: /api/security/user/{userName}

The following operations are supported on this resource:

GET

This end point will return the administrative user with the given user name.

Parameters

name description type default
userName an ID that uniquely identifies an internally managed user path

Response Body

element: user
media types: application/xml

this end point returns a single user element

Status Codes

code description
200 Ok
404 User not found
401 Authentication required
403 Authorization required - access forbidden
500 Internal server error

DELETE

This end point will delete the internally managed user with the given user name.

Parameters

name description type default
userName an ID that uniquely identifies an internally managed user path

Status Codes

code description
202 Accepted
404 User not found
400 The given user is invalid
401 Authentication required
403 Authorization required - access forbidden
500 Internal server error

PUT

This end point will update the administrative user with the given user name.

Request Body

element: user
media types: application/xml

this end point expects a single user element element containing the details and optionally, the credentials, of the user to be updated

Status Codes

code description
202 Accepted
400 The given user is invalid
404 User not found
401 Authentication required
403 Authorization required - access forbidden
500 Internal server error