A newer version is available. For the latest information, see the
current release documentation.
Creates a new useredit
Creates a new user.
Requestedit
POST /api/v1/users
Responsesedit
-
200 -
(
User) User successfully created -
400 -
(
BasicFailedReply) Invalid request. (code: 'user.bad_request') -
403 -
(
BasicFailedReply) Invalid permissions -
409 -
(
BasicFailedReply) User name already in use. (code: 'user.user_name.conflict') -
449 -
(
BasicFailedReply) Elevated permissions are required. (code: 'root.unauthorized.rbac.elevated_permissions_required')
To perform this operation, you must be authenticated by means of one of the following methods: apiKey, basicAuth.
Request exampleedit
curl -XPOST {{hostname}}/api/v1/users \
-H "Authorization: ApiKey $ECE_API_KEY" \
-H 'Content-Type: application/json' \
-d '
{
"builtin" : true,
"email" : "string",
"full_name" : "string",
"metadata" : {
"created_at" : "2019-01-01T00:00:00Z",
"created_by" : "string",
"first_login_at" : "2019-01-01T00:00:00Z",
"last_login_at" : "2019-01-01T00:00:00Z",
"updated_at" : "2019-01-01T00:00:00Z",
"updated_by" : "string"
},
"security" : {
"elevated_permissions" : {
"enabled" : true,
"expires_at" : "2019-01-01T00:00:00Z"
},
"enabled" : true,
"password" : "string",
"permissions" : [
"string"
],
"roles" : [
"string"
],
"security_realm" : {
"id" : "string",
"type" : "string"
}
},
"user_name" : "string"
}
'