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

91 lines
38 KiB
Plaintext
Raw Blame History

---
id: list-identities
sidebar_label: List Identities
hide_title: true
hide_table_of_contents: true
api: eJztXG1z2zYS/isY9kNbjShLsmLHnrm5KraSU+vYOVuur2dnrhAJSWgpgCHIODqP//vtLkCK1JtVt9NrWn1JLLws9h3PgiAfPB2LhKdSq37oHXuRNGk/FCqVqRTGq3spHxvv+NYrNb6ve6EwQSJjnAaTBhNpWPddnyUizRJlGGdIh+kRk8W0BhCLecKnIhUJknzwJE7+kIlkBn0KeuDnSEbUX/dMMBFT7h0/eOksxi6TJlKNvce6l4gPmUwEMDzikRGL/LwmGsCNyaLUsMzANJZOBDMpVyFPQmZmKuWfmJ02FCGTit1+v09CXOWDTnQUiQBpsncF4++/mqRpbI739kLxUUSovYbhMoq1VGkj0NM9Gao9Hsu9fDE/KOj4cwV8YQUFznzH59d36k69zlsZqNRkcayTFNgb6YQEGAEpfY/dIymiEDStQmYtqBNzjBRqNRnWasesJj7UQayabUPtFq3m3rXySHKz3DySiUlXz4j4uh6wlYyWm4NIZyGoNM3yhVxHnOhAGDQN9opqZ6CTRETQHC5NSkGV82bwE/GJT+MIHUSGTHxgd95BcNQ8PBq2D5u8fXDAD5ot/Ovw8GgUDJvN5sGdx0Cf8zVwFjkS+NZqrzRoho1eWffARlOeQgs4wZT7RqCxgfoWDnsF5P/g7ooaWHTWK9u2nauCvcgL64y8rs4qnlGxIw3zS/1r7RKKEQd2bNRstI5Q2RTz2MnF5WXvrDvonf7n4vzsB+g5vzjv2ZxGtGDS4pinDdgNMRbDUOJvHjEb3CzV7i/DiHFWKLSB+ltYBwmYklv+LU0yQRGe51WtolkppYKeecp4IkqTiDCKxEINI5ROkSxQmVUo8ShaImRgGzCj2VqWKzYira0zS6AzlXqLSuqPWA1FqjGZsnsJHMQ6zpBrcpjav/yBTnnkn+DsGsZDrJURbCJ4CMq8l+mEBoIlh/Abdpc8ZIj9e51FIRsKJyNGCSwYyakEYih7TY9GRsCPewEqk2OlE6evK6kCnAdiGPJoDqYDVhgJwgKu2IR/BFswiB+KcxwvpzEP0jpKAxGQCIx7oUJYGLUOtjcCV60RETJmrYY8EbcfeQTGJS3gaGA7Mzk3QvzO0f01Re1Uo1qUzWMwAA2+5PeFB6A8KwJuqHUkuPJK8UQzH9f5ChloyVfeQrpbYWftjNv4XLTUftFcoSRYV4wpYRWbBjTtt6FhKpWcYqqCeVP+yf5NVAp9wq+12rQuvqTOC2oGtkGDlJwz8DurVfDStMGuTQYpYcZMLAIJCTu04ZaHD0yL+VgqG6uJzsY2FJ1hPhtz/ApjFOoH5b/HNWx2Mkip3Wzif1Wdn62EwIGG5SA5wnAex5EMiOu9nwzOeVjmjicJR/vKVExpLTDTxYjgsxuhhz+Bbipi31p3ADYBMIF+CbbDXBkus3k1M0DaHwslCK6wTElwKtY/RebRyBf5Akt7agl5tdr7nRfEBA8vYJuyCeIxd8zFVc+h9RfQ5zge9+EA6COmWiJ4gh3oaCH66FOUC0vjaD+VQHyR9fLy7WZ732+2/Ob+oN06bh0ct9uNzn7738jRVIcUMCscALAys93B/4M3YA78jga94kacwPak1WmqadtedJ58pKvzZjhu0X0IuK0CVwtgCOEDpQrnSjYCQElJgQ5dUMwqVr7nOLNxPwFnR9VSSQHQCmJti2UHQJZmIODBKbmmV66Fe7NIvnENmHYwiUJa5MN8d3sk+ctFyiomqnNWMTUngoh+7gFlvhw67V1eXlzC74vvvDoSfl9m2XYCV/lEB4630kw+50tDTGQGawgqMij+Szxcn1/23vSvBr3L3ik0V368652f9s/fwF833ctz+9dp/6r76oy6uyeD/vc9bOvRnwht4RfMfts/dz9yEc8uTr6DhoqErg2jiisOSflSjEriFc66gCvnorlpjRV2qbqypfiU4k4HFwxHlNL4wiq50vqnvfNBf/BDVZ6ilYz29Ho2565ZaR7xQaf1ssk7ByMOwFh0mq2D0bAjmq2XQbt50D7wSll383r/yGABH3MLaoqF0sQRnzHlkvNTjFxqwGcpg/+kwv3rEVOONG/t2DWgsLz+zUSAC2JGAACdr4ZgmucLIhscADKOKsVLFVsuoFJgAo8pwHcgC0w2lurlFLscM0iFYW8lXNk9R7RPxGG7HM4WwqicmZt+q+W324PWi+NO+3i/1YBtknYNngIvwywte+M6/+6CMuJ5+VPwMaexOa0+3HmZDO+84zvvhjIsu8EMe+fV77ziqIe6bQKmjlL1TV3lrEADnLOc53OXSOdZ3+595wTmaeRRp00DUL1XMxWccpxx3OocNvc7L182j/ZfNqGbcnmJrW/G2ICZupg9Z9yu+oiqjeRIBLMgEkXKXg+ZqkmBsvP5VpGD7qFKGKZY1Kb4KngB5PpRuKxGMPs6DnMUs3WELK0BJamBulEolpPFUy2epRqRcGDhPNUC1eh4rCLFudDL/L2f44KzilZzFLF58ztbYDgUKVjQletQckdZuCwVaRXL9ftyclgrO5Y1Odve4/tHAueLYAYzE8rdWYXTTyIJo1gvSUB9PrssnR7YEodOBdhQh5SapILSXYbPwfJr3M6q5USHW/jda6mEP064RA4FsRzARMQYH2WIEIMKIksyd04aV03doIlGi73iIchr5TtxwiBqTHjwM9Dqb7FlXVuIl0+BDFQkoxXLikPBhwfNo3ZndNDhvP2y0zp8MTwa8f395tGLoyMKEsBKkPrNiiKouvQbLFlkwCINzi7/K/B0i4PuiQFavFw3bbYB0dgy7u3YQkzHL0vFp7QOO9erk3escwibhxpn1M7HC0pQ/vXVKrRpCV8kcizVpjPM097r7vXZgMDZP697V4MCLC5sHAq8NUS31LSRTvS9TSRWANzHjIjoPL3Bao5qDQTiypQHSlPa4pjbe2GGW33FjDJpNkr0tBJKFDefUvaVbIhGHeIY6ySeBhM2hDolZNoi01o3CESc+mdOkzV3Evh1g3XnR610kIYAZYaHaAD97fG4PeWAUBa0c+osxXM2GYiqLeaqXExlReIrGwWDAzjfogYKUkhJ5BOVKCy8xbHo7AM8W81VuRuUlEYqxecAQZ7c6dA3gMwEssnUMJeO6DgeEo/KxxUZq1wRUrp7a5mhbI7FNc/MFnH3LoL045NoRcdH4YKPDulsNhLlE3GXkdz5E012owpz5YFvHxjsYncXu7vY3TJ2Fzsv3emk6yXo01qGPtcK4OJEJ7R5LkGfhLxHaZYPsodY1pB1BJsOIn17M4DA/hnQGIwXn2KElr8hPrJb+RLz3cIe7rlo/tg03/rntkAGSY9WghFkIhEeE99zji1IJFXtL6/2WidDCQ6qVkBEyJoJm+mMHsUlmVL0CMnU6RGc+jJ1D48CPAWyGRBXVaFvj7x3SHKHJHe70W43+tPsRjskuYvdXex+nrG7EUkWXFG0OJxksumUJzPraa6fju0ZDJjf4ilCjky1iFaQGCswlldFDt6w3Rq2RoeB6IS8Ex7sH43awUGbvzhsHbaGnfahV97rb+dxXARZNaZK9rZ2JBUDiPsIOC7D54Im1TqsHv9leENvhGkNU0+Bm0HnDXvuaLFj+2gZOw60Zm/xBpZDSKaCIdVcR5jTYOwUxyb5WBjA2RjyosLbRxL4QlfCpxI+wyf2jO5oYPCiFEA3mfndEZ7Fu4tTzsmKVdzJq6FMEGlEzRocS+ItpBFiPqBACHYM2fk3RKfORL8KybNLlPgMJWa9T4EQGOgFcn+x6ny3r+hxdMSurIHXHPTaaocrcAAoCGzOKnDnDp/v8Pluj9/t8X+OPX6Hz3exu4vdzzN2fwE+d2hoPT6HAVvjcxjbaLICS72m6ze/N0ynUHEckHszHQRZQsfNOQYnXAGuhAyN6fpDzNMJ/NiT5ffaLNq3fGRJBP35reQHMA+Y5bHBY9nIL9QofU9Xk4egkxXpBu8F2NDCAXQJ2i7QIIUmEn3WJjgibtWbv29S3H7eSDm/bjLTGaQ0IlPH22nOf6gZWIyhePjS0OgG+cuSfCDXdRI9/npZLKE1sqxS38bVYDwDThdE9OyNDiPAzniTA+11Dfyc2OzUzdC2t+/LY64QjVsOl0bOdxis4NpLDF3gsDZ7JXhC7+/gQ42vvr0ZfM1KF6TpKqeQdDuFs3fgRpTjuvkBP06ibWd+Ub5beYSCMcVGESiFuZvz+U2Vc0j+l5CtSe04SVCCwFnb35vnlXlr7snfKZ+dysReq7c3yJyI9gWY2ziXi5fkei4TX+TUfEvNJ2r4GlmFC6va28BeyQkgsJEEjwxp69mLW3p+iR5WVtCCVBd5QE04PqoPvoLcas/mo0LPR3pVPu7UzUTCBludxmw+Y2ZCbzj1WTDR2oi/M4aug6FyO84g0p7N1j0u6lNE+O1miSXfLulLH+Ai8XcGgaGsM/EhbteEVvA1NxXasP2RLAt54Ue6xfVjRWZqvoVdFUeGOvgFL4Ms8IwL+rigb/OEcfy7O2bALN7zBBkoD1gHOJnbnzKBY7SUGy2tlZmfyO/RHNw+AmDVXhqMj+2P43kSdH8x6sDRxRhI1Yi2i0eB+B6eo4U7V0VZ+TnBogaX+Y00bJgLerP8FudUuIn+0eRFibvz4xR8v+G3ztJrMskfJ+/+nzLeLtP8GTONw7/obrTswjVYdPJXDtMtH+8ZuuYO/0IvxSpBbShk5lfPy4TiiKfo1RTVwUQKOhiIBU8RH9bzi8gQie79Fyj/iNCYXuFKgGUOpZyMgB4dXecrcwoYCz7RrvjbZFSd4FrBBApN0WA3UKupAMyCdRpevoC+n7Qr2K7AMu/QsOw0NzbD958yhRfnge1syji41BMeEUoTZDZxQdmmRK4L+z5CMSuPYnQ1FKFBFUsyNRcjPHOGcrZk+CfWArsbd+AMqkcrujc754Jc4pvemDxgXBXaP0UbvM2fiCi21+QDAGCitMLb/mCJIhBTBuSCilwn4z03yezhWCCCJZR1n/1Gq9H0qaTA96a0SaG2LRGntyErXxapuN/D/Ih9+8+JuE0C0f1ejEdVuHRmKxJb9N16paIPSoQJ8IWtDw94hoFV0CM225dosbQATaH7rnnPv8zl7iMjf6WPjKx0tZ8FnqrMv1jjTk48ejVie0/aff1js4LnH195poL/Kl/n2KDDxQ+lPFOTu094fH6f8NjgFfl3Wp7pDZ/XRzo26CH/Bskz9fDX+rrGBj0WXx+ZK/L9/MyYzmkBg1EuILRlZ9kHSKVZS1cskEpxqP+mB9Dz8X8ygYhp
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 'List Identities' (list-identities)"
---
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"}>List Identities</h1>
<MethodEndpoint method={"get"} path={"/identities"}></MethodEndpoint>
This API returns a list of identities.
## 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":"filters","schema":{"type":"string"},"required":false,"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, in*\n\n**name**: *eq, sw*\n\n**alias**: *eq, sw*\n\n**firstname**: *eq, sw*\n\n**lastname**: *eq, sw*\n\n**email**: *eq, sw*\n\n**cloudStatus**: *eq*\n\n**processingState**: *eq*\n\n**correlated**: *eq*\n\n**protected**: *eq*","example":"id eq \"6c9079b270a266a60170a2779fcb0006\" or correlated eq false"}}></ParamsItem><ParamsItem className={"paramsItem"} param={{"in":"query","name":"sorters","schema":{"type":"string","format":"comma-separated"},"required":false,"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: **name, alias, cloudStatus**","example":"name,-cloudStatus"}}></ParamsItem><ParamsItem className={"paramsItem"} param={{"in":"query","name":"defaultFilter","schema":{"type":"string","enum":["CORRELATED_ONLY","NONE"],"default":"CORRELATED_ONLY"},"required":false,"description":"Adds additional filter to filters query parameter.\n\nCORRELATED_ONLY adds correlated=true and returns only identities that are correlated.\n\nNONE does not add any and returns all identities that satisfy filters query parameter.","example":"NONE"}}></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":"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></ul></div></details><div><div><ApiTabs label={undefined} id={undefined}><TabItem label={"200"} value={"200"}><div>
List of identities.
</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={"id"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"description":"System-generated unique ID of the Object","type":"string","example":"id12345","readOnly":true}}></SchemaItem><SchemaItem collapsible={false} name={"name"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"description":"Name of the Object","type":"string","example":"aName"}}></SchemaItem><SchemaItem collapsible={false} name={"created"} required={false} schemaName={"date-time"} qualifierMessage={undefined} schema={{"description":"Creation date of the Object","type":"string","format":"date-time","readOnly":true,"example":"2023-01-03T21:16:22.432Z"}}></SchemaItem><SchemaItem collapsible={false} name={"modified"} required={false} schemaName={"date-time"} qualifierMessage={undefined} schema={{"description":"Last modification date of the Object","type":"string","format":"date-time","readOnly":true,"example":"2023-01-03T21:16:22.432Z"}}></SchemaItem><SchemaItem collapsible={false} name={"alias"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Alternate unique identifier for the identity","example":"walter.white"}}></SchemaItem><SchemaItem collapsible={false} name={"emailAddress"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The email address of the identity","example":"sender@example.com","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"processingState"} required={false} schemaName={"string"} qualifierMessage={"**Possible values:** [`ERROR`, `OK`, `null`]"} schema={{"type":"string","nullable":true,"description":"The processing state of the identity","enum":["ERROR","OK",null],"example":"ERROR"}}></SchemaItem><SchemaItem collapsible={false} name={"identityStatus"} required={false} schemaName={"string"} qualifierMessage={"**Possible values:** [`UNREGISTERED`, `REGISTERED`, `PENDING`, `WARNING`, `DISABLED`, `ACTIVE`, `DEACTIVATED`, `TERMINATED`, `ERROR`, `LOCKED`]"} schema={{"type":"string","description":"The identity's status in the system","enum":["UNREGISTERED","REGISTERED","PENDING","WARNING","DISABLED","ACTIVE","DEACTIVATED","TERMINATED","ERROR","LOCKED"],"example":"LOCKED"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>managerRef</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"}}>
Identity's manager.
</div><SchemaItem collapsible={false} name={"type"} required={false} schemaName={"string"} qualifierMessage={"**Possible values:** [`IDENTITY`]"} schema={{"type":"string","description":"DTO type of identity's manager.","enum":["IDENTITY"],"example":"IDENTITY"}}></SchemaItem><SchemaItem collapsible={false} name={"id"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"ID of identity's manager.","example":"2c4180a46faadee4016fb4e018c20626"}}></SchemaItem><SchemaItem collapsible={false} name={"name"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Human-readable display name of identity's manager.","example":"Robert Robinson"}}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={false} name={"isManager"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"Whether this identity is a manager of another identity","default":false,"example":true}}></SchemaItem><SchemaItem collapsible={false} name={"lastRefresh"} required={false} schemaName={"date-time"} qualifierMessage={undefined} schema={{"type":"string","format":"date-time","description":"The last time the identity was refreshed by the system","example":"2020-11-22T15:42:31.123Z"}}></SchemaItem><SchemaItem collapsible={false} name={"attributes"} required={false} schemaName={"object"} qualifierMessage={undefined} schema={{"type":"object","description":"A map with the identity attributes for the identity","example":"{\"uid\":\"Walter White\",\"firstname\":\"walter\",\"cloudStatus\":\"UNREGISTERED\",\"displayName\":\"Walter White\",\"identificationNumber\":\"942\",\"lastSyncDate\":1470348809380,\"email\":\"walter@gmail.com\",\"lastname\":\"white\"}"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>lifecycleState</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"}}>
Lifecycle state details that include lifecycle state name and whether this lifecycle state has been set manually
</div><SchemaItem collapsible={false} name={"stateName"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The name of the lifecycle state","example":"active"}}></SchemaItem><SchemaItem collapsible={false} name={"manuallyUpdated"} required={true} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"Whether the lifecycle state has been manually or automatically set","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 \"id\": \"id12345\",\n \"name\": \"aName\",\n \"created\": \"2023-01-03T21:16:22.432Z\",\n \"modified\": \"2023-01-03T21:16:22.432Z\",\n \"alias\": \"walter.white\",\n \"emailAddress\": \"sender@example.com\",\n \"processingState\": \"ERROR\",\n \"identityStatus\": \"LOCKED\",\n \"managerRef\": {\n \"type\": \"IDENTITY\",\n \"id\": \"2c4180a46faadee4016fb4e018c20626\",\n \"name\": \"Robert Robinson\"\n },\n \"isManager\": true,\n \"lastRefresh\": \"2020-11-22T15:42:31.123Z\",\n \"attributes\": \"{\\\"uid\\\":\\\"Walter White\\\",\\\"firstname\\\":\\\"walter\\\",\\\"cloudStatus\\\":\\\"UNREGISTERED\\\",\\\"displayName\\\":\\\"Walter White\\\",\\\"identificationNumber\\\":\\\"942\\\",\\\"lastSyncDate\\\":1470348809380,\\\"email\\\":\\\"walter@gmail.com\\\",\\\"lastname\\\":\\\"white\\\"}\",\n \"lifecycleState\": {\n \"stateName\": \"active\",\n \"manuallyUpdated\": 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={"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