LukeParke/developer.sailpoint.com
1
0
Fork 0
mirror of https://github.com/LukeHagar/developer.sailpoint.com.git synced 2025-12-10 04:19:42 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
e8c6d4aad70eef6d6870aafd342c04847f4cdba0
developer.sailpoint.com/docs/api/beta/create-identity-profile.api.mdx
darrell-thobe-sp e8c6d4aad7 merge main and fix conflicts
2024-03-06 16:17:34 -05:00

114 lines
47 KiB
Plaintext
Raw Blame History

---
id: create-identity-profile
sidebar_label: Create an Identity Profile
hide_title: true
hide_table_of_contents: true
api: eJztXG1z2zYS/isY3oc2GVPWi+W3LzeK7fTcSWKfbE/mzvFcIRKSkJCASpBxVI//++0uQIoUKdtxc9c2w+lMapPAYl+f3QUB33l6IRKeSq1OQ+/QCxLBU3EaCpXKdHme6KmMhLflhcIEiVzgOBh1OZeG2aGGccXy8cxN+KBGLNWfhGK3Mp2zs/FP/xkdvz19x3iWznWCI4FAIn7NZCJCGMoCHkUsRbKj81N6QNSbiHeAnZTPjHd47a2/M97Nlod0hUlf6XDpHd55+TLeYZpkYssLtEphFr7ii0UkA5J++6NB0e48E8xFzOltFJ1NYZU7L10uBIitJx9FkHpbJZLXnuKxwFUXCWoylcADzJUh/lvV2sXSpCL2Z0KhxkHuTEnglJ0eMz0F4QU7yxdwC5o0kWoGv4svPF5E+EiGvf5gZ0hM8PBMRUsr1/2W5aS26jt4+hX0OY73gJo1QIMYR/gCfmQhGugxylOdxByU7eFoP5WxqLFeXr7f7Q/8bs/vDi77vcPe7mG/39kZ9P+NHMU6lFPZxNIbblJmXwd/BG/AHHghDXrFjTjScazVcaqB64edJ48HYPqzuNBZEjT4UkXWu5oUKosiPsHFLcProSpY6Umuk6agWkn6dsmCzKQ6ZtOIpwwHsIXDApBV34IHl1gpRKsvTUMfWnSd+6rodoG6zEJlMcX/8cm7y9PLf6HS1haHGfm6lj9Eldu5DOYWZxIxFYlQAWAMogCsV9ZAQRjEtbG8zkJ1uVUMP2OxfnDQ2+/uD4Zh76DH93e7vWHY398ZDic7k/6gz71ScD/Mxj+ymCsfXRh1ykJpFhFfMlXCgGfw915GkeQxg/8jSN6jvy8SSUBe4kkCrs7AMUqBBY92dxodI5/PYOwmlC846HVhxaZYafDBr3Ogi7Or8dHJN3cfR7Z1HqA6ZqMATcaOAfWCVCdLAsy6S1QMzAxZmNyDVqk7CGnXPhyLaSLMfFxAayHrROtIcEXCTnkWgVdOeWTqOAnow+SUcZbTRLmQKJYqSohQhB0GbiGxVFkyUOEMnB2y+O0c6hzOgjlXM9CQIkU57ufcsImA9zEPRVktLmXnax3pzFYktVCqqwk8d2Ix1c0GjcOagNMTEWk1Q+tsQttyYA76ZYb2S9yMUpBukqWQyNRUzh6PMqHQYzapveLq1o9cMmFg3BicBrwRtZyTWdNTyXRObTxn8DLhyqBQpWD3eJLwJRCRUG2Zx5mvSf3uSdFSrqsKlykYq4QA1JMyQndNc3aPxVQqmWf0uo2N4GYBUrBihitrVvO2nol89cXSEtYV65WWqtYGPAjQWQtteWV7NKp7PcXzMCS6PDovcdxUvIySiQSOkiX7JJb+Zx5BjC64TAz6ONQnCTYISxaLFDAr5Q4scpgqs3234tGa1xM+WWXLs6Hqnr5dusySP6euyGHs3h7f7++K3f1uD34KupPuIOQ9PhzYlJiXgJcNVi6/P113uGJClU5tnAvHUqSefAkEKWssFjpJxzkSP8UMa+7CzaexMBBlp40Zq0COLJNhoxvJsHAioAXoicSaUtXu3sEwCLsHfVDjwTAcTvfCveFgEE5RsoQE2RSClRKVK5XxiNkZzVBZilE3rEnBG7UIYwHBL6ExwLI+REPU4/VUhdh1EAgLZp0U1nRlvjkXUOnACJeiVhBReGtjg7sxe611JYSI9/c3dany5v2enArWXmhlrLFB882445q+Gkte2za3bXPbNrdtc9s2t21z2za3bXPbNrdtc9s2t21z2za3bfP33DbvdLsNrRxka5WykyQBVnw2FmmWKEhpMlcZfX9mEx3Sd26pQDoZdr6miX4YpEKIXBkd6fAJUPVaKuHPEi6RQ0EsBzARc8lnGWIKiREQLMnc6jSuCmCgiU6PveIhGzv5jpwwFqGDT0CrOQiqDF3Z9j2fggGQm7RhWbEn+GQXvH5nurvDOZRovb3h5GDKB4PuwfDggDpcYQyfiaZkVl36J9xDkAGLNFQj8jdQCJRtoHtigBZ/ev4jGk9MFXZsIabjl6XiS7oFNdCro3O2s8ciqIQyes5na0pQ/tVFDYtAckv4DIoq2djk5vX68cnr0dWbS3gyPvnn1ckF/IS0avX7SIG3UlxqKpXm+pY4dgLcQl1mRATqwKrupaP6EgQCJC4PlPY3Q1s3zAUhzHCrN8wok2bTBHrocihR3HxJ2Y+yIzpbULHhxgVPoZSeIMLk5ePLUYCQ5L9xmnzJ5lCWi+RFh42K7GmxxsD8JRBikFYxdC2BaQahLOjUis5SpnQqg7Umf6XK9cyQI8mbslEwOIDzx/0Eqn2EZRKzHIWFtzgWnX2AZ6u5KneXJaWRSpcq5dBH2Oo70An2EgxwlMnUMAdHaC4DwKPycQVilWGf4O6tZYY2aXC3i2fmCXF3HgH8+CRa8eKzcMFHVYlFI7JGbiaHSK4sp8luVGGuPPDZVIoobGO3jd02dp8Yu+svx+77gHtLpU/DR4Ir5bYbMHnWSp+EvEfpfE/iN9t+WUNuYdvqSqSf31+6A4LYv35Z4O7DN6yPbCqvMT8q7GGfT7D8KIxVsQUySHq0EkwBiUR4SHyvOCZFWVUN6qu91tCGgYOqhhIRUDNhS50xDipLMqWQE262WKiFUT+kbM4BH6FnBH4tAlKfH/oLLVXaVpJtJdlmozYbfT/ZqK0k29htY/evGbsPVpIFVxQtrk4yWRzzZGk9zb1HaTmDASw/qbLajiZTrVcrSIwVNZZXrRy8Sb836U33ArET8p1wd3Aw7Qe7fT7c6+31Jjv9Pa+c669XcVwEWTWmSva2dnSfG5LPUMdlCpzLpFqH1e0/UG8ipghrCD1F3Qw6B5XeFLVj/6DhY4bW7C3u0bsKyVRqSLXSEWIajI1xbJKPlfhhbQa4qNiCtlHJlWQsgAoeoWGRjCUFL0oBdJOlP5qmIIoNlNzJilWkCqIMOCQkyD+W3XKJ386mWPMBBapgZ4DO37A6dSb6XZU8G6PEb1BihjvW+EWSFZX7sGl/9xSYTxAjLqyBN2z02m6HK3AAaAgsZhV1Z1uft/V5m+PbHP995Pi2Pm9jt43dv2bsfkV97qqhzfU5DHhyfQ5jO11W1FKvuT3X8P8t0ylUHAfk3kwHQZbQdnNeg4MSjICHdCwTFrmCuv7IuvIIinaMTBmqw/zwiO9OYR2CKbA4vcFTBLEAX0SJFtoQCnGc6G2vT8JDfrZtsAJlSQTD5mm6MIfb23dgZ7DvfYcvZCefqvRtJ9Dx9gSU24BbeMDAxigOoOvzdoEOWSaR6PwWKYm4tZM7FeEZsBftKT9IOT8QstQZYCOR2cLzT84R6TGwuIAu5AdDozvkeDX5QK6rJLr//bJYQhtkaVLfg6vBeAacrono2QMiuW9cYMluV695yCoNYZvXry12hsP67JXgCfQT9svHjz+/v3zBStcaDNbIQmJnAaF2Di5CQDjKvwLgJMpNic5mc2J8VPnOgoHHphEIzD6oCyHYdX6o5R1kiDFAOqkUJwlCEZx182NunVB8FhEmz85Kk+h44PzboKFtXpn3ghIldRRSFUftOh+U706sSkz4OMaJSA0iu17kcvGSXM9l4m85Nd9S84maebHGhVXtdWDP7QQQ/UiCR4a09ezFLT2/RA/bL3iCVNd5QE04Pqpfx4Lcas/mo0LPR3pVPj6o93TsuDqNWcxiBpJoFLJTFsy1NuLvjKHrYBhczzKIomezRWedfYoIv98tseTbJX3pQ01J/L2BwFDWmfgEczqVNBqqPRXakPyFLAsx/wt03CH7pSIzPb6G1IsjQx2YZ/OMC/q4oG8xwDj+bWZDx8JDfSAD4YB1gKOV/QkJHKMl3LO0GlGdyG/THEwNAbBKVMzi0P5yuAI49xOjFzi6GAMw7NEZU/e9EP+aiqN1v7oDYJWVbyasa7DOb6Qhq67pzfJbbGZhpv2zyYsSj1Z7Lngr6Vuj9AYk+fPg7h+EeC3SfI9I44pk3Lscr/620snqkLi9KOMuQa5H1UO34uqX4oobZPYO0OP3dPJrOrXrVuXLVr3uYxeh3NWjr1618Z7OAzdsbBO6doFl/8FLJMU1EXcPoOkWx/XGCxnuGsXGWxT5ds76/YT16wn/64sAN089n185cf/44fjq2fj6AfjGw+r5PSMAWFpz7Yw4wvor16HUd73xs8xcwL/wlrITdaDQ39u/hlY+u46EFhAVdHUE81gwl4L2yxaCp2j2LcRSHVPugajBhCeMJTSjq8YJBCmP+ERGQI++6OQrc0oRtpVCJMPfTVZcRbM3rzrsvWCgWzAWbl/gmSR491G7fYwLsPE5Qhk7zuGN4T3dTLlLiFnMIKgfw8BQGsAAUkaglRK5LjQ1O8WsPG8huKIIdKRfgIOfTfFTjEQP8J64FiCdcd9hQPUllFoJMhYRYTGOqzaqj9EGfPXnIlqg90CdAS1HGQffnl7WKAIxZSOio5PZtptktnEsEMENAes+g06v0/WpQUYI0yaNuSoRP9r4h/HWPfFu9RHqT/AX+yzMYMu8vcBNYpQusy283Sy59uqbJdB+z3FDBV7e3eEmIu4e3ONjSEO4Q3V9s9oYwN8wmmkzkSDxk8BNLPf1ysfLqavdqvpnOdyvsDPsBuWDY8t7PudnuFXrTdwfHIzt/lfCbxF84N9D7wP8h8luYd0NBtHzOy/fTYYxH4tLwnxDtep+QDHv7/8LImiAxg==
sidebar_class_name: "post api-method"
info_path: docs/api/beta/identitynow-beta-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 an Identity Profile' (create-identity-profile)"
---
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 an Identity Profile</h1>
<MethodEndpoint method={"post"} path={"/identity-profiles"}></MethodEndpoint>
This creates an Identity Profile
A token with ORG_ADMIN authority is required to call this API to create an Identity Profile.
## 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={false} name={"name"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"description":"Name of the Object","type":"string","example":"aName"}}></SchemaItem><SchemaItem collapsible={false} name={"description"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","nullable":true,"description":"The description of the Identity Profile.","example":"My custom flat file profile"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>owner</strong><span className={"openapi-schema__name"}> object</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__nullable"}>nullable</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
The owner of the Identity Profile.
</div><SchemaItem collapsible={false} name={"type"} required={false} schemaName={"string"} qualifierMessage={"**Possible values:** [`IDENTITY`]"} schema={{"type":"string","enum":["IDENTITY"],"description":"Type of the object to which this reference applies","example":"IDENTITY"}}></SchemaItem><SchemaItem collapsible={false} name={"id"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"ID of the object to which this reference applies","example":"2c9180835d191a86015d28455b4b232a"}}></SchemaItem><SchemaItem collapsible={false} name={"name"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Human-readable display name of the object to which this reference applies","example":"William Wilson"}}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={false} name={"priority"} required={false} schemaName={"int64"} qualifierMessage={undefined} schema={{"type":"integer","format":"int64","description":"The priority for an Identity Profile.","example":10}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>authoritativeSource</strong><span className={"openapi-schema__name"}> object</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__required"}>required</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
The authoritative source for this Identity Profile.
</div><SchemaItem collapsible={false} name={"type"} required={false} schemaName={"string"} qualifierMessage={"**Possible values:** [`SOURCE`]"} schema={{"type":"string","enum":["SOURCE"],"description":"Type of the object to which this reference applies","example":"SOURCE"}}></SchemaItem><SchemaItem collapsible={false} name={"id"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"ID of the object to which this reference applies","example":"2c9180835d191a86015d28455b4b232a"}}></SchemaItem><SchemaItem collapsible={false} name={"name"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Human-readable display name of the object to which this reference applies","example":"HR Active Directory"}}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={false} name={"identityRefreshRequired"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","default":false,"description":"True if a identity refresh is needed. Typically triggered when a change on the source has been made","example":true}}></SchemaItem><SchemaItem collapsible={false} name={"identityCount"} required={false} schemaName={"int32"} qualifierMessage={undefined} schema={{"type":"integer","description":"The number of identities that belong to the Identity Profile.","format":"int32","example":8}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>identityAttributeConfig</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"enabled"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"If the profile or mapping is enabled","example":true,"default":true}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>attributeTransforms</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={"identityAttributeName"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Name of the identity attribute","example":"email"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>transformDefinition</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
The seaspray transformation definition
</div><SchemaItem collapsible={false} name={"type"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The type of the transform definition.","example":"accountAttribute"}}></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 className={"openapi-schema__divider"}></span><span className={"openapi-schema__nullable"}>nullable</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
Arbitrary key-value pairs to store any metadata for the object
</div><SchemaItem name={"property name*"} required={false} schemaName={"any"} qualifierMessage={undefined} schema={{"type":"object","nullable":true,"description":"Arbitrary key-value pairs to store any metadata for the object","example":{"attributeName":"e-mail","sourceName":"MySource","sourceId":"2c9180877a826e68017a8c0b03da1a53"},"additionalProperties":true}} collapsible={false} discriminator={false}></SchemaItem></div></details></SchemaItem></div></details></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>identityExceptionReportReference</strong><span className={"openapi-schema__name"}> object</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__nullable"}>nullable</span></span></summary><div style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"taskResultId"} required={false} schemaName={"uuid"} qualifierMessage={undefined} schema={{"type":"string","format":"uuid","description":"The id of the task result","example":"2c918086795cd09201795d5f7d7533df"}}></SchemaItem><SchemaItem collapsible={false} name={"reportName"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"My annual report","description":"The name of the report"}}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={false} name={"hasTimeBasedAttr"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"description":"Indicates the value of requiresPeriodicRefresh attribute for the Identity Profile.","type":"boolean","default":true,"example":true}}></SchemaItem></ul></details></TabItem></MimeTabs><div><div><ApiTabs><TabItem label={"201"} value={"201"}><div>
The created Identity Profile
</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={"id"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"description":"System-generated unique ID of the Object","type":"string","example":"id12345","readOnly":true}}></SchemaItem><SchemaItem collapsible={false} name={"name"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"description":"Name of the Object","type":"string","example":"aName"}}></SchemaItem><SchemaItem collapsible={false} name={"created"} required={false} schemaName={"date-time"} qualifierMessage={undefined} schema={{"description":"Creation date of the Object","type":"string","format":"date-time","readOnly":true,"example":"2023-01-03T21:16:22.432Z"}}></SchemaItem><SchemaItem collapsible={false} name={"modified"} required={false} schemaName={"date-time"} qualifierMessage={undefined} schema={{"description":"Last modification date of the Object","type":"string","format":"date-time","readOnly":true,"example":"2023-01-03T21:16:22.432Z"}}></SchemaItem><SchemaItem collapsible={false} name={"description"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","nullable":true,"description":"The description of the Identity Profile.","example":"My custom flat file profile"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>owner</strong><span className={"openapi-schema__name"}> object</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__nullable"}>nullable</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
The owner of the Identity Profile.
</div><SchemaItem collapsible={false} name={"type"} required={false} schemaName={"string"} qualifierMessage={"**Possible values:** [`IDENTITY`]"} schema={{"type":"string","enum":["IDENTITY"],"description":"Type of the object to which this reference applies","example":"IDENTITY"}}></SchemaItem><SchemaItem collapsible={false} name={"id"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"ID of the object to which this reference applies","example":"2c9180835d191a86015d28455b4b232a"}}></SchemaItem><SchemaItem collapsible={false} name={"name"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Human-readable display name of the object to which this reference applies","example":"William Wilson"}}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={false} name={"priority"} required={false} schemaName={"int64"} qualifierMessage={undefined} schema={{"type":"integer","format":"int64","description":"The priority for an Identity Profile.","example":10}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>authoritativeSource</strong><span className={"openapi-schema__name"}> object</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__required"}>required</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
The authoritative source for this Identity Profile.
</div><SchemaItem collapsible={false} name={"type"} required={false} schemaName={"string"} qualifierMessage={"**Possible values:** [`SOURCE`]"} schema={{"type":"string","enum":["SOURCE"],"description":"Type of the object to which this reference applies","example":"SOURCE"}}></SchemaItem><SchemaItem collapsible={false} name={"id"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"ID of the object to which this reference applies","example":"2c9180835d191a86015d28455b4b232a"}}></SchemaItem><SchemaItem collapsible={false} name={"name"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Human-readable display name of the object to which this reference applies","example":"HR Active Directory"}}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={false} name={"identityRefreshRequired"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","default":false,"description":"True if a identity refresh is needed. Typically triggered when a change on the source has been made","example":true}}></SchemaItem><SchemaItem collapsible={false} name={"identityCount"} required={false} schemaName={"int32"} qualifierMessage={undefined} schema={{"type":"integer","description":"The number of identities that belong to the Identity Profile.","format":"int32","example":8}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>identityAttributeConfig</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"enabled"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"If the profile or mapping is enabled","example":true,"default":true}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>attributeTransforms</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={"identityAttributeName"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Name of the identity attribute","example":"email"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>transformDefinition</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
The seaspray transformation definition
</div><SchemaItem collapsible={false} name={"type"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The type of the transform definition.","example":"accountAttribute"}}></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 className={"openapi-schema__divider"}></span><span className={"openapi-schema__nullable"}>nullable</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
Arbitrary key-value pairs to store any metadata for the object
</div><SchemaItem name={"property name*"} required={false} schemaName={"any"} qualifierMessage={undefined} schema={{"type":"object","nullable":true,"description":"Arbitrary key-value pairs to store any metadata for the object","example":{"attributeName":"e-mail","sourceName":"MySource","sourceId":"2c9180877a826e68017a8c0b03da1a53"},"additionalProperties":true}} collapsible={false} discriminator={false}></SchemaItem></div></details></SchemaItem></div></details></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>identityExceptionReportReference</strong><span className={"openapi-schema__name"}> object</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__nullable"}>nullable</span></span></summary><div style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"taskResultId"} required={false} schemaName={"uuid"} qualifierMessage={undefined} schema={{"type":"string","format":"uuid","description":"The id of the task result","example":"2c918086795cd09201795d5f7d7533df"}}></SchemaItem><SchemaItem collapsible={false} name={"reportName"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"My annual report","description":"The name of the report"}}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={false} name={"hasTimeBasedAttr"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"description":"Indicates the value of requiresPeriodicRefresh attribute for the Identity Profile.","type":"boolean","default":true,"example":true}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"id\": \"id12345\",\n \"name\": \"aName\",\n \"created\": \"2023-01-03T21:16:22.432Z\",\n \"modified\": \"2023-01-03T21:16:22.432Z\",\n \"description\": \"My custom flat file profile\",\n \"owner\": {\n \"type\": \"IDENTITY\",\n \"id\": \"2c9180835d191a86015d28455b4b232a\",\n \"name\": \"William Wilson\"\n },\n \"priority\": 10,\n \"authoritativeSource\": {\n \"type\": \"SOURCE\",\n \"id\": \"2c9180835d191a86015d28455b4b232a\",\n \"name\": \"HR Active Directory\"\n },\n \"identityRefreshRequired\": true,\n \"identityCount\": 8,\n \"identityAttributeConfig\": {\n \"enabled\": true,\n \"attributeTransforms\": [\n {\n \"identityAttributeName\": \"email\",\n \"transformDefinition\": {\n \"type\": \"accountAttribute\",\n \"attributes\": {\n \"attributeName\": \"e-mail\",\n \"sourceName\": \"MySource\",\n \"sourceId\": \"2c9180877a826e68017a8c0b03da1a53\"\n }\n }\n }\n ]\n },\n \"identityExceptionReportReference\": {\n \"taskResultId\": \"2c918086795cd09201795d5f7d7533df\",\n \"reportName\": \"My annual report\"\n },\n \"hasTimeBasedAttr\": true\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"400"} value={"400"}><div>
Client Error - Returned if the request body is invalid.
</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={"detailCode"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"}}></SchemaItem><SchemaItem collapsible={false} name={"trackingId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>messages</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
Generic localized reason for error
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>causes</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
Plain-text descriptive reasons to provide additional detail to the text provided in the messages field
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"detailCode\": \"400.1 Bad Request Content\",\n \"trackingId\": \"e7eab60924f64aa284175b9fa3309599\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ]\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"401"} value={"401"}><div>
Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.
</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":"JWT validation failed: JWT is expired"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"error\": \"JWT validation failed: JWT is expired\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"403"} value={"403"}><div>
Forbidden - Returned if the user you are running as, doesn't have access to this end-point.
</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={"detailCode"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"}}></SchemaItem><SchemaItem collapsible={false} name={"trackingId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>messages</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
Generic localized reason for error
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>causes</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
Plain-text descriptive reasons to provide additional detail to the text provided in the messages field
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"detailCode\": \"400.1 Bad Request Content\",\n \"trackingId\": \"e7eab60924f64aa284175b9fa3309599\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ]\n}"} language={"json"}></ResponseSamples></TabItem><TabItem label={"403"} value={"403"}><p> An example of a 403 response object</p><ResponseSamples responseExample={"{\n \"detailCode\": \"403 Forbidden\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The server understood the request but refuses to authorize it.\"\n }\n ]\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"429"} value={"429"}><div>
Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again.
</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={"message"} required={false} schemaName={""} qualifierMessage={undefined} schema={{"description":"A message describing the error","example":" Rate Limit Exceeded "}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"message\": \" Rate Limit Exceeded \"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"500"} value={"500"}><div>
Internal Server Error - Returned if there is an unexpected error.
</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={"detailCode"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"}}></SchemaItem><SchemaItem collapsible={false} name={"trackingId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>messages</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
Generic localized reason for error
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>causes</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
Plain-text descriptive reasons to provide additional detail to the text provided in the messages field
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"detailCode\": \"400.1 Bad Request Content\",\n \"trackingId\": \"e7eab60924f64aa284175b9fa3309599\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ]\n}"} language={"json"}></ResponseSamples></TabItem><TabItem label={"500"} value={"500"}><p> An example of a 500 response object</p><ResponseSamples responseExample={"{\n \"detailCode\": \"500.0 Internal Fault\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"An internal fault occurred.\"\n }\n ]\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem></ApiTabs></div></div>
Reference in New Issue View Git Blame Copy Permalink