User management API
User management API provides basic means for users management.
Version: 0.0.1
BasePath:/v1
MIT license
https://opensource.org/licenses/MIT
Access
[ Jump to Models ]
Table of Contents
Creates user (createUser)
Consumes
This API call consumes the following media types via the request header:
Request body
Return type
Example data
Content-Type: application/json
{
"name" : "John"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
201
Created
User
Returns a user. (getUser)
Path parameters
userName (required)
Path Parameter — user identifier default: null
Return type
Example data
Content-Type: application/json
{
"name" : "John"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
user
User
Returns a list of users. (getUsers)
Return type
Example data
Content-Type: application/json
{
"items" : [ {
"name" : "John"
}, {
"name" : "Jane"
} ]
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
list of users
Users
Up
post /user/{userName}/credentials
Sets credentials (setCredentials)
Path parameters
userName (required)
Path Parameter — user identifier default: null
Consumes
This API call consumes the following media types via the request header:
Request body
Responses
204
no content
Validates credentials (validate)
Consumes
This API call consumes the following media types via the request header:
Request body
Return type
Example data
Content-Type: application/json
{
"valid" : true,
"userName" : "userName"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
validation result
ValidationResult
[ Jump to Methods ]
Table of Contents
User - UserAuth - UserCredentials - Users - ValidationResult -
valid (optional)
userName (optional)