mirror of
https://github.com/LukeHagar/developer.sailpoint.com.git
synced 2025-12-11 04:19:42 +00:00
45 lines
11 KiB
Plaintext
45 lines
11 KiB
Plaintext
---
|
|
id: create-user-profiles
|
|
sidebar_label: Create multiple user-profile contributor relationships
|
|
hide_title: true
|
|
hide_table_of_contents: true
|
|
api: eJytVttuEzEQ/RXLz01SegkQiYeCihQkoGpTXkpUze7OJoZde/Gl7WqVf2fGbtItKVW4pFK6ts94bmfOppOmQQteGT0t5ETmFsHjpUN7Zk2pKnRyTxbocqsaBhHkXYSIOlReNRWKQOBBk9AiN9pblQVvrLBYxYvdUjV8jYeFk5MryQaiWV8/35MWfwR0/q0pWjnp4lJZpHC8Dbgn+U7Uno+gaSqVx1tH3xyH00mXL7EGfvJtgxSgyb5h7skh+aDkvCIvdMpurzduH+BgLbSEVh5rt+M1qugBHWWsFwQsja2B4pQhEGAVLdnbrnCN1+BT+Xa26Rf5OqG3rVCHmitvbjVamSp63yU5X9EtXvmKLXqNl6v0YReuIQcp/YP9ff73mBKndw2VCguxhgpvBIgbqBTvxe7KP2ik0fi5pIC3e/FEoI7K8HvgB5PJ1TwlcvRU7G+hEOcpRDEQQUNWxfBzUxO7PQ7/b+BTHavygU2fi/sLo6KbU2uNdZskjp9KYkrxWQ2VuEB7Q9MVbSgdiz5YTY0xmlJbgi4qWuBdjtHS/VFyz88FssvtyE5Ejc7BAkXaz4iRwi9RJDxx8w640AS9MNa2wpka/ZJRtxSVuLWGKLzhIp8ZFqrGREo14Je0Gj0e7j3pYh1cbEWwFUGW3jduMhp1lCxo/wlqXA01NYy8mxZxSA0fQaPI+AasYhokNdjAU3IlkPCxbOQ15mZLHWcRLjThBTinFlx9plNwnjKznMqc48uDVb6NAWYIFu1J4FSu5v3jCy5+iqMP2vSCk+JsI4zWCUQ76eH9Wi1m5jtqCoO+37Qm2PQouaLc5/MHAT5dt2NLMK962icPS3h1XI6PBscvX7wcHB2PDwbZYZkPDvLX48NyPIYSxvKxAO5qs6WCuxo+IYX3ikezQ/quS8NpMS9Sr14M94f7vZn7dHr+UZycTbebSnxdH4octMjiay82FvKcCC5otERtClW2guljgmMxpFLTqVBaxKqjvlHE55qIzZNHs4YklhyUjvySH6ez2BRmdw26d/LXb91HmXQP0/4P7/FUWo93ftRUoFjI0pB19/N49Qt3iNFLnlc66LoMHF7aarXibeKd5SGYP0xdnAEyQCiodUy779hyvCnywYzdM7wK8fX9q2axqiaLk5x17lnsvCcpZ58vZjw69z9DqJtsY+GWuUXfE/mV/mhhknjG3yq838kK9CKQyBEm3cufn8tSQEM=
|
|
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 multiple user-profile contributor relationships' (create-user-profiles)"
|
|
---
|
|
|
|
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 multiple user-profile contributor relationships</h1>
|
|
|
|
<MethodEndpoint method={"post"} path={"/user_profiles"}></MethodEndpoint>
|
|
|
|
|
|
|
|
Create multiple user-profile contributor relationships
|
|
|
|
## 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_profiles</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"user_id"} required={false} schemaName={"uuid"} qualifierMessage={undefined} schema={{"type":"string","format":"uuid"}}></SchemaItem><SchemaItem collapsible={false} name={"profile_id"} required={false} schemaName={"uuid"} qualifierMessage={undefined} schema={{"type":"string","format":"uuid"}}></SchemaItem><SchemaItem collapsible={false} name={"ne_attribute_id"} required={false} schemaName={"uuid"} qualifierMessage={undefined} schema={{"type":"string","format":"uuid"}}></SchemaItem><SchemaItem collapsible={false} name={"relationship_type"} required={false} schemaName={"string"} qualifierMessage={"**Possible values:** [`owner`, `contributor`]"} schema={{"type":"string","enum":["owner","contributor"]}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></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"}}><div><span className={"badge badge--info"}>oneOf</span><SchemaTabs><TabItem label={"UserProfiles"} value={"0-item-properties"}><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>user_profiles</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><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={"user_id"} required={false} schemaName={"uuid"} qualifierMessage={undefined} schema={{"type":"string","format":"uuid"}}></SchemaItem><SchemaItem collapsible={false} name={"profile_id"} required={false} schemaName={"uuid"} qualifierMessage={undefined} schema={{"type":"string","format":"uuid"}}></SchemaItem><SchemaItem collapsible={false} name={"ne_attribute_id"} required={false} schemaName={"uuid"} qualifierMessage={undefined} schema={{"type":"string","format":"uuid"}}></SchemaItem><SchemaItem collapsible={false} name={"relationship_type"} required={false} schemaName={"string"} qualifierMessage={"**Possible values:** [`owner`, `contributor`]"} schema={{"type":"string","enum":["owner","contributor"]}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem></TabItem><TabItem label={"Job"} value={"1-item-properties"}><SchemaItem collapsible={false} name={"info"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"job has started"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>job_status</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"job_id"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"3ce88e47ad6dba2ddf349d21"}}></SchemaItem><SchemaItem collapsible={false} name={"status"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"queued"}}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={false} name={"status"} required={false} schemaName={"int"} qualifierMessage={undefined} schema={{"type":"int","example":200}}></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={"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> |