mirror of
https://github.com/LukeHagar/developer.sailpoint.com.git
synced 2025-12-11 04:19:42 +00:00
133 lines
50 KiB
Plaintext
133 lines
50 KiB
Plaintext
---
|
|
id: import-identity-profiles
|
|
sidebar_label: Import Identity Profiles
|
|
hide_title: true
|
|
hide_table_of_contents: true
|
|
api: eJztHGlz2zb2r2C4H3qMKevy+WVHlmVXrS1pJTmerOtxQRKS0FCklocd1eP/vu/h4C1fTbvZjCYziUIC78K7AfDR8FcsoBH3vb5jHBt8ufKDqO8wL+LRehT4M+6y0NgxHBbaAV/hQBg2XfCQyLEhWQXsnvtx6K4J+4yPmEO4ggAvJYgawIjoPDSObwwNniTwb3eMgP0nZmF04jtr4/ixgG9UgaIEBVEgFB4wYCUKYrZj2L4XwTCESFcrl9uC1d3fQwT7aIT2gi0p/orWKwaIaBDQNcDhEVuGmee+9Tuzo5Ic+gU2U+rkBCQJXoGII84EvHsWhFwiV6A5UDhnAYxkn+ly5cKzRhHPBzmL+IECTGaBvyTRgpGIBnMWkZAF99xmiHDmB0saScitpvG0Y4TMnb3MzARGEcv17U8EQLzMioSWQA2jgHvzEtReHsx3ITmdDgnOQYjMi5eoEp1utzeZ3I3Gw7P+RQ9eqAfj3r+uepPpXXc4OOuf4/PpdHw3+Tjo3k2GV+NuL/PmavrT3XCMP7udy1Gnfz64A2DT3hienA3Hl3envbP+oD/tDwfw5Hz4oTcedAYA4nw8vBrBo/5pbzDtTz/eDU9+7nUzSJMXKX0X/bNe92P3onc3mXam+GQwnPbP+t0Owr+b9i5HF/L5qDOZXA/Hp3ej4UW/+zH7RPChsY+uTuD9ncLV701S/OOhwDm+Ev9MeueXMEb8Gn/oAwOnvckvd/3BtHc+7ij2JsMMQikq+DHtILjpuDOYoETE7/75eQ9EenUy6Y77IzUdyPvl7GJ4jZaZqKWGAxrFnfesfP+0llVzo2kfNQ7rh609p3HUoIf79cae0zxs7+1ZbavZalLE5NHlu7TM4eHKpWuC8/NYfxqTjh3xe0ZOwVXYkR+sjacnQKXsAn2F6w7BYm7KJpM6mBtJ2m3RLKRoCqa1DsGhmHPmobMFMmOPg7sDgRB/Jsx4qBEU+Uzp5k6j2WrvCSKoM/TctfRyGSHlsQ7g6RvgUxyPIrcBfsQq2OjiC/RDDrx/A+QmLKxZ3zObh9NG+7h+cNw4+HfWUSE4M+KAvYK3pe/wGa8i54KGEZGv7b+bLiAMHL+AckJD1vWXS987jXyQ3/NKQ+No4Qc8oqiBEz8O7AodyvH5ku5PgdnME81/MT7mjeByTew4jCCIzFwK4QSDlwpiMM6LXZdaOFAtgv8AmvtyCEFSxNDniMgDf21U0ZFC+2IUWgE5zNB4VZSMfPKw4PYCnkHCErAZC5hnMyJyAZHXpBJJAL/SvaW2+w5kX87z/RQvqWeidqJMc27vT9B3zV2X0yWBfzFVEu5xFXBU3HVl7pJNOvbblYqh54vsgnrPK2ijDhirbKVCB9+mQCqIfWn1eVts/KaVZ2OA1VXBmM0CFi7GiVtM6LR832XUE4TOaOyCRs2oG7LSYoHnIHxGaFppBBIoAfI8xhzm1AgsKUQGF6oGYH8OigqR92HBPJhmL6g3B+48wWQodIssaEgsBu+X1Mmro3KDGlnXj2VRUbKDstqD2lnSIarZIC5ACk7XYq7vzVG0m1xlIZXPEHSYoaYTAXtWHEEU8mZ8/rKbPmUz7gEVIBqBOpEh1ZBAAqsVaAyxBchYloghiBSX31HzF/4DUq/TGixPbN91UV8gdFJZRlBQmjICKB+98tqBJdssDMu1BvNQQStyAJSwRe1PzIOlBacFK+qKcmzpA0H31I0RlVRlFd92NW/AiYJbS9OEzRpYVIaEl2lAvRCXKlsxvrGSTJYEVFVBUykNvuDip/KbZWGW5VVSjcGr/EE2Y6xGk1o5FM7cRVeTEHyakFq9TiGj4QqkspnFzDq80buXsUUZf54gLODKJL+2jTadyMvILnDl+lHHEXCoO8pRSL11vnZQNJYTw6fbpyLhncDiQGywJp/Y2hTqS1aUByHaGaRrAXhcb02WLKKJhaVeOsvRY0q+XHuDmWLFdgzp7dTTy7UKrPq56AOpEHNwQA+b+2z/sN6AX3bdqrcc2qB7LenPdQY8rdCA7Pt+URuTCXk4pXHKoWV8Xe+zzYSwxgwrvrEORFUr9EKiScNPYxaChfcrA3bie+MYInqVhnEn0S+ABU4MgRUqXOuwdeiwI9OxjiyTWvbMZPvtfdNpz5oHbeq0m61DZC8Q3Gwy0lzaTj0vpi6RM6ojTsaK5bBa5XJslCWMhVA4hcIHaxsHl6Ns0X3PwbJLBDPlaRGpqnXCEYN0D0aoWJ8JLVpnqwLeG53w09NtmS0FrpJl9U63C1SN+PQk1BDoXEGQk+rRrNervZhcZhHPRQMUI0llL/KtvcdEbxOiBXxVyJKxoo6IFmlx3ZO3UA8zV8hYkoeEUhIClS7b2Mrj3swvF56wxImTBo1bQmSmc4bZXxQHHuRSG5qQmFVJ5JklfTEeaq6lzRPJ/K5cKXIpcZfYVs8zXFdNLzMM3vXlKKKBw+C8VV8NfhkMrwd3495Zb9zDFuK4NxlefOiNRTxkn6PXA8fRBegiJ0GHD6rmu/csk27P0g7wDcI/Jrps3QF3dEyU37YP2vvsyD6C0uCgfeDs79UPWq0ms//YEc7hmID/dWDttFe9NUQkiiA+vCJX0aSrCSIP99Y7mNGBqI4zUau2MU5Kj5yJVgl2Y5kHbyjbTFsouHhKzCnVtzjqgQYeCLtCla/lm60Sb5X4a1diFgR+UKHCPXy+VeCtAn/tCiy1TmdXFZqcZJqirJH8qZ7IA7wgagMC+wnxyhE/rbUsSt+s0HnMKpeqRpACf0/Nqbc1MeHyX4em2NN+zcaj3gRMtvRe2sz7Ezt4skv5Wmb+gv7kaaEh+WZSqluRxRQ7LQPyKi7T4kxakTjnspLfyhqiXVU2dF0OFk6kAzchk1eem+saTRx9IBYk9tiU4h4YL3f+VA1R3E9C8+yCe35Z5mfcY+Y8oBwpFOwSGyZi9+yeOyKHwjaEBKnLTDEuL3qQRK1BTqhDxoq/rmJG9ozsTwCruvTOE3Ql90r1FCy7dQlZgZYdMGrt14+a7dl+m1LQu8bBnnU0o61W/Wjv6Aix6xha0a7Loz7Hzia3ievbsCJ/gEBA80LVihPIn3M9+TUQMF7Zu5JjEzaXmSi1A9XcSXdE2gfEpd48Fs/pvCAEz7yaVO3jScDDgM955c6i9kinvbPO1QWeMVAnMIwdhFXaNOlAjiH7AL5ocYuOcMrAAw0hHcGGMLbjf1RQfwSGqBdmB3L5v1DskxNV9MMMhb1iRhZ0mgJpUxJ28zki3/Maq+0QC59BIWsviIUdDd33/7FjYwvEvFCS/JEsGHVY8EONdJKAqbvIS3BEFiMQSdF0JYBZDKYMxPBo4ccR8fxIHcJJ1yIVZbEfpZ3QRXZRXp26gF/DPpBgM2uFibYoEtX6AM1ScnnqphmhCZGuvYiCx5TbJrYfoNckFvDGIUQrd4TLFYLj8fS4xGNlfatwdypLETvjeLSAxuEr7G7kgvsxBWvJC5GBofGJpEF6I7EaepmUR1LbKWKyGpUsV5I8zzhzna3tbm13a7uvtN3iS91wVG9F6tMopz5QRslNfAyepdQnENrj+UQPkhtCciF3ML9TKdLP11Mw7E/ME5t2n1eYoX3B/EiG8hLxHZJWQfjcwvQjWazcWiCBQo6Sgxl4IgaVID5OKZaNZiGqVhnbmR9YHBTUq0gRwWsGZO3HhILIgtgTvSwa7hDHZ6H3XUQWFPwjtXH3VHpAsbnpmCufe9E2k9xmkttotI1G30402maSW9vd2u7/p+0+m0kmVAlrUXlSGC+XNFhLTVPv5b42DCB62z49BCOWqpitIDCS5FhGPnMwrGbDaswObNZ2aNvZbx3NmvZ+k+4dNA4aVrt5YGRj/U1qx4mR5W0qs95yHdUBqOAe8rjYA+UKI9938u0/EG/AZujW0PUkeTPIvIZnhXTu2DyqOJjg++QSTwapDCnM5ZBeKiP0aTB2iWMDPZbjicg5+EWPrMSxDaFKfMkAijjY5/IlF8aLXADcYG12ZhGwIg1FK1mChXu2GzvqhKA+5PhAOZ55nGHOBxBEBjsH7/wFs1O1RH8qkydj5PgCOSZ4QgaPkpIkc9+r6u/2gfgAfcRELvCGRq+sdqgHCgAFgfRZSd65zc+3+fk2xm9j/LcR47f5+dZ2t7b7/2m7b8jPVTa0OT+HAa/Oz2FsrU6SXOpMnPv9u9N0YSqKAqHexLftOBDtZp2Dixv18FDchQMkV5DXd6UqdyBpFycHHO9YH+sx1b2TY1gKTE5v8dDykoEuIkcrPxReiOJEY7c4KdyVBw0MxInJpeQrDlwYvYiiVXi8u/sIyw3L/FSjK17TEDz/oWb7y937VoXzwlMGob4U48S2aFp3Rn1VotTEIgUc7UA6TYFALpk6kG2EsHSivfwsfH10Y+3H4CYFmB08J6N0UjwGMldQkHwXqtvaKOISj8DbVeA+vcTPh9ZzfEggG/ioEt+zuGA8ASoL7BnyWLpWkQlm7hJ7SVHSaITVXrOEbIjDmuSE0QDKCrkB8v3P19MfSOYqOZ7tJoxjgQEWNwIVEf6wozcDcJIIUYEfzxeC8E5uuwXtj8xcYJj86k0YIzf6PPsAAsUYPLsQKU5iwpngrNvv9co47J65GENrqSRR8cAGdkFCuzQ37wcRL0VhwdPj5bVfPVMd0cF7ZmKMYlHUieRmpfmiGb7eS8Q/NDRTQjMFtPCHAhVStDe2PL5jgxNAENQNhbTejVzCMzPwsAqDJwi1SANKQtGR3ySz9aq9m44cPBPh5en41bsWVz7z04h0XSSEWOo6pE/she+H7J+EoOqgGdzMY7Cid5Ml7pmawiLMZj1DkilRmtyE1FLQdwGG4UllohaGdnUjcQbhVJrkb2JlweZ/g8LbIb/leBaPbyAC40jHt8N304wITURoSh8QKvrVuUggFmwbeRB+QCpAN11/4QkUoRmfJ2FVenUBflfMwdBgA6kCSrg6lv85Th2c+kXECxydjAEXbIi7b2rbEC+EKlhP6f1rKSzdUyhKsEyv60NwLchN0pv0tDDgfm38IsedtPWCH3v40l56gyf5evzu/8jjbT3Nt+hpVK6MLcxx+nWvnq5qbjJfw2qUPlKVHHDmmfuom48U6xPF1Sd+s9/2UePk125Kh+qf/SxK8SsoySdD3kxl8fsa2a9rNOovffniC8tm42cZZAFc+OjB4bMfHkgu6su5lXfkbzbeT1eXyjfeKdetpOJl7eJd7b/66vPta28k5+4Yv+42cP4ycPnGb+XlXHkbFqoO9O0Cc+HiK0YUWRqVu+64LbRg8De8FWFRVMDUjkTHJHdXF8GswDLEXXoMoPaCM9GvWzEa4dLvoBP3lyLoqc85sFACmotj+wF4B+pSi7sAr0auGQFpgfixGYInnADq777qikxg1UboEcmp9pIEP7UUe+o7MvGSgJm+5EodHoJVC9Zs3/OY5swXNVMyS4c/9NEoCnHNhIHKDmcTeacq4zFfwAUOM1S7OjTnd1JGxsyVX9WAcfla9yXY4KbNBXNXqAuQrkDlwjIYLvvTEkQA5kkdr/nBfFdNCndxLABJ/LDRqtVrdeGP/DBaUi8DV11HLn+9saBQj+le1ns/FCnNHOvk3RU2iJGgWNbtslFyY5QaJYa+k4E3XhbYVYFRj4/YScS+wRM+hiCEbaqb27QtgP9DkxIdReGbxK00Q21hmfhZoLRlVd6bw06FnCG7lM+OzTZ+RkPs1xqW+uDlUjbBAvqAHgD+PjZ+hT8YdVZSS2CQeP5o6JYyjPk9+TwT3ZCrqh/I5tPTfwFQoxkR
|
|
sidebar_class_name: "post api-method"
|
|
info_path: docs/api/v3/identitynow-v-3-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 'Import Identity Profiles' (import-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 TabItem from "@theme/TabItem";
|
|
|
|
<h1 className={"openapi__heading"}>Import Identity Profiles</h1>
|
|
|
|
<MethodEndpoint method={"post"} path={"/identity-profiles/import"}></MethodEndpoint>
|
|
|
|
|
|
|
|
This imports previously exported identity profiles.
|
|
|
|
## Request
|
|
|
|
<MimeTabs className={"openapi-tabs__mime"}><TabItem label={"application/json"} value={"application/json-schema"}><details style={{}} className={"openapi-markdown__details mime"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-mime"}><h3 className={"openapi-markdown__details-summary-header-body"}>Body</h3><span style={{"opacity":"0.6"}}> array</span><strong className={"openapi-schema__required"}>required</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}><div style={{"marginTop":"1rem","marginBottom":"1rem"}}>
|
|
|
|
Previously exported Identity Profiles.
|
|
|
|
</div></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={"int32"} qualifierMessage={undefined} schema={{"type":"integer","example":1,"description":"Version or object from the target service.","format":"int32"}}></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 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":"Exported object's DTO type.","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":"Exported object's ID.","example":"2c9180835d191a86015d28455b4b232a"}}></SchemaItem><SchemaItem collapsible={false} name={"name"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"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={"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","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></MimeTabs><div><div><ApiTabs><TabItem label={"200"} value={"200"}><div>
|
|
|
|
The result of importing 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"}}><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>infos</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"}}>
|
|
|
|
Informational messages returned from the target service on import.
|
|
|
|
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"key"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Message key.","example":"UNKNOWN_REFERENCE_RESOLVER"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Message text.","example":"Unable to resolve reference for object [type: IDENTITY, id: 2c91808c746e9c9601747d6507332ecz, name: random identity]"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>details</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"}}>
|
|
|
|
Message details if any, in key:value pairs.
|
|
|
|
</div><SchemaItem name={"property name*"} required={false} schemaName={"any"} qualifierMessage={undefined} schema={{"type":"object","description":"Message details if any, in key:value pairs.","additionalProperties":true,"example":{"details":"message details"}}} collapsible={false} discriminator={false}></SchemaItem></div></details></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>warnings</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"}}>
|
|
|
|
Warning messages returned from the target service on import.
|
|
|
|
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"key"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Message key.","example":"UNKNOWN_REFERENCE_RESOLVER"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Message text.","example":"Unable to resolve reference for object [type: IDENTITY, id: 2c91808c746e9c9601747d6507332ecz, name: random identity]"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>details</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"}}>
|
|
|
|
Message details if any, in key:value pairs.
|
|
|
|
</div><SchemaItem name={"property name*"} required={false} schemaName={"any"} qualifierMessage={undefined} schema={{"type":"object","description":"Message details if any, in key:value pairs.","additionalProperties":true,"example":{"details":"message details"}}} collapsible={false} discriminator={false}></SchemaItem></div></details></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>errors</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"}}>
|
|
|
|
Error messages returned from the target service on import.
|
|
|
|
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"key"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Message key.","example":"UNKNOWN_REFERENCE_RESOLVER"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Message text.","example":"Unable to resolve reference for object [type: IDENTITY, id: 2c91808c746e9c9601747d6507332ecz, name: random identity]"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>details</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"}}>
|
|
|
|
Message details if any, in key:value pairs.
|
|
|
|
</div><SchemaItem name={"property name*"} required={false} schemaName={"any"} qualifierMessage={undefined} schema={{"type":"object","description":"Message details if any, in key:value pairs.","additionalProperties":true,"example":{"details":"message details"}}} collapsible={false} discriminator={false}></SchemaItem></div></details></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>importedObjects</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"}}>
|
|
|
|
References to objects that were created or updated by the import.
|
|
|
|
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"type"} required={false} schemaName={"string"} qualifierMessage={"**Possible values:** [`IDENTITY_OBJECT_CONFIG`, `IDENTITY_PROFILE`, `RULE`, `SOURCE`, `TRANSFORM`, `TRIGGER_SUBSCRIPTION`]"} schema={{"type":"string","description":"DTO type of object created or updated by import.","enum":["IDENTITY_OBJECT_CONFIG","IDENTITY_PROFILE","RULE","SOURCE","TRANSFORM","TRIGGER_SUBSCRIPTION"],"example":"SOURCE"}}></SchemaItem><SchemaItem collapsible={false} name={"id"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"ID of object created or updated by import.","example":"2c9180835d191a86015d28455b4b232a"}}></SchemaItem><SchemaItem collapsible={false} name={"name"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Display name of object created or updated by import.","example":"HR Active Directory"}}></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 \"infos\": [\n {\n \"key\": \"UNKNOWN_REFERENCE_RESOLVER\",\n \"text\": \"Unable to resolve reference for object [type: IDENTITY, id: 2c91808c746e9c9601747d6507332ecz, name: random identity]\",\n \"details\": {\n \"details\": \"message details\"\n }\n }\n ],\n \"warnings\": [\n {\n \"key\": \"UNKNOWN_REFERENCE_RESOLVER\",\n \"text\": \"Unable to resolve reference for object [type: IDENTITY, id: 2c91808c746e9c9601747d6507332ecz, name: random identity]\",\n \"details\": {\n \"details\": \"message details\"\n }\n }\n ],\n \"errors\": [\n {\n \"key\": \"UNKNOWN_REFERENCE_RESOLVER\",\n \"text\": \"Unable to resolve reference for object [type: IDENTITY, id: 2c91808c746e9c9601747d6507332ecz, name: random identity]\",\n \"details\": {\n \"details\": \"message details\"\n }\n }\n ],\n \"importedObjects\": [\n {\n \"type\": \"SOURCE\",\n \"id\": \"2c9180835d191a86015d28455b4b232a\",\n \"name\": \"HR Active Directory\"\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"}><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> |