Create a human user
Creates one dormant human user after requiring instance-wide CREATE_USER authority. Creation does not issue a credential or create a role, grant, or authentication mapping.
x-api-key<token>
In: header
userId?string | null
Optional client-provided user UUID; generated by the server when omitted.
Example
"550e8400-e29b-41d4-a716-446655440000"Format
uuidemailstring
Unique, nonempty email address.
Example
"[email protected]"Length
1 <= length <= 255username?string | null
Optional unique username.
Example
"person"Length
length <= 100displayName?string | null
Optional human-facing display name.
Example
"Avery Person"Length
length <= 255labels?object | null
Optional labels for organization and filtering. At most 20 entries; keys and values contain at most 255 characters; keys use [a-z0-9._-].
Example
{"team":"search","region":"us-west"}Properties
properties <= 20Empty Object
Response Body
curl -X POST "https://loading/v1/users" \ -H "Content-Type: application/json" \ -d '{ "userId": "550e8400-e29b-41d4-a716-446655440000", "email": "[email protected]", "username": "person", "displayName": "Avery Person", "labels": { "team": "search", "region": "us-west" } }'{
"userId": "550e8400-e29b-41d4-a716-446655440000",
"email": "[email protected]",
"displayName": "John Doe",
"username": "johndoe",
"labels": {
"team": "platform"
},
"enrollmentSummary": {
"openEnrollmentExpiresAt": 1786752000000
},
"deletedAt": 1620200000000,
"deletedById": "8ef578ad-7f1e-4656-b48b-b1b4a9aaa1cb",
"createdAt": 1620000000000,
"updatedAt": 1620100000000,
"createdById": "e13e432a-5323-4484-a91d-b5969bc564d9",
"updatedById": "d8bc6076-4141-4a88-80b9-0eb31643066f"
}Empty
Empty
Empty
Empty
Empty
Empty