Files
developer.sailpoint.com/docs/api/nerm/v1/post-user.api.mdx
2024-03-06 16:17:34 -05:00

45 lines
12 KiB
Plaintext

---
id: post-user
sidebar_label: Create a new user
hide_title: true
hide_table_of_contents: true
api: eJy9V21v2zYQ/isEP/ttWdI1BgrMWTPAw5oUibsvrWFQ0tlmI5EaSTk2DP/33pGSJddy5nTYHMAxxeO9P89RW65zMMJJrcYJH/JcW/fJguEdnoCNjcxpCzd+MyAcMMEUPLMiSDixsHz4mdPS8mmHG/i7AOtudLLhw61fSgOo15kCOjzWyoFytCXyPJWxt9v/asnCltt4CZmgX26TA9rU0VeIHRrKDXnpJFja9db/UUqJDBpS1hmpFrxz5NRhmJMl+OiYP97hsBZZnpKCGx3xHT7IhEzb9M61yQTGVkqcbagSry05TOGvFp/mWirXi3VGhoO9Y7ugioyKcAcY/1ymUJbvDkQcg7V+OSXzc1Gk5OD3kicc84aafh2e2/mE03ImkxcTUhQocNJMqYR5mdpYEr2Zv4W3UffNVXzRvfwlueqKQRJ1rwdRHF/CdTK/Bp8W6dLWvJww13zctJdtZrQ/C/pQsXXCFfaljI9iJ1eUovfSiijFSk/PrnqpvelBqQ5Np3oh1b/o3XC+JTpSvjC6yGdBZWt4J5T6c6w6d+B4kkklcUc4bWZervMeVpASHMOa7+pS8dA+/kMh2VwrGzB7MRjQv0MPbtc54hsSVokyp5GHViKV9MwzDv+fyeW8jkfKTLRKN6FcGGzRfg7T9yeohVvy4c8XuBTr5vJISzuzvYKb/kM2OY3IH4XUaTzQjrBudhIu+7ATHF1dJz2jUzrvm+mMtX7Css4owBz7bCbcjyvLDczBIERnqVCLQizaMvEdFroXezRctgHgRiTsIfQ567JCUWIIAzgYEIAOeq/pfq3gfo6pPu7wyqWx8tD6g47uOqfl/iIpb+bWGI0XgN00BHHVFsQY/TNKpOwRzArpxJ/BcAy4wihEt1YY2lKoBKvOYE21wJP2VcG9DFogk8eejViGjY2VKmdDhDViDmkvyDeZ7lEbs2FWZ+CWJPWMXrFno31RyxLSnq6uUuSDICDzfnlnsj586ytQGEQrXzqX22G/v8UYhXJ3iO5dT2Gd0KjeANAFoC9yiYdXwkiqfsDQXjzEVAFSxBnE+pjIvbi/1zBhrVxQ0qmLCuswIM/IU/IvLox0G+9gBMKAGRUUwedpc/uRch78aArtS0BBUbReDNdBCJ+EH79XYJroJ1DoBn6/2+jChJ8eIlTeh/pCeVtVoeboQIT+ZrYnv7bbU0V3R6zWvMCcd+Oo2//wwlCTW81hJS/th+/R7D17cko11xQwdU6o5k+9QW/Q8Obu9uEDG30ct87vapPFQrHIz3Nf+kDpDDHHMp3I+YZRg+nC0qjFYuAuk4r5uoBaSWz0DDueIIkgBBzFjSp8GE+8r9T2mVCNnbZXhwMntzXC298zQvUcrF0/T4UkXgrg2ZbwCu8gNJiWhDpcb7eRsPDJpLsdPcY2MtTT0xpEvqXxAFI4tRO2+xNsyIPgS3cS7r9IhgVZP2Ie4sZwYuQnx4uy0wYxfLx/nBASyrckTD2dMeKZBgp+D/kX/MOFDhToX6Xo+ZbXQ4UHvfT5Bhgywh8=
sidebar_class_name: "post api-method"
info_path: docs/api/nerm/v1/nerm-api
custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Create a new user' (post-user)"
---
import ApiTabs from "@theme/ApiTabs";
import DiscriminatorTabs from "@theme/DiscriminatorTabs";
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes";
import MimeTabs from "@theme/MimeTabs";
import ParamsItem from "@theme/ParamsItem";
import ResponseSamples from "@theme/ResponseSamples";
import SchemaItem from "@theme/SchemaItem";
import SchemaTabs from "@theme/SchemaTabs";
import TabItem from "@theme/TabItem";
<h1 className={"openapi__heading"}>Create a new user</h1>
<MethodEndpoint method={"post"} path={"/user"}></MethodEndpoint>
Create a new user
## Request
<MimeTabs className={"openapi-tabs__mime"}><TabItem label={"application/json"} value={"application/json-schema"}><details style={{}} className={"openapi-markdown__details mime"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-mime"}><h3 className={"openapi-markdown__details-summary-header-body"}>Body</h3><strong className={"openapi-schema__required"}>required</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>user</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"name"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","required":true,"description":"The user name","example":"Bob"}}></SchemaItem><SchemaItem collapsible={false} name={"email"} required={false} schemaName={"email"} qualifierMessage={undefined} schema={{"type":"string","format":"email","required":true,"description":"The user email","example":"test@sailpoint.com"}}></SchemaItem><SchemaItem collapsible={false} name={"type"} required={false} schemaName={"string"} qualifierMessage={"**Possible values:** [`NeprofileUser`, `NeaccessUser`]"} schema={{"type":"string","enum":["NeprofileUser","NeaccessUser"],"default":"NeprofileUser","description":"The user type","example":"NeprofileUser"}}></SchemaItem><SchemaItem collapsible={false} name={"profile_id"} required={false} schemaName={"uuid"} qualifierMessage={undefined} schema={{"type":"string","format":"uuid","description":"The user profile id","example":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e"}}></SchemaItem><SchemaItem collapsible={false} name={"title"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The user description","example":"my_user_title"}}></SchemaItem><SchemaItem collapsible={false} name={"status"} required={false} schemaName={"string"} qualifierMessage={"**Possible values:** [`Active`, `Disabled`]"} schema={{"type":"string","enum":["Active","Disabled"],"required":true,"description":"The user status","example":"Active"}}></SchemaItem><SchemaItem collapsible={false} name={"login"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","required":true,"description":"The user login","example":"my_user"}}></SchemaItem><SchemaItem collapsible={false} name={"group_strings"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The user group strings","example":"Administrator_group,Developer_group"}}></SchemaItem></div></details></SchemaItem></ul></details></TabItem></MimeTabs><div><div><ApiTabs><TabItem label={"200"} value={"200"}><div>
Expected response to a valid request
</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>user</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"id"} required={false} schemaName={"uuid"} qualifierMessage={undefined} schema={{"type":"string","format":"uuid","readonly":true}}></SchemaItem><SchemaItem collapsible={false} name={"uid"} required={false} schemaName={"string"} qualifierMessage={"**Possible values:** `>= 32 characters` and `<= 32 characters`"} schema={{"type":"string","minLength":32,"maxLength":32,"readonly":true}}></SchemaItem><SchemaItem collapsible={false} name={"name"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string"}}></SchemaItem><SchemaItem collapsible={false} name={"email"} required={false} schemaName={"email"} qualifierMessage={undefined} schema={{"type":"string","format":"email"}}></SchemaItem><SchemaItem collapsible={false} name={"type"} required={false} schemaName={"string"} qualifierMessage={"**Possible values:** [`NeprofileUser`, `NeaccessUser`]"} schema={{"type":"string","enum":["NeprofileUser","NeaccessUser"],"default":"NeprofileUser"}}></SchemaItem><SchemaItem collapsible={false} name={"title"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string"}}></SchemaItem><SchemaItem collapsible={false} name={"status"} required={false} schemaName={"string"} qualifierMessage={"**Possible values:** [`Active`, `Disabled`]"} schema={{"type":"string","enum":["Active","Disabled"]}}></SchemaItem><SchemaItem collapsible={false} name={"login"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string"}}></SchemaItem><SchemaItem collapsible={false} name={"last_login"} required={false} schemaName={"date-time"} qualifierMessage={undefined} schema={{"type":"string","format":"date-time","readOnly":true}}></SchemaItem><SchemaItem collapsible={false} name={"cookies_accepted_at"} required={false} schemaName={"date-time"} qualifierMessage={undefined} schema={{"type":"string","format":"date-time","readOnly":true}}></SchemaItem><SchemaItem collapsible={false} name={"preferred_language"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string"}}></SchemaItem></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"user\": {\n \"id\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n \"uid\": \"string\",\n \"name\": \"string\",\n \"email\": \"user@example.com\",\n \"type\": \"NeprofileUser\",\n \"title\": \"string\",\n \"status\": \"Active\",\n \"login\": \"string\",\n \"last_login\": \"2024-03-06T21:09:31.788Z\",\n \"cookies_accepted_at\": \"2024-03-06T21:09:31.788Z\",\n \"preferred_language\": \"string\"\n }\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"400"} value={"400"}><div>
Bad Request - unable to complete.
</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><div><span className={"badge badge--info"}>oneOf</span><SchemaTabs><TabItem label={"InvalidJson"} value={"0-item-properties"}><SchemaItem collapsible={false} name={"error"} required={false} schemaName={""} qualifierMessage={undefined} schema={{"example":"Invalid JSON syntax. Please check your syntax and try again."}}></SchemaItem></TabItem><TabItem label={"ValidationErrors"} value={"1-item-properties"}><SchemaItem collapsible={false} name={"error"} required={false} schemaName={""} qualifierMessage={undefined} schema={{"example":"The <object> failed to create/update"}}></SchemaItem><SchemaItem collapsible={false} name={"errors"} required={false} schemaName={""} qualifierMessage={undefined} schema={{"example":{"attribute":"can't be blank"}}}></SchemaItem></TabItem></SchemaTabs></div></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"500"} value={"500"}><div>
Internal Server Error - returned on unhandled exceptions.
</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"error"} required={false} schemaName={""} qualifierMessage={undefined} schema={{"description":"A message describing the error","example":"Sorry something went wrong"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"error\": \"Sorry something went wrong\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem></ApiTabs></div></div>