---
id: user-create
title: "Create a user"
description: "Create a new user in your organization."
sidebar_label: "Create a user"
hide_title: true
hide_table_of_contents: true
api: eJzdWG1v2zYQ/ivEfdoAxXHe9kHAgKZph2UfuiB10AKuEZzFs8xWIlWScuIa+u/DkbItx84bkq3AvgiSeOI9d3ye44kLkOQyqyqvjIYUziyhJ4FC042oHVmhtJib2gpjc9TqB7JhDxLwmDtIh3DlyMIoAVORDYPnElLgT9MsTAYJOMpqq/wc0uECxoSW7Gntp5AOR80oAUvfa3L+rZFzSBfhUVmSkHpbUwKZ0Z605yGsqkJlwc3+V8eIF+CyKZXId35eEaRgxl8p85B0JhoClagKSGCirPPXGkvGVeD6vhvftZIcUmU5KK/I8exxhnRxJ2ODKYkwJMxE+CnFrM1NLW5Qe+GNiGkIOYsAnbdK55AA3WJZFfwKC7rtSUNvwlS9zJTQbIDd6TeMCx5/kfPTgm7Z3TodO73x8MudvTPEvu6me6fHrpE4f/d0v0p7ysl2HR8cHh03CeAMPdrd7uLYi6Kbel+5dH+/nO/F2fZqu1pOR1peKz1TfkeGP03JT8myI7YTqEU0bdnlzQpVB8LYmIJQQwKSJlgXfimaFSR+bJoEvPIBIes1qhyahgcsucpoF0l+2O/fsxRLeYsbdMLVWUbOTeqCsbyKQJWEBLTlUF6u1UioLTJsh7VJqt5dwpz81iTPEv4TVF7m9k1m55U3e0pnL5P6Lne6LgocL5f+tXT+uKjven4FkT9J0c6jr93uuePY1hLrumTKYebVjIErvbqtSMsYXVRfINcDKxq/e3Zhed7CPVhV4jS73PLIfbFXZFmeCZSYTZWmh8NsrZugs5mSdF+gtZ+S9m0FEEvjR4nUgspMrpU33DFgWTCk+3OytG1i1dgJ58Plh6dzuMvD3w8Oj35uxU6gJI8SPe4ObTl6T3yrEruadQHfaA4pzLCoQ+lfbwn87WW7C7SbwvHnz9t+zwpF2guy1lix2jaErIljVXqGhZJC6ar2wlhRKueUzkWFFkvyZN2rbRZR12dGsmQDHmYyOYc5be8GHevHd4U/B4OLZd3IjCRhqbLkmNU6D6l2FWVqojKRdfPxC/XyXiKO+32+HPDliC/Hv27sKsf9fsNJ2MCyYuMmlFPRinPPEkqWQesr4PJT9CJDT7mx6ge5iI3sjKyYoCpqSxueYYzyum21mdsxbU8AMbaKJomY1iXqNZKO1ZKDEVyoOm02vsBblOIyOv0C/OJKc5EIkOUX2ExO1xqa9Yo+DlJKxbdYCEkeVeEEjk3t17A2/bCC2lSEfqbEYmJsSVKE7GqPSpNcUbrL4KaJCjnZpZCPMf13FaK0DDzXeSgSztUkjA7gTi/OhVOS/mfScN1EtGQ4YWmc9A/5crS58Cc/TxUcrNVYXEej65iy/0wf56170VLnPdtEpfAblZG40jhDFbbBLcHs/Pxflc6pFrWm24oyT7INyWRZbS3JnrgoCB0Jb+cCc1RaFOh5Y2qWsinJTw2fEFTGMXUr5HMA2Oc9KJwUcBguHBTUtuj0PlipHncDVYGetRrbn9H6cOEjyyOyunvEsIqfJ2IPwYzLYTCCpL35w9gSPaTw16cBMFKW3eX6ZOL9eiNtfwh2/bRvNvKx495ouNtWeasz5mZ23UQ+0PHdaUraZkHpiWFonLy4rge9fq8P603+Qyd3XHVCM2ecLzEUlxbd6vynXY8NrizWFeo5B0Ux/Z5u/X5VoAptZFjbRbv6w9CBcHGaMinSISwWY3R0ZYum4dffa7J8eDRKYIZWxYZwOGoSmBKGZnS4bG/OIsK9AXtN2m4n3a6nTbL84jTLqPIP2o46vL34++OASdMeVpWhZoHFG67DeAMp8PKGjAUuhncLKFDndRAkxDmZYrjJ0DuMDFG1Q6jnHYSLRbQYmG+kmwaSNhTPz9CMmqb5BytL2YY=
sidebar_class_name: "post api-method"
info_path: docs/api/nullplatform-api
custom_edit_url: null
---

import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
import ParamsDetails from "@theme/ParamsDetails";
import RequestSchema from "@theme/RequestSchema";
import StatusCodes from "@theme/StatusCodes";
import OperationTabs from "@theme/OperationTabs";
import TabItem from "@theme/TabItem";
import Heading from "@theme/Heading";

<Heading
  as={"h1"}
  className={"openapi__heading"}
  children={"Create a user"}
>
</Heading>

<MethodEndpoint
  method={"post"}
  path={"/user"}
  context={"endpoint"}
>
  
</MethodEndpoint>



Create a new user in your organization.

<Heading
  id={"request"}
  as={"h2"}
  className={"openapi-tabs__heading"}
  children={"Request"}
>
</Heading>

<ParamsDetails
  parameters={undefined}
>
  
</ParamsDetails>

<RequestSchema
  title={"Body"}
  body={{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["email","first_name","last_name","organization_id"],"properties":{"email":{"description":"The email of the user you want to create.","type":"string","example":"alex.doe@email.com"},"first_name":{"description":"The first name of the user you want to create.","type":"string","example":"Alex"},"last_name":{"description":"The last name of the user you want to create.","type":"string","example":"Doe"},"organization_id":{"description":"The organization ID of the user you want to create.","type":"integer","example":1234},"avatar":{"description":"The avatar of the user you want to create.","type":"string","example":"https://my-avatar-url.com"},"send_invite":{"description":"Whether to send an invite email to the user.","type":"boolean","default":true,"example":true}},"title":"UserCreate"}}}}}
>
  
</RequestSchema>

<StatusCodes
  id={undefined}
  label={undefined}
  responses={{"200":{"description":"The operation was successful.","content":{"application/json":{"schema":{"type":"object","required":["id","nrn","email","first_name","last_name","organization_id"],"properties":{"id":{"type":"integer","description":"The ID of the user.","example":123456},"email":{"description":"The email of the user.","type":"string","example":"alex.mgr@crypto-inc.com"},"first_name":{"description":"The first name of the user.","type":"string","nullable":true,"example":"Alex"},"last_name":{"description":"The last name of the user.","type":"string","example":"Doe","nullable":true},"organization_id":{"description":"The organization ID of the user.","type":"integer","example":1234},"status":{"description":"The status of the user.","enum":["active","inactive","pending","invited"],"type":"string","example":"active"},"avatar":{"description":"The avatar of the user.","type":"string","nullable":true,"example":"https://my-avatar-url.com"},"type":{"description":"The type of the user.","enum":["person","machine"],"type":"string","example":"person"},"provider":{"description":"The authentication provider of the user.","type":"string","enum":["cognito","saml"],"nullable":true,"example":"cognito"},"nrn":{"description":"The NRN of the user.","type":"string","example":"organization=123"},"send_invite":{"description":"Whether to send an invite email to the user.","type":"boolean","default":true,"example":true},"metadata":{"description":"The metadata of the user.","type":"object","example":{"key":"value"}}},"title":"userResponse"}}}},"4XX":{"description":"Client error responses due to invalid input or missing parameters.","content":{"application/json":{"schema":{"type":"object","required":["statusCode","error","message"],"properties":{"statusCode":{"type":"integer","description":"HTTP status code representing the specific client error (e.g., 400, 401, 403, 404).","example":400},"code":{"type":"string","description":"A machine-readable error code that categorizes the server failure.","example":"bad_request"},"error":{"type":"string","description":"A brief, human-readable description of the error type (e.g., \"Bad Request\", \"Unauthorized\").","example":"Bad Request"},"message":{"type":"string","description":"Additional details about the error.","example":"The request was malformed or contained invalid parameters."}}}}}},"5XX":{"description":"Server error responses indicating an issue on the API side.","content":{"application/json":{"schema":{"type":"object","required":["statusCode","error","message"],"properties":{"statusCode":{"type":"integer","description":"HTTP status code representing the specific server error (e.g., 500, 502, 503).","example":500},"code":{"type":"string","description":"A machine-readable error code that categorizes the server failure.","example":"internal_server_error"},"error":{"type":"string","description":"A brief, human-readable description of the error type (e.g., \"Internal Server Error\", \"Service Unavailable\").","example":"Internal Server Error"},"message":{"type":"string","description":"Additional details about the error.","example":"An unexpected error occurred. Please try again later."}}}}}}}}
>
  
</StatusCodes>