create User
POST {{baseUrl}}/api/user
Creates a user. You can optionally specify an Id for the user, if not provided one will be generated.
Request Body
{"applicationId"=>"<uuid>", "currentPassword"=>"<string>", "disableDomainBlock"=>"<boolean>", "sendSetPasswordEmail"=>"<boolean>", "skipVerification"=>"<boolean>", "user"=>{"preferredLanguages"=>["<string>", "<string>"], "active"=>"<boolean>", "birthDate"=>"9181-63-65", "cleanSpeakId"=>"<uuid>", "email"=>"<string>", "expiry"=>"<long>", "firstName"=>"<string>", "fullName"=>"<string>", "imageUrl"=>"<string>", "insertInstant"=>"<long>", "lastName"=>"<string>", "lastUpdateInstant"=>"<long>", "middleName"=>"<string>", "mobilePhone"=>"<string>", "parentEmail"=>"<string>", "tenantId"=>"<uuid>", "timezone"=>"wwwwww/wwww", "twoFactor"=>{"methods"=>[{"authenticator"=>{"algorithm"=>"HmacSHA256", "codeLength"=>"<integer>", "timeStep"=>"<integer>"}, "email"=>"<string>", "id"=>"<string>", "lastUsed"=>"<boolean>", "method"=>"<string>", "mobilePhone"=>"<string>", "secret"=>"<string>"}, {"authenticator"=>{"algorithm"=>"HmacSHA1", "codeLength"=>"<integer>", "timeStep"=>"<integer>"}, "email"=>"<string>", "id"=>"<string>", "lastUsed"=>"<boolean>", "method"=>"<string>", "mobilePhone"=>"<string>", "secret"=>"<string>"}], "recoveryCodes"=>["<string>", "<string>"]}, "memberships"=>[{"groupId"=>"<uuid>", "id"=>"<uuid>", "insertInstant"=>"<long>", "user"=>{"value"=>"<Circular reference to #/components/schemas/User detected>"}, "userId"=>"<uuid>"}, {"groupId"=>"<uuid>", "id"=>"<uuid>", "insertInstant"=>"<long>", "user"=>{"value"=>"<Circular reference to #/components/schemas/User detected>"}, "userId"=>"<uuid>"}], "registrations"=>[{"preferredLanguages"=>["<string>", "<string>"], "tokens"=>{"Excepteur25c"=>"<string>", "nulla_485"=>"<string>", "consectetur4c6"=>"<string>"}, "applicationId"=>"<uuid>", "authenticationToken"=>"<string>", "cleanSpeakId"=>"<uuid>", "id"=>"<uuid>", "insertInstant"=>"<long>", "lastLoginInstant"=>"<long>", "lastUpdateInstant"=>"<long>", "timezone"=>"wwwww/www", "username"=>"<string>", "usernameStatus"=>"REJECTED", "verified"=>"<boolean>", "verifiedInstant"=>"<long>"}, {"preferredLanguages"=>["<string>", "<string>"], "tokens"=>{"occaecat_0"=>"<string>"}, "applicationId"=>"<uuid>", "authenticationToken"=>"<string>", "cleanSpeakId"=>"<uuid>", "id"=>"<uuid>", "insertInstant"=>"<long>", "lastLoginInstant"=>"<long>", "lastUpdateInstant"=>"<long>", "timezone"=>"ww/www", "username"=>"<string>", "usernameStatus"=>"REJECTED", "verified"=>"<boolean>", "verifiedInstant"=>"<long>"}], "breachedPasswordLastCheckedInstant"=>"<long>", "breachedPasswordStatus"=>"SubAddressMatch", "connectorId"=>"<uuid>", "encryptionScheme"=>"<string>", "factor"=>"<integer>", "id"=>"<uuid>", "lastLoginInstant"=>"<long>", "password"=>"<string>", "passwordChangeReason"=>"Administrative", "passwordChangeRequired"=>"<boolean>", "passwordLastUpdateInstant"=>"<long>", "salt"=>"<string>", "uniqueUsername"=>"<string>", "username"=>"<string>", "usernameStatus"=>"PENDING", "verified"=>"<boolean>", "verifiedInstant"=>"<long>"}, "eventInfo"=>{"deviceDescription"=>"<string>", "deviceName"=>"<string>", "deviceType"=>"<string>", "ipAddress"=>"<string>", "location"=>{"city"=>"<string>", "country"=>"<string>", "latitude"=>"<double>", "longitude"=>"<double>", "region"=>"<string>", "zipcode"=>"<string>", "displayString"=>"<string>"}, "os"=>"<string>", "userAgent"=>"<string>"}}
HEADERS
Key | Datatype | Required | Description |
---|---|---|---|
X-FusionAuth-TenantId | string | The unique Id of the tenant used to scope this API request. Only required when there is more than one tenant and the API key is not tenant-scoped. | |
Content-Type | string | ||
Accept | string |
RESPONSES
status: OK
{"emailVerificationId":"\u003cstring\u003e","emailVerificationOneTimeCode":"\u003cstring\u003e","registrationVerificationIds":{"ea_e5e":"\u003cstring\u003e","anim58a":"\u003cstring\u003e","in_3a3":"\u003cstring\u003e","Ut_4e4":"\u003cstring\u003e"},"registrationVerificationOneTimeCodes":{"laborum_31":"\u003cstring\u003e","ind":"\u003cstring\u003e"},"token":"\u003cstring\u003e","tokenExpirationInstant":"\u003clong\u003e","user":{"preferredLanguages":["\u003cstring\u003e","\u003cstring\u003e"],"active":"\u003cboolean\u003e","birthDate":"7537-67-07","cleanSpeakId":"\u003cuuid\u003e","data":{"esse66":{},"et_5e":{}},"email":"\u003cstring\u003e","expiry":"\u003clong\u003e","firstName":"\u003cstring\u003e","fullName":"\u003cstring\u003e","imageUrl":"\u003cstring\u003e","insertInstant":"\u003clong\u003e","lastName":"\u003cstring\u003e","lastUpdateInstant":"\u003clong\u003e","middleName":"\u003cstring\u003e","mobilePhone":"\u003cstring\u003e","parentEmail":"\u003cstring\u003e","tenantId":"\u003cuuid\u003e","timezone":"wwwwwwww/wwwwwwwww","twoFactor":{"methods":[{"authenticator":{"algorithm":"HmacSHA256","codeLength":"\u003cinteger\u003e","timeStep":"\u003cinteger\u003e"},"email":"\u003cstring\u003e","id":"\u003cstring\u003e","lastUsed":"\u003cboolean\u003e","method":"\u003cstring\u003e","mobilePhone":"\u003cstring\u003e","secret":"\u003cstring\u003e"},{"authenticator":{"algorithm":"HmacSHA512","codeLength":"\u003cinteger\u003e","timeStep":"\u003cinteger\u003e"},"email":"\u003cstring\u003e","id":"\u003cstring\u003e","lastUsed":"\u003cboolean\u003e","method":"\u003cstring\u003e","mobilePhone":"\u003cstring\u003e","secret":"\u003cstring\u003e"}],"recoveryCodes":["\u003cstring\u003e","\u003cstring\u003e"]},"memberships":[{"data":{"enim_56":{}},"groupId":"\u003cuuid\u003e","id":"\u003cuuid\u003e","insertInstant":"\u003clong\u003e","user":{"value":"\u003cCircular reference to #/components/schemas/User detected\u003e"},"userId":"\u003cuuid\u003e"},{"data":{"elit_3":{},"consequat_cd":{},"ullamcoa2b":{}},"groupId":"\u003cuuid\u003e","id":"\u003cuuid\u003e","insertInstant":"\u003clong\u003e","user":{"value":"\u003cCircular reference to #/components/schemas/User detected\u003e"},"userId":"\u003cuuid\u003e"}],"registrations":[{"data":{"dolore_a85":{},"pariatur168":{},"dolor_c":{}},"preferredLanguages":["\u003cstring\u003e","\u003cstring\u003e"],"tokens":{"idf4":"\u003cstring\u003e","proident_4a_":"\u003cstring\u003e"},"applicationId":"\u003cuuid\u003e","authenticationToken":"\u003cstring\u003e","cleanSpeakId":"\u003cuuid\u003e","id":"\u003cuuid\u003e","insertInstant":"\u003clong\u003e","lastLoginInstant":"\u003clong\u003e","lastUpdateInstant":"\u003clong\u003e","timezone":"wwwwwwwwww/wwwwwwwwwww","username":"\u003cstring\u003e","usernameStatus":"REJECTED","verified":"\u003cboolean\u003e","verifiedInstant":"\u003clong\u003e"},{"data":{"qui_77d":{}},"preferredLanguages":["\u003cstring\u003e","\u003cstring\u003e"],"tokens":{"est_e":"\u003cstring\u003e","non6be":"\u003cstring\u003e"},"applicationId":"\u003cuuid\u003e","authenticationToken":"\u003cstring\u003e","cleanSpeakId":"\u003cuuid\u003e","id":"\u003cuuid\u003e","insertInstant":"\u003clong\u003e","lastLoginInstant":"\u003clong\u003e","lastUpdateInstant":"\u003clong\u003e","timezone":"wwww/wwwww","username":"\u003cstring\u003e","usernameStatus":"REJECTED","verified":"\u003cboolean\u003e","verifiedInstant":"\u003clong\u003e"}],"breachedPasswordLastCheckedInstant":"\u003clong\u003e","breachedPasswordStatus":"ExactMatch","connectorId":"\u003cuuid\u003e","encryptionScheme":"\u003cstring\u003e","factor":"\u003cinteger\u003e","id":"\u003cuuid\u003e","lastLoginInstant":"\u003clong\u003e","password":"\u003cstring\u003e","passwordChangeReason":"Administrative","passwordChangeRequired":"\u003cboolean\u003e","passwordLastUpdateInstant":"\u003clong\u003e","salt":"\u003cstring\u003e","uniqueUsername":"\u003cstring\u003e","username":"\u003cstring\u003e","usernameStatus":"PENDING","verified":"\u003cboolean\u003e","verifiedInstant":"\u003clong\u003e"}}