IMPORTANT: No additional bug fixes or documentation updates
will be released for this version. For the latest information, see the
current release documentation.
User
edit
IMPORTANT: This documentation is no longer updated. Refer to Elastic's version policy and the latest documentation.
User
editAn API user
Properties
edit-
builtin(boolean) - True if the user is a built-in read-only user
-
email(string) - The user's optional email address
-
full_name(string) - The user's optional full name
-
metadata(UserMetadata) - The users metadata
-
security(UserSecurity, required) - The user's security information
-
user_name(string, required) - The user's identifier
Example
edit{
"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"
}