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
e8c6d4aad70eef6d6870aafd342c04847f4cdba0
developer.sailpoint.com/docs/api/v3/get-public-identities.api.mdx
darrell-thobe-sp e8c6d4aad7 merge main and fix conflicts
2024-03-06 16:17:34 -05:00

89 lines
38 KiB
Plaintext
Raw Blame History

---
id: get-public-identities
sidebar_label: Get a list of public identities
hide_title: true
hide_table_of_contents: true
api: eJztXOtz2zYS/1cw7Ic2Gku25VfsmZs7VZFdtbKlk+TkOrbHhUhIYkMBDEHa1nn8v9/uAnxJ8iNOrtf0lA+OCAKLfe8PIMh7R4Ui4rGvZNtzjpyJiHvJKPDdtidk7Me+0M6GE/OJdo4uHHOLFe5dbTghj/hMxCLCLveOL4HMp0REcxgo4Q5cBv7Mj+HSE9qN/BBng9ZTfsdkMhuJiKkxi4ROglizWMHPOIlk7VIOhGAX73dYo9dmg5hLj0cea6ogEC7SYL1s6qsfpnEc6qPNTU/ciACFqmnuB6HyZVxz1WzT9+QmD/1NbelU3YxONRfhDRuriM1UJJgv4eeMVFMD3iPxKfEjAUoa80CLDUfc8VkYgHj1va0NR7tTMePO0b0Tz0OUGeYVExHBSEPGNO3UoWHmS3+WzJwjGDfjd+Y3UfHEmIMW6OrhYWO1NtV4rMWyOrvUDGyDBuOpYOMkCKxWGdyosXOd8CCYMx0K1x/7wmO3fjxlFbJOBRUf8okveSxgfKSSyZToWMN8M+b4AmNk6n9c+a5K5LLu22NWiaNEVJgfg1ZB8aEKk8CoUrDKv6pDFfOg2sTRFVRpqKQWbCq4B+5PdsCOK8JhyoGiSgKPjYSNDLCcP87sBvpjFeMTFXYrUFUTCRrzwGJgM1+6OA7E0LEvJ4yDoYEVRoIwl0s25TcCmsFGpBzs789C7sYbKI2vYTRYbCakBxNLFaOnaIGzVojI30jyCvJE3N7wIBFGC9gb2E50ys034UEozwonGikVCC6dgp/QyEd9ZewHlBZX0NJxBMZwHlawUfasY6KRuUOi0YboKqnYTM9lDJnUDBuhb8g/WMffGUGBs6rl8w0a+zhtRR/SSRiqKAb20B6Un4CUusXbkIsCT5Mjm2qkIn2EFCoV36tUjlhFfAJflBXTxgOf66xZ39pmULAfLDeP/UjHaJDlWwFfvuMU/MDJxjLxiV06P6upvHScx8zNPdRPJKq53R/JEhtMSUjEE0zXWS1lt1PfnTINDqrHc9bodBbUBJRQnxwNDHP5ZE2IRS7n+b08uY/mrGI5qYA2GauywTRNJAIyDrgVsBsJTFOg+YiFkYrBuBSrhe42iC8dHXIP0uWlg50vHTdQiWdb7IjEB38sjZJQhezNVN2P9yATrrr9ZLja6y+PV40O+mS8FuoHpkRe1QLDAFT2glAeAPk/eSCjBhbDeGDaXhbEEEgVE1KlQCIFP1yhikzl06jb+tYW/lfWUoMFvo6xBIYGbdoImTM1+h041ugMroKCDnUYRvMwhF6U1Td/10jiftl8PIo4GhqCZKYL7YYkIlw/JkbLCHe+FMLvRAx6hVw1UkmMRbPMI/SHIAL1EziGeXxvlRMtpIVUQOhcVFrdPdx+u/V272D7bX1na09sbR9sHx7uHOzs7dfrh7tv0eWM5z43w08JlHUwKvf4KBDM83UY8DmjYARFp9zXStM3wA7gZccimiRa4WSUeJ+frYE5h2BkIn0IMUsfHCTK/Gb1lJymrI3zKSkj4JSYBpD5tDo/zUKLEgkkSfA3/biI5fn+wd2ZqGoV8AhjBqeHcIkT/fnzD0HEwB8Ld+4GFOFAZUn2srYhFm8EzpnehpCPxUumFhLh64XTaA7b71vQ0D4zP68HP3X7w+thq39abO10z05sI5K+KrGR0liWx02gVgBkRGnIbYqybNjq5WEegYoA5WyqbrM4YgMBw/FHE4sGLlKgzkMw59A3s9ClbMg86AlRQuox+jGocoRYzg0SxKNZx9B3P2Lm0Jg2+wbvsqbAiTYKvSLlgkuA4jYIbyAwhBnzFa2ZkANcbEtenlPc2TnHkZohzwDgxwJMC04GNNB2EGYc1xnLWa0gUiTA4QTCbLtSs6OMTkHWgoMs5qlFXyhnG9N7OT5zD2l2z8+G181uv9/qNIbt7hn8Pjtun0AnuNkaDK57/e5xu9PKG/qtf563BsPrRg9uvW90zB2kg796vU67SZTgqtk47TXaJ8Wf10AMfA1bWv1h+7jQuXM+sHe6Z2et5rDbvx40f2qdNqCpdTZsDzut0xbNctJ93+qfNc6areuTfve8h978jrr8WvhZYD1rssxDU6d93Gr+2uxAVAwbQ+zUawwGH7r9d9e9LsiAlPpdGt0/p/8G3cKtQfe838TWYePE/L0GSVon3f6vdDn4BeYanHdwqn6rh3GXXSOh9+1uJ5U8NQMFm5EB+PjFiHa1lE4lQ/vZXZo08NDElNneDbvFwozxBAGAXdLgO4NAhLVPBPArSlx013IWLKgyLYPvYjVEH6J09KUVjO/ujzmsc8Xu1vb+eLQLheytW9/a3zn8L1ew4VTNuGYtD7O8A7Avky9luJ+GIpW3GOYeJXExljLksJwPF+FJPnwxOT4FPMoB/FHMn9cFTp5NxnBIUWhakgOq/VqqjYuzlWZq5jPRkv9zOTeDihTPByut1Mimf8B/hREXBmE9D5UyjL+AajJQs4g9MujxDEjIMUJawktVwOqjEGIFfp8IjIzfBR8ue+mF9RgnnCop8kE9e2nN4uxt1/f24M/OLi1ezZjUUbJRzawhHYf2uKLV0pcwnes4pvaaSNtTFZfav6aG3+7vH+x7O2JrH5g9ONjf3vZGnqjXt8Y5s6cAGqD4nlqSX6Ti3Z369mtUfEVuvbtqPdQMfERdrSgC+FgFZJPvAJrdWYN0RsqbI07yJVD2vdcskh7JSR4teZrKe0GAHwPyq04i7iOHglh2YSDCrhvfw2Ui7cQZkml2oX7lzA2aqG2zH7mXIzkrDKYHQI4fgVb7BZXp3KxA0iGQkjMYvmJacSD4aH/rsL473t/lvP52d/tgb3Q45js7W4d7h1SvZgAfwVGerxEnQooICkSgXLDIv0EhkGMx9yADNPnL6wLReGGCNX0zMS2/LBZ3MWBe9mOzx3YPWMDlJKF2PllQgqyCUy5CTZDcEO5G/sSXT6HMd63jRgqELPqy64xlTCw9dEtF2BcXDHEuwC1kEC0CsyHFKpZqBQTiUhc7+uZKzyGOZ8zu9cAIO/uKEUXSGZrPQoni5i5mP/g1UdsA5A9tMx7D6mbENe6UGXhVabiuCONqx2qyYnfz39RYw+7O8cAUOQ3j57iEgBWp2dcxD2gQixFiw80EqWLfXYBmuSqXFoG2RnaKRsHgAM5fsEQHGAjMkZjFKMy8xbJo7QM8G80t4qtcaaRS3MCCFO3SYybaW3QhM4FsPizLbDqifSRIPDLtl2WsYumndHdqmAEwSvdcnugXxF0vgPRTJdGyGzfCBh89XzTZSGSbqKAJm5HsgowG216ZudLANztd69hdx+46dl8Yu4s3+3YX2N4l6LO9DH3OJU9AvxEVzyXoE5H3SMXSTmZ9bAy5gY8oLET6+cMQAvujkNhf3IW4Rf8V8ZEp5Sv2sVN72A39dL8/Lf25LZBB0qORYAyZSHhHxHfOsVn7kKp2lmc7VtHIBweVKyAiZM2IzVVCu1pRIiU9BtYbzFNCy+9j+wDYxY0xkwFxVulVzeODNZJcI8l1NVpXo79MNVojyXXsrmP324zdJ5FkxhVFi8VJOpnNeDQ3nmbvo7ScQYf8JF4WctlWdhGtIDGWYSynjBycUX17tD0+cMWux3e9/Z3Dcd3dr/O9g+2D7dFu/cAp1vqLPI6zICvHVMHexo6kYgBxN4DjEgnOpWOlvPL2X4JHS8aY1uhIUIqbQec1h7YXDXasHy5jx6FSuPs5TxGSLmFImesIcxr0nWHfKO2Lh5HYBPKixBOEPvCFruTPBFDBkzGMjili8KIUQDeaVxtj3HG1hx+tk2Wz2Ee75gFyoBA1K3AsH08DjRHzAQVCsBPIzl8RnVoTfRGSZ32UuIMSs9adKwQGeobc91bt77YlnZYI2MAY+JGNXrPa4RIcABYEJmdluHONz9f4fF3j1zX+r1Hj1/h8Hbvr2P02Y/cz8LlFQ4/jc+jwYnwOfWtbLMNSx3Tc+4+G6RQqlgNyb6ZcOjXp5Rj8YRk84Dni1Weezdt3MwGuZ1/Ow5zD4ylcbJqu1VJXs0gw7CcRHq1ID4bfg1XBmg81Hvq19GCSVLd0OvxmZ0WOwsMEJh4hy3mJOXOOZ9HNJDWyReSju5vcSBMYy9jj9k52CP1J+ulRo7lKIBsSmQ084GZdj5qBzRDWHd9r6l0jV1uSEWQ7j4KH5+SxZ+ofkcMQeUSOVep7ci7oz4DLBfGQ/Ss0lzkVS/Y6B36aJqk1EjTxxVWxzwBBvOFwqWdemHDhV19iqIvd6uxHwSNYYZhnIT/8/GH4hk0QulLqMC8k2PdCOOuBG1FqbKTPBXAQVav81cBG6ckLhiIbB6AUZt/0Kp5A7EOSJ7XjIEF5BUe9/NUFXhr3yHtdl7LK3vmRebPBHLm2Ipp33y7CVC5ekOu1THyXUqsaalWihq9NlLgwqr1wzUkeF/IBkuCBJm29enJDr1qghwsyaEGqizygJiwf5edlbmq1V/NRoldFemU+LuUHOhteHsZMWkvf9mkzd6qUFn9nDF0HQ+VikkCkvZotOpBepYio1rcKLFXNlFW/CiiT+OtAYEjjTObFDgI5CvCf9EzY/kaWhbzwGx0b/60kMzVfQDHGnp5yP+N9nAWeccIqTlg1eUJb/k2tQ8eC2EYZKA8YB2jm9qdMYBkt5EVDa2XmJ/KbNAbLhwusEhUdHpmLozwJ2l+MbmDvrA+kaQTp2RNEuGaWFha8krLS7YVFDS7zGyioswt6M/xm21tYe/9s8qLEjXwXpiuD+dfO0o9kkj9P3v0fZbx1pvkrZhoLm9HdaNqF0+Ho5AbRLe8JamHf04G7FKnpi0f5e0dFMmHAY/Rpiml36gvaTQgFjxEdbqBfqRnFoX2PSNgXmCYR9IGg1YBY+cgP8FUE9gGWa9IFFeNSDc9fANXflV2zDUDLPTQSe5caDgDUbJZIfJcAmEhmjIN7PGNdz9duYpIQrNykSCVTBOOyUWlEotugKmq0aIlmujvGbWdY0RaM+MxcYENt95xBkfSCmjncnAvSx3eKMRFAvzJEf442eE51KoIQF4uQQQFMicIMp+3hEkUgJjXIBYtyFU027SC9iX3xzQQQ3jjDTg2WiNgUKh3DyrZA9/k1WMmvskSOCHwzxF0opJuYVYNZn104y+szQPNTmBtv3t/jLgUuVh6w2byIjKsAUAT62iPvEN/nW/3f2OdTVmrMnJJPvw6THomnA/Qv18P/13dPntBj9l2YVypy/RGTb+8jJk+4Q/qlmld6w/rDI3/4h0eeMGb+SZEvDe71t0c+/9sjTxhmxUdfXmmh/7vPgzyh1fxLLLkyr/J9WtobBTBFhafwjp551lMYtXQaAqlk++knLYCID/8BN0iCIw==
sidebar_class_name: "get 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 'Get a list of public identities' (get-public-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 TabItem from "@theme/TabItem";
<h1 className={"openapi__heading"}>Get a list of public identities</h1>
<MethodEndpoint method={"get"} path={"/public-identities"}></MethodEndpoint>
Get a list of public 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":"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"},"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**alias**: *eq, sw*\n\n**email**: *eq, sw*\n\n**firstname**: *eq, sw*\n\n**lastname**: *eq, sw*","example":"firstname eq \"John\""}}></ParamsItem><ParamsItem className={"paramsItem"} param={{"in":"query","name":"add-core-filters","description":"If *true*, only get identities which satisfy ALL the following criteria in addition to any criteria specified by *filters*:\n - Should be either correlated or protected.\n - Should not be \"spadmin\" or \"cloudadmin\".\n - uid should not be null.\n - lastname should not be null.\n - email should not be null.","required":false,"example":false,"schema":{"type":"boolean","default":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**","example":"name"}}></ParamsItem></ul></div></details><div><div><ApiTabs><TabItem label={"200"} value={"200"}><div>
A list of public identity objects.
</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={{"type":"string","description":"Identity id","example":"2c9180857182305e0171993735622948"}}></SchemaItem><SchemaItem collapsible={false} name={"name"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Human-readable display name of identity.","example":"Alison Ferguso"}}></SchemaItem><SchemaItem collapsible={false} name={"alias"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Alternate unique identifier for the identity.","example":"alison.ferguso"}}></SchemaItem><SchemaItem collapsible={false} name={"email"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"nullable":true,"type":"string","description":"Email address of identity.","example":"alison.ferguso@acme-solar.com"}}></SchemaItem><SchemaItem collapsible={false} name={"status"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"nullable":true,"type":"string","description":"The lifecycle status for the identity","example":"Active"}}></SchemaItem><SchemaItem collapsible={false} name={"identityState"} required={false} schemaName={"string"} qualifierMessage={"**Possible values:** [`ACTIVE`, `INACTIVE_SHORT_TERM`, `INACTIVE_LONG_TERM`, `null`]"} schema={{"nullable":true,"type":"string","enum":["ACTIVE","INACTIVE_SHORT_TERM","INACTIVE_LONG_TERM",null],"example":"ACTIVE","description":"The current state of the identity, which determines how Identity Security Cloud interacts with the identity.\nAn identity that is Active will be included identity picklists in Request Center, identity processing, and more.\nIdentities that are Inactive will be excluded from these features.\n"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>manager</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"}}>
An identity reference to the manager of this identity
</div><SchemaItem collapsible={false} name={"type"} required={false} schemaName={"DtoType"} qualifierMessage={"**Possible values:** [`ACCOUNT_CORRELATION_CONFIG`, `ACCESS_PROFILE`, `ACCESS_REQUEST_APPROVAL`, `ACCOUNT`, `APPLICATION`, `CAMPAIGN`, `CAMPAIGN_FILTER`, `CERTIFICATION`, `CLUSTER`, `CONNECTOR_SCHEMA`, `ENTITLEMENT`, `GOVERNANCE_GROUP`, `IDENTITY`, `IDENTITY_PROFILE`, `IDENTITY_REQUEST`, `LIFECYCLE_STATE`, `PASSWORD_POLICY`, `ROLE`, `RULE`, `SOD_POLICY`, `SOURCE`, `TAG`, `TAG_CATEGORY`, `TASK_RESULT`, `REPORT_RESULT`, `SOD_VIOLATION`, `ACCOUNT_ACTIVITY`, `WORKGROUP`]"} schema={{"type":"string","enum":["ACCOUNT_CORRELATION_CONFIG","ACCESS_PROFILE","ACCESS_REQUEST_APPROVAL","ACCOUNT","APPLICATION","CAMPAIGN","CAMPAIGN_FILTER","CERTIFICATION","CLUSTER","CONNECTOR_SCHEMA","ENTITLEMENT","GOVERNANCE_GROUP","IDENTITY","IDENTITY_PROFILE","IDENTITY_REQUEST","LIFECYCLE_STATE","PASSWORD_POLICY","ROLE","RULE","SOD_POLICY","SOURCE","TAG","TAG_CATEGORY","TASK_RESULT","REPORT_RESULT","SOD_VIOLATION","ACCOUNT_ACTIVITY","WORKGROUP"],"description":"An enumeration of the types of DTOs supported within the IdentityNow infrastructure.","example":"IDENTITY","title":"DtoType"}}></SchemaItem><SchemaItem collapsible={false} name={"id"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Identity id","example":"2c9180a46faadee4016fb4e018c20639"}}></SchemaItem><SchemaItem collapsible={false} name={"name"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Human-readable display name of identity.","example":"Thomas Edison"}}></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"}>attributes</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
The public identity attributes of the identity
</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={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The attribute key","example":"country"}}></SchemaItem><SchemaItem collapsible={false} name={"name"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Human-readable display name of the attribute","example":"Country"}}></SchemaItem><SchemaItem collapsible={false} name={"value"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The attribute value","example":"US"}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></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\": \"2c9180857182305e0171993735622948\",\n \"name\": \"Alison Ferguso\",\n \"alias\": \"alison.ferguso\",\n \"email\": \"alison.ferguso@acme-solar.com\",\n \"status\": \"Active\",\n \"identityState\": \"ACTIVE\",\n \"manager\": {\n \"type\": \"IDENTITY\",\n \"id\": \"2c9180a46faadee4016fb4e018c20639\",\n \"name\": \"Thomas Edison\"\n },\n \"attributes\": [\n {\n \"key\": \"country\",\n \"name\": \"Country\",\n \"value\": \"US\"\n }\n ]\n }\n]"} language={"json"}></ResponseSamples></TabItem><TabItem label={"Example"} value={"Example"}><ResponseSamples responseExample={"[\n {\n \"id\": \"2c9180857182305e0171993735622948\",\n \"name\": \"Alison Ferguso\",\n \"alias\": \"alison.ferguso\",\n \"email\": \"alison.ferguso@acme-solar.com\",\n \"status\": \"Active\",\n \"manager\": {\n \"type\": \"IDENTITY\",\n \"id\": \"2c9180a46faadee4016fb4e018c20639\",\n \"name\": \"Thomas Edison\"\n },\n \"attributes\": [\n {\n \"key\": \"phone\",\n \"name\": \"Phone\",\n \"value\": \"5125551234\"\n },\n {\n \"key\": \"country\",\n \"name\": \"Country\",\n \"value\": \"US\"\n }\n ]\n },\n {\n \"id\": \"2c9180a46faadee4016fb4e018c20639\",\n \"name\": \"Thomas Edison\",\n \"alias\": \"thomas.edison\",\n \"email\": \"thomas.edison@acme-solar.com\",\n \"status\": \"Active\",\n \"manager\": {\n \"type\": \"IDENTITY\",\n \"id\": \"2c918086676d3e0601677611dbde220f\",\n \"name\": \"Mister Manager\"\n },\n \"attributes\": [\n {\n \"key\": \"phone\",\n \"name\": \"Phone\",\n \"value\": \"5125554321\"\n },\n {\n \"key\": \"country\",\n \"name\": \"Country\",\n \"value\": \"US\"\n }\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>
Reference in New Issue View Git Blame Copy Permalink