mirror of
https://github.com/LukeHagar/developer.sailpoint.com.git
synced 2025-12-11 04:19:42 +00:00
49 lines
14 KiB
Plaintext
49 lines
14 KiB
Plaintext
---
|
|
id: post-profiles
|
|
sidebar_label: Create multiple profiles
|
|
hide_title: true
|
|
hide_table_of_contents: true
|
|
api: eJztVt9vGjkQ/lcsP0MgJNA7pHtITzmJ6tpEgd5LDqFhdxbc7tp7tpcEIf73zthZFrJpqkjt24EEu56x55tf33gnTYkWvDJ6ksqxLI3zt9ZkKkcnOzJFl1hVspiEf1oEj6Kocq/KHEXZKHpYOTm+l4eleUda/K9C59+bdCvHu/CqLJIVbyvsyMRoj9qzCMoyV0lA0fvi2NZOumSNBfCT35ZI1s3yCyaebJENwuwVWSHpwWKjCdbClhSVx8L9+AQNBR5pOW+VXsl9pz56wYKFSts6HZkZWwD5IKuKFDrPnKQznAdfuZe2oq4KDtlV4tUGaWGioX680eJvhPA4Q1soTXFP65ienK/SBcEknHq1+LGtEnUaV0pwnLcMVC7ndA7YZE22j51cGpMj6FAGGVDS5TiD3LFV8HTysvL4YnghTRXnEvLbk0C3AoyPUFAhBRk++sXh2AVHcxyCpxLBMkZBQWip9M9758PeoD/oyyZhDnNC0tJ9KmzxiRPekXUdL96wrTNFqttUnKzN1sqeLslY3uEYY7938GeHtgXmLftqNM1ChNIcvN9TmL3yHOTaEV7cB4FFVxrtYnYG/T7/nbb89WNJCDAVtarwRoDYQK54LTS4fEMvG403GVViu2iegXRUH99X+mCWcj+PTly+hPs9pOIuwhNdUWlY5gF6YrjgPJ79XNATHSLygbe+hvsf1gpmrq011h2cGL7kxITwWeoiMUW7oYyGPeSORV9ZTUkxmlxbg05zesHHBMNO9ybnXudGZJNtZFeiQOdghSKuL6mhhV+jiPpHnS2nxtqtcKZAv2atB0IlHqxhBqjrkGWmHj+BnPya3npHA8aFELiQhcrmJF17X7pxr7cjP0F7Lvf9maZckWGzRTyjXPegVLR5A1ZxBUQWOqhHv56oTUJSUDe1ht4sqAseEoI4U6048FxJlfPklGUv5owvqazy2wBwiWDRXlXsxf38WDzluEccx0qHNLBT7G1QYw4OSrQSH/6qx83MfEVNMOj3j62pbHyUHExO8V0zeq8bjm1G5X099ZoR0Rp28iKD34bZ6LI7fHf+rns5HA26y4ss6Q6S30cX2WgEGYxkM+GaQfbSTDoaPc2oCeOkNU3+nwS/ZhLwmFc6Mxxk7qVY3+dn/bP+EUV9ur77KK5uJ+1GoPauhSIBLZYoKhebAZKE+EAQE4nCpCrbCm45UzmeG1SeJBVKi1CpqDeK2r8gHmCiImpCmivNRUx+nMxCITMZFKCPJK9cQE+w7hr6e/XSGnuOi6pX5qCYuyO57J4o6PRCu2Z2orXdbgkOP9t8v+dlajXLfT9viCa0PW1ASKl7ud2+4pbBRFjdGVtm9bwKF9bnDM0zJO64SpjVX9WdHxHo7c10xmzxdOemZPAeCw98N6XfsfyXvvRi4qgIF3Ne38kc9KoiSiedeC5/vgH7KEF4
|
|
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 profiles' (post-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 profiles</h1>
|
|
|
|
<MethodEndpoint method={"post"} path={"/profiles"}></MethodEndpoint>
|
|
|
|
|
|
|
|
Create multiple profiles
|
|
|
|
## 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"}>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={"name"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string"}}></SchemaItem><SchemaItem collapsible={false} name={"profile_type_id"} required={false} schemaName={"uuid"} qualifierMessage={undefined} schema={{"type":"string","format":"uuid","required":true}}></SchemaItem><SchemaItem collapsible={false} name={"status"} required={false} schemaName={"string"} qualifierMessage={"**Possible values:** [`Active`, `Inactive`, `On Leave`, `Terminated`]"} schema={{"type":"string","enum":["Active","Inactive","On Leave","Terminated"],"required":true}}></SchemaItem><SchemaItem collapsible={false} name={"id_proofing_status"} required={false} schemaName={"string"} qualifierMessage={"**Possible values:** [`pending`, `pass`, `fail`]"} schema={{"type":"string","enum":["pending","pass","fail"]}}></SchemaItem><SchemaItem collapsible={false} name={"archived"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","default":false}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>attributes</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><SchemaItem name={"property name*"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string"}} collapsible={false} discriminator={false}></SchemaItem></div></details></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={"Profiles"} 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"}>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,"description":"The objects ID","example":"33f072dd-13b4-41e1-8ea0-16f2a59b57c8"}}></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,"description":"The objects UID","example":"profileUid"}}></SchemaItem><SchemaItem collapsible={false} name={"name"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"This is the name of the profile.","example":"Profile Name"}}></SchemaItem><SchemaItem collapsible={false} name={"profile_type_id"} required={false} schemaName={"uuid"} qualifierMessage={undefined} schema={{"type":"string","format":"uuid","description":"This is the ID of the profile type the profile belongs to","example":"33f072dd-13b4-41e1-8ea0-16f2a59b57c8"}}></SchemaItem><SchemaItem collapsible={false} name={"status"} required={false} schemaName={"string"} qualifierMessage={"**Possible values:** [`Active`, `Inactive`, `On Leave`, `Terminated`]"} schema={{"type":"string","enum":["Active","Inactive","On Leave","Terminated"],"description":"This is the status of the profile","example":"Active"}}></SchemaItem><SchemaItem collapsible={false} name={"id_proofing_status"} required={false} schemaName={"string"} qualifierMessage={"**Possible values:** [`pending`, `pass`, `fail`]"} schema={{"type":"string","enum":["pending","pass","fail"],"description":"This is the ID proofing staus of the profile","example":"pending"}}></SchemaItem><SchemaItem collapsible={false} name={"created_at"} required={false} schemaName={"date-time"} qualifierMessage={undefined} schema={{"type":"string","format":"date-time","description":"The date and time the profile was created","example":"2023-11-21T14:23:54.256-05:00"}}></SchemaItem><SchemaItem collapsible={false} name={"updated_at"} required={false} schemaName={"date-time"} qualifierMessage={undefined} schema={{"type":"string","format":"date-time","description":"The date and time the profile was updated","example":"2023-11-21T14:23:54.256-05:00"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>attributes</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
|
|
|
Attributes that belong to this profile.
|
|
|
|
</div><SchemaItem name={"property name*"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string"}} collapsible={false} discriminator={false}></SchemaItem></div></details></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> |