LukeParke/developer.sailpoint.com
1
0
Fork 0
mirror of https://github.com/LukeHagar/developer.sailpoint.com.git synced 2025-12-11 04:19:42 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
ad727a2d67247b2eb97e69ea22fb548da334f9cb
developer.sailpoint.com/docs/api/beta/export-identity-profiles.api.mdx
darrell-thobe-sp ad727a2d67 test embbeding
2024-03-06 15:22:04 -05:00

115 lines
51 KiB
Plaintext
Raw Blame History

---
id: export-identity-profiles
sidebar_label: Export Identity Profiles
hide_title: true
hide_table_of_contents: true
api: eJztPGtz2za2fwXD/dBWI8qSLD9n7txRZNlV17a8ktzcrptxIRKS0FAkS5BxtB7/93vOAfiQSL+SbLfJ6ksik8DBeb8I4N4KQhHxWAb+wLWOLfExDKJ44Ao/lvHqKgpm0hPKqlsxnyvr+MZKX7Hs3bu65QrlRDJEKABjspCKaUD4v1Sx9OdMphNDM5FJn8ULwWZBtOQxU6Fw5EwKl01X9FyFthP4MzlnSkQfpCMagEbII74UsYgQmXtL4np/JCJawTsf3sCfnlzK2NpE6oJ/ZH6ynIqIBTMWCZV4gF0cwM84ifzGr/5YCHbz8y7rXg3YOOa+yyOX9QLPEw7CYFfZ0u++X8RxqI53dlzxQXjIwYbi0gsD6ccNJ1juSNff4aHcUQYOUJLCsXMSfkDa2TKIBPBCswEGIJmR+CORkQCJzLinRB3kwpehB+S195p1SzkLseTW8b0Vr0KkGdYVcxHBTA1GP9ptw4Ol9OUyWVrHMG/JP+rfBMUVMw5coL8eHurV3AxmMyXK7BzSY0AbOEhCTDzPcBXEFTfYtUq4560KYr2T8YLVSDo1ZHzI59LnsYD5UZDMFwTHCOarEcdnCCNj/+PMd4LEL/N+MGO1OEpEjckYuAqMD4Mw8TQrBav9nz0JYu7ZPZxdQ5aGga8EWwjugvqTHHBghTkswBDvgsQDIxTGMkBycpbJDfjHalonauxOIKvmPnDMBYmBzKTv4DwgQxs9B0EDKowIYQ732YJ/EPAYZETMwfFyGXInriM14DgiARJbCt+Fhf0gRk1RAletEZD/IcpriBNh+4F7idBcwNGAdqJSbL4KDUJ6KpRoGgSe4L5V0BOa+aiugE8lt1gBS8URCMN62FSkU5qSST9RKDJyvSm31MqPwXHqaVNUBf9PZunfNF2AmW3w/AFle5o+RZVRSYjBBtBD9uuY4nnBHb4G1+O5ivRWR7ogUscIoVaTbq12zGrijzrzRU0/Q2aWn4aRDCKIXcU3VkGGlnSZ+IMdOq2jptg/ODzgvCPcI37UnLpH7t5up7PX3p1NrcdkpxD7J2VX8CVoHtxWAnkENJfFOgZof3GhIsGbIh3rZy8TKMgB5AeCAIh1lstnTSr00k5fWg/v0A61M1TI4nazif+tc+8c8hX0iTqBYcH0d0Bfaa9ZymHQtCFJieExQuJh6EmHjH7nd4Xg7ssS5VHEUfYyFktVeK5XKnv7jYTLIAa8ySYANiCJWGqqPgCDpV67FJAy3rQ2l/lZz2LAbw2XzaJgSbyPeTQXcZ6FgcIp4c2eR30Mo9jUC5z3JEfw84T4zgYFjRIJGmzZBjY48wi87xQ7mQwZTm4wPQiVykmiCFgJOUngwz9hoJSceiKPh4OT/uVkMPnldvjmp35vctsbXp4Ozur586vR8HRw3q+z0TX+Ox5ej3rw/2TUvRyfDkcXdXIzk9Hg7Kw/uh1fvxn3RoOryWB4mfIUcSKlET5mATdWt9frj8cpZHhhHoz6/7juj1Mc8PlkAiB/uezd6mULb64nP94OR/iz17246g7OLm8B2KQ/gieI1u1J/3RwOUA84MnZ8Of+6LJ7CSDORsPrK3hUTXjxRY7f+eC03/uld96/HU+6E3xyOZwMTge9LsK/nfQvrs7186vuePx2ODq5vRqeD3q/FJ8QHenqV9dv4P2tWWvQH+frj4a0JrIb/hv3zy5gDP0a/TwAAk7647/fDi4n/bNR15A3HhYW1KyCH5MugssERb/LUoLHgN7fT8+Hb7GqyR2JgQOKL93P0svBSWPNQ7Wdo9Zh83B3z20dtfjhfrO157YPO3t70860vdvmuKSOEZ+xqCtV6PEV+cr15X8csS74ZsjITiA5cSA2gpeEJcHfaLrBgDXgPkE9iQPEyJg7OjzPG86oEtv0BHnCc6MpeLdp5JqVGx5jpcAr2nPhCwpuLPElxErgG7pkNNJhusAmO4rBuNXe7ewREtwdgrHrLKvAy/VVL+HpK+BzHI98cAA+RuASwB6+QG/qYlL+cshtkL/d3LPbh5NW57h5cNw6+Gcx9CM4O5awegVty8ClQqsipHEIafq182fjVdCmN1yJHiQvgQ96ZLcpG3pKbXgSLzByc9TQcZBEToUWrVH6nJFMgNzCk5QDmyF23UguVhA6VAzBcAY1FqMYbOI/ZnBQ+PJpmsijcdyB7j4fGxEVGvoUEuvAXxol09iSeu+KDg3MSNdNI1PA7hbSwUhIRdgMajssziiloQ5QzpEM8Esd4slnLPblXOSPCdSbNuon8nTNLX4Gfm+h9JR8yeB/zPgeUOOzlPO5psB+p1Ix0vmUNkHR/KSCtpqwYpWtVOjg6xTIhL0vrT6vjKbfsvJUB2DijJb4SMygZFmMMrf4bIOgJCzwHNgt4Xn1EmmgmBT7QrjCbTAQKcQGbNgB+XNQVGzYLYQP05wF9+dAne7WKtIttuCKTQW8X3J3XR2NG0wXoyZUpR2U1T5vSJnZwC7d5ZlCsYllbPCoqyy12jKEDgvYdGMgb5rEEIews/y8mz4RM+kDFsAaWjrjIU8hAQfCEAtT3axOdDNdAUtR/K6ZvwjuEPs0scEyy1TGGIs5GbrgzqJiAWqUl2QHluwIpcq1k/BRQSuyAOTwlDvvsZlG/TJdBkGVFwBC1EdTuq2WxbedlDZs6Gu4jTxReFwDN5Uho2UScV+hqIqF7ysL4kwkoKoGmklq8IWkn8ZvlplZ5ldJNS5f5A+KOWP1MrmVQ/0vPXQ1GcInGarVclKCqxC48jiJBTm80ruXV4sL/jxbcGOtQvrrUCM245dVFHCl/LjrEhzuXa1hyP3VevWQNSo3YTy8K3W5utFUArLRir0XK1u3gUMuI/qoA+laBB7XX7GliHlmYbmXLlJ0n6OvZW8JmyRWt7S3M08vViawps/pi5kJMQcH/LC9L/YPmy345TSnzV2Xt/jervbnaQ48KWsAZsKFEYNNfcym0MCnRmqnRpl1ptb9j44glo0EVnCjNBxVyemZdJOr9yPq1w0qw3bmgZME4nqVnkk30zKAZVqUGwXx9HD30BVHtjs9mtp86sxssd/Zt93OrH3Q4W6nvXuI5EVEzWOmupa8c99POH6cwhnVcadgy3pYo1Ikj/FScxxC4gRKIKxyXBRJ2bIHvosFGAU143H11xcK7upKQNoHI0zML4SYVHerAt8rnfEDdkE3CTPgHtFE87ZvGgumXnx4IGXsVPVQe5Do+DHrRxEgbrNR4UOS5jF9IGLTwF1haJE+8EK6n9JMfcT3uWD10usF7gs84ClEE3secYkYCkLZgYkYAz9IF6MffdDRIFM1oXHrqgucaLTYG+6ykaGvZ4jRnt95D7CqTWcdoWvd80inoNmkClCxrDgQfLrfPGp3ZvsdziG7bR3sTY9mfHe3ebR3dISrLyFT4HNRFXTXlz7D/EQ6zAsgGZT/AoZAxqtMQKXFn4rT6zIgGC+MQHpsRqbBl8XiY1yHQP+md8U6B8yDRDSh53y+wQTfvh5XVeMa8BByWlnZH0hLnZP+aff6HHuLpvNq1RFWqfTpQlKhrTigRJXyupyAO0iLlcC0DpPqmoFaA4LAhxcHSv2Xon4XMyYLM8zqFTOKoPPefGpKZDcfY/a9bIhGHfJl7PjwGBLKKfqjNHuvdR10Yfa54WTNfBT+ocG6WZBOc8El5B9TiKKuq78R6e/8YMq6Zx4kMX5yNRszclnkrNyMJ6ljOS8KBY0DMH9eT6BQQj9OZBatMNMWg6KRD+CsObeO3aTANGIpfgyDEkwXP04QYRnGwOsyGStm3BF9kwLH46fjMo9V9Jfk7i40MtQpxRYhT9QL7O7KA/djE2nZiw/CGB9lNNobkTRSMRmPZIoimmxGZeJKDV9/Ndva7tZ2t7b7QtvdfDkyX47NW0p9WuXU59o3rTgMnqXUJyLt8QOWDtJlnRZkHbsCJkX66e0EDBtqdab30mHz5wvmRzqUl5DvZvIwmwPSvQNp6M9lgQgSHzUFM/BEwj0mvHOMdZJIrNotr3YaQAkHCupXpIjgNSO2ChLGgWVR4vu0m0jVmRsI5X8Xm31EDvZAtAekFoVr660I20xym0luo9E2Gn0z0WibSW5td2u7X6ftPplJZliRtZg8SSXLJY9WWtPMe6SWMxiQb+jOTI5EtZmtIDCW5VjWeuZgTdutaWt24IiOyzvu/u7RrO3st/neQeugNe20D6xirL/J7TgzsnWbKshby9F8xog+QB6X+KBcKg4Cd739l+A21Rm6NXQ9Wd4MPG9gxz/LHTsVW3aCGGgDwJA7Ro+0F69H5/rzqwaPfNMfL/M9jvRxEVNK2jxOZ1W2qeM2ddyGn234+WbCzzZ13Nru1na/Ttt9VerYeS517LwidewwTLFmmGL9J1NHV+pTgDMQCu5F02c48Cs9kAK/eLbdp3BSJU301rLI9lHFVpsgYBe4S8QkS2qtE+nn7EL3BmOXODZKx0rcHTcHF+njcUYZ6N0NcikwJ8VNXnRmknbXAW4AN1rZ3RmeuDMnMY2+ZatI3/ES1+wWSze83XGJ+99mmP4BBOqDzsFRf8Eep5HWZ/WD2QgpPkeKGe6TwG2FLOv/7lXtEhgA8hG6i7GW9SPbBXTPnPtQRoiPoXZfWQq6TdW3qfo23G/D/bcR7rep+tZ2t7b7ddruK1J1kw09nqrDgBen6jC20WRZLnVKez//7IydTMVgQOrNAodydTfPwenYODykc1GwyDWk+D2tyt0kXqBlStc/Tjcu2+YMwjGeuUFPVPUOxISJ6zvc1LoUoKdI7Zzuqwk5wrR2Nucoc0LWQnQw79QkJ5EHo9PrDe5BE0ADHho8lI0Ugh/c0R0HU2B/hWfDjazainEA3aagF2iQ7CKJ5qF9KQHXkjR7da3sGoUnIac7lVdQ3zANpo7b942q0mNAMYQ65TtlDvw+0JUhG/QBXdeR9/D5tGhAj9BSxb4nV4PxDDDdINHSu5ZT7RljUq9XL+lQHqjwc0K7tNgQh7XZG8EjqDj0Dpvvf3o7+YEVzhzTlRlCYu0BxngFKkKuspvuNsFJFL3ye4u6a/t50DTZzAOCmbmGJt1LfQkxZAROn1iKkwT5GZz18ss1+Nq8Ry6d+dW3zaEyPI5EYwyJ+mKemzClixfo+lQk/pZCszU0m6DhxR5rWGjW3jh6f7gD/gFBcE8Rtz55cQ3PLsDDAg2eINRNHJATBo/1XVhOKrVPxmMNno3w1vH41X9LJwPXpzHtuZha0M1LA+YsgkCJ/2UMVQfN4GaegBV9Mlp0HNEmi7DbzQJKtl7SljZknYTfORiGr5WJTzHqm4Nr1H8hk/yNJAs2/xvddvHbGs30+AaCM450A+cVN8Zs4IwL2rigrX2AMvjr2IeKBbaNNJAf0ArQy+VPnsAgWvB7GlalVyfwOzQHQ4MDqBIUFR7rP45zB2d+MXqBo7Mx4IYtOiJl9qXhuUED6yE/pquZlbYbNjlYxtcLIO5u8E3jm300xVj8V6MXKe7mXRm8FeBLe+lHPMlfx+/+hzze1tN8i57GpNGobrTsxkEtVPI3Jl8rdwkVXQ8I/8JbslXK2KEeKtyAVAAUejymc6Bo1c5CCuovhILHmPvVUbOCJVmiOYoszCVZc7oVJQKUOVSE0gN41AFPV+ZkMDqxRLni3yrJzs7r4+YN9hZKPt8BsWC5hzuB4d3vgan7xiCZKxQsO0mFzfBqkcQ3tyYkS8ZBpZ7RCFcqJ9GOC6o/X6S8CCj1y2alVoyqhiTQsTsRLdVwNtaXYhUE/8xaIHdl+tZc36Fj7oDLCRkJT58hh3HraftzsEHb7IXwQiw4wetCAiYKK1wMJiWIAMw3H0uCaL5jJqkdHAtAsrvErN1Gq9G0qVzACy4CFUPtVQCuTweWTiiqTT28z1v2/9aLYk2AwcpgJ8RuGaKd6EpFl4Y3Vqk0pO4BFYdQbiyARhx1f49tFayWHvCxvroPS0bgujlqX3XxQpHQr+vy2UrWvRfYqEjv1jWtCIuOar+cD/9dt8Y+wcfsVt1PZOT2Ctiv7wrYJ9Qhvef3E7Vhe4/r593j+oRk8lt1P1E2/+WXsT7B2vzS25y17/LuIoRYvPRDeyyKt3qa/qpRmFX67r/WDD7rY9LDHyk7zQ9c6uHh/wFohC2O
sidebar_class_name: "get 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 'Export Identity Profiles' (export-identity-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 Markdown from "@theme/Markdown";
import OperationTabs from "@theme/OperationTabs";
import TabItem from "@theme/TabItem";
<h1 className={"openapi__heading"}>Export Identity Profiles</h1>
<MethodEndpoint method={"get"} path={"/identity-profiles/export"}></MethodEndpoint>
This exports existing identity profiles in the format specified by the sp-config service.
## Request
<details style={{"marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collapsed={false} open={true}><summary style={{}}><h3 className={"openapi-markdown__details-summary-header-params"}>Query Parameters</h3></summary><div><ul><ParamsItem className={"paramsItem"} param={{"in":"query","name":"limit","description":"Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","required":false,"example":250,"schema":{"type":"integer","format":"int32","minimum":0,"maximum":250,"default":250}}}></ParamsItem><ParamsItem className={"paramsItem"} param={{"in":"query","name":"offset","description":"Offset into the full result set. Usually specified with *limit* to paginate through the results.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","required":false,"example":0,"schema":{"type":"integer","format":"int32","minimum":0,"default":0}}}></ParamsItem><ParamsItem className={"paramsItem"} param={{"in":"query","name":"count","description":"If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored.\n\nSince requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used.\n\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","required":false,"example":true,"schema":{"type":"boolean","default":false}}}></ParamsItem><ParamsItem className={"paramsItem"} param={{"in":"query","name":"filters","schema":{"type":"string"},"description":"Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results)\n\nFiltering is supported for the following fields and operators:\n\n**id**: *eq, ne*\n\n**name**: *eq, ne*\n\n**priority**: *eq, ne*","example":"id eq 8c190e6787aa4ed9a90bd9d5344523fb"}}></ParamsItem><ParamsItem className={"paramsItem"} param={{"in":"query","name":"sorters","schema":{"type":"string","format":"comma-separated"},"description":"Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results)\n\nSorting is supported for the following fields: **id, name, priority**","example":"name,-priority"}}></ParamsItem></ul></div></details><div><div><ApiTabs label={undefined} id={undefined}><TabItem label={"200"} value={"200"}><div>
List of export objects with identity profiles.
</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"}}><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"version"} required={false} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":1,"description":"Version or object from the target service."}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>self</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
Self block for imported/exported object.
</div><SchemaItem collapsible={false} name={"type"} required={false} schemaName={"string"} qualifierMessage={"**Possible values:** [`ACCESS_PROFILE`, `ACCESS_REQUEST_CONFIG`, `ATTR_SYNC_SOURCE_CONFIG`, `AUTH_ORG`, `CAMPAIGN_FILTER`, `FORM_DEFINITION`, `GOVERNANCE_GROUP`, `IDENTITY_OBJECT_CONFIG`, `IDENTITY_PROFILE`, `LIFECYCLE_STATE`, `NOTIFICATION_TEMPLATE`, `PASSWORD_POLICY`, `PASSWORD_SYNC_GROUP`, `PUBLIC_IDENTITIES_CONFIG`, `ROLE`, `RULE`, `SEGMENT`, `SERVICE_DESK_INTEGRATION`, `SOD_POLICY`, `SOURCE`, `TAG`, `TRANSFORM`, `TRIGGER_SUBSCRIPTION`, `WORKFLOW`]"} schema={{"type":"string","description":"Imported/exported object's DTO type. Import is currently only possible with the IDENTITY_OBJECT_CONFIG, IDENTITY_PROFILE, RULE, SOURCE, TRANSFORM, and TRIGGER_SUBSCRIPTION object types.","enum":["ACCESS_PROFILE","ACCESS_REQUEST_CONFIG","ATTR_SYNC_SOURCE_CONFIG","AUTH_ORG","CAMPAIGN_FILTER","FORM_DEFINITION","GOVERNANCE_GROUP","IDENTITY_OBJECT_CONFIG","IDENTITY_PROFILE","LIFECYCLE_STATE","NOTIFICATION_TEMPLATE","PASSWORD_POLICY","PASSWORD_SYNC_GROUP","PUBLIC_IDENTITIES_CONFIG","ROLE","RULE","SEGMENT","SERVICE_DESK_INTEGRATION","SOD_POLICY","SOURCE","TAG","TRANSFORM","TRIGGER_SUBSCRIPTION","WORKFLOW"],"example":"SOURCE"}}></SchemaItem><SchemaItem collapsible={false} name={"id"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Imported/exported object's ID.","example":"2c9180835d191a86015d28455b4b232a"}}></SchemaItem><SchemaItem collapsible={false} name={"name"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Imported/exported object's display name.","example":"HR Active Directory"}}></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"}>object</strong><span className={"openapi-schema__name"}> object</span></span></summary><div 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","example":"2015-05-28T14:07:17Z","format":"date-time","readOnly":true}}></SchemaItem><SchemaItem collapsible={false} name={"modified"} required={false} schemaName={"date-time"} qualifierMessage={undefined} schema={{"description":"Last modification date of the Object","type":"string","example":"2015-05-28T14:07:17Z","format":"date-time","readOnly":true}}></SchemaItem><SchemaItem collapsible={false} name={"description"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The description of the Identity Profile.","example":"My custom flat file profile","nullable":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"}>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"}}><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"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
Defines all the identity attribute mapping configurations. This defines how to generate or collect data for each identity attributes in identity refresh process.
</div><SchemaItem collapsible={false} name={"enabled"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"description":"The backend will only promote values if the profile/mapping is enabled.","type":"boolean","default":false,"example":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></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
Arbitrary key-value pairs to store any metadata for the object
</div><SchemaItem collapsible={false} name={"anyOf"} required={false} schemaName={""} qualifierMessage={undefined} schema={[{"type":"string"},{"type":"object"}]}></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":"2b838de9-db9b-abcf-e646-d4f274ad4238"}}></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":false,"example":true}}></SchemaItem></div></details></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"[\n {\n \"version\": 1,\n \"self\": {\n \"type\": \"SOURCE\",\n \"id\": \"2c9180835d191a86015d28455b4b232a\",\n \"name\": \"HR Active Directory\"\n },\n \"object\": {\n \"id\": \"id12345\",\n \"name\": \"aName\",\n \"created\": \"2015-05-28T14:07:17Z\",\n \"modified\": \"2015-05-28T14:07:17Z\",\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\": \"2b838de9-db9b-abcf-e646-d4f274ad4238\",\n \"reportName\": \"My annual report\"\n },\n \"hasTimeBasedAttr\": true\n }\n }\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"}><Markdown> An example of a 403 response object</Markdown><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={"404"} value={"404"}><div>
Not Found - returned if the request URL refers to a resource or object that does not exist
</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={"404"} value={"404"}><Markdown> An example of a 404 response object</Markdown><ResponseSamples responseExample={"{\n \"detailCode\": \"404 Not found\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The server did not find a current representation for the target resource.\"\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"}><Markdown> An example of a 500 response object</Markdown><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