---
id: get-role-mining-sessions
sidebar_label: Retrieves all role mining sessions
hide_title: true
hide_table_of_contents: true
api: eJztXG1z2zYS/isY9kMbjSXLil9qz9zcKLbSqmdbPkm+3J3tSSESktCQAEOQsXUe//fbXYAU9WrFyfSanr4kMgks9n2fBUE+ejoWCU+lVu3AO/FGIu3qUFxIJdWoJ4yBG8bb8VI+Mt7JjdduthkOYHaEd7fjBcL4iYyRBBDoijRLlGE8DFmCAyMayIyjxdIxT1nEU38MPwX7mIlkwmKe8EikIsG1Sn+c3Dx6EsnSMLin4A78OZShG2z8sYi4d/LopZMYb5k0Qcae5hl7S1NYIkwWpoZlBrlCDkzKVcCTgJmJSvkDs9MGImBSsZt/vGbNqzbr5YNOdRgKH2myq4LPux/GaRqbk93dQHwSIaq0ZrgMYy1VWvN1tCsDtctjuZsvVvULOtWpvN9ZuYCzquPz1a26VW/zq0waZrI41kkK7A11QgIMgZS+x9tDKcIAdK8CZs2qE3OCFCoVwz+JoFI5YRXxsWIvoS7dlR1m7iugTfHAozgkNeJ4Jj6yWy9NMnHrEVWcAkPhYveCOfe49UDZy81kkNG1ZtrxQArwBrgCaop41QhUB4i3aMEeUPuD2w8Fnrdez17bzHZgjYqfCFTAm8kOcz/P4J/KrH2mg0pjVhpCD4dGpN68Rjt0GfSUastNhlFLvEPApjV2bTII5AkzsfAlcBiwe5mOWSWUkUwrDKbFfCQVLA3zE52NbFA78WsgvBC/sw1ekW4jnQiQyzoXDKiB7In4mMkEPOtkyEMjStqsL3FQWFWMRFL2ULj0ugEXMKVFWUTzAjHkICv8flqlfFLWgu4vwFVVFg0gJ+lh4dag0YQy6Deju8bBF2gv4g/2N1EpdAl/rdSmrzO1qM32kFUwT1WYTMFHwY1jHWehdUzBKv+s9nXKw+opzq6gumMoRoKNBQ/AAuTVOHCJRbBe3essDNhAOONgbhkWUYCJsWIjrMLuBSpvpECHQY3CXyof54EYhvIAByMDK4wEYT5XbAy5Fi6D1UhZOF5GMffTHZQG8kYiMDkKFcDCSqfoJUbgqhUi8heSvII8EbefeJgJqwUcDWxnJufmm/AplGeJUw00AAquvJKn0MynpzukZk1qcEKjXsf/5upH5vtCgA5r7EtRCrLva/BxcEVYh8dxKH0SbPc3g4s9LnLPk4SjH8tURKZ0XQ9+A6Uh7klQyam0Ihhf4+15IfpY8fAW+qgMgAGJM1xBQV9ZFKdcOCCo7KRJO0B8BZoD6ggvOBXsLPFFDUPtBAoK7/lSgDviT1s/eAp1e5ClwmKS02Iq8ClNHPLJJYXpowd+mXBlQqrlJ965tvo5AeTII4nVncPEcz4Q4WbDA2BiyTrFtL+JCSaCs8ta+6x12W/3//W+2e9322+u+61e7bxz2uy3O5dIKc/Lbg0QK0dLcLX19+vmeQ+uURQR6LUs3D1BTnrGaDO6fdbyq6Aq2jiUJv0ME9fKNr7xGv7x3o/14/rR4R4/4Nyv7x0dNvYO/P1DftgIDn6E0UuGNBr1Ysx+AwQu+8Yicltk+tYzgif+GNBiPtFGEmgpyHxhKJheIJoCYMIH09RQwqnrPfZprctuFplL7WOR+lTMF0vw/xE4GDkyJYst9Jc9ynRPGEuZEv0xZPKxDoOlaGLREDQJ0aedhbXRFTwGJkG14yWfh76FA3GS9wdXs8utsdHBAowhblcQ2ozvgqPgRSzt1ZfxBH53mUXtIrDa6kpjkZI8RLVvwNqFRWclIFQKU2ioAKbkFMnV1/HYWMpjXOaI8NgGbF0W7Mwub7xZGP/McqYLeG/yxYsCIAMyzy4NwCjNzIoaTveQNjVM64u2d9ptNfutM++5+oNUl4CG7iJ5ZofuLGR1oRCP35SWvL46c79cfmi3eu87b/rN9iVdvepeX7be93/utno/d87PZm51+jijef6+2zmHWVfdzmmr12tf/rTkZr7i3QrJV+YPkmR9irGWKOr3JgqikWVWeletU+C2/e+yIRb0NjvqtHNxAbnzbhlv+Ks/sakPoKIMu9Bkx1C+0nawWb2VQe5AkO+gixlri/qhXxASewrFiDDjA52lazxtdX19FkkQSHB7Eci1VqIzpI27eVfNNdAiiHSaTzrrd2jfYl7ceZ5mxX+nkw88gUCmjO82Vijdz9jsLIuiSWntS0d0GQ8Le5kUp84bnIxsMGGBSEGn5E053vv8jDKbVdEyrmHFxe7HEhqPSAhrMwuqplgD6lq+sAVTkAQ+wZXg+YyEu3orOqoVkn9vmN0LdNlsvvmaa9sKlLCJ/84vQTPXeWOPhk33HlmV1Y929+rro/8s1d6TBSH7yxrD0xCDjrWSBDRbdc2h7fHtbhb17myggwl241IBwpHBS3rAFWnbetSpDjbQ21upRHWUcIkcCmLZh4nOBzCsqde2JPP0QONmegTURG2PveGgTiffqRMGVZlw/wPQ2iQRXSsJ81k+BZNSvru5ZFlxJPjgsH7c2B8e7nPe+HF/7+hgcDzkr1/Xjw+OjwnFgNn4SCxroWaX/kkoCAifISAN5X9AIRCloHtigBbfvN8mGhv6rR1biOn4Zal4SHcAIb05vWL7RyzkapTRdT6aU4KqXvcWHB0kt4Q7iRxJtYyVvMictd42r8/7cKULsLvVg19IayGDNRV4a4BuqSnrjPW9bcGsAPccIk/gng1uilQc1QoIxJUpD5T2LzMxoEzmEgDMcKsvmVEmzYaJjmZCieLmIWU/yJqo7QBgN/luy4ATcrcpsdL0fRGn1XOnyYrbr3tVY80gkCgkQDLbb8D8CSJ/HgR2699uaEMoC9rewwKodCqhWZytEIUq59NOnk/Oy0bB4ADOn/eTpp9mwByJWY7Cwlsci84+wLPV3Cx3/ZLSSKX4jMMHKWhb3tcJlHrITCCbTA1z6YgeNUDiUfm4ImOV0ySluwvLjM2QkM94ZjaIu6sQ0k+VRCtufBIu+GgT21UktEZuJpeR3KMGmpzXrVwXeeDbhyHb2N3G7jZ2N4zd+Ztdtx2eYx+EPnuL0Oda8Qz0m1DxXIA+CXmP0iwfZOGpNeQO4VCrnV/e9SGwPwiF48VDjNv6XxEf2VK+wHyzsId75ps/Es5L/9QWyCDp0UowhEwkghPie8qxBYmkqteLq73VyUCCg6olEJHar4nOGAeVJZmi9oqbHRZoYdT3qXvEAxFhjM2AuKoKqvZpyhZJbpHkthptq9GfphptkeQ2drex+23G7lokWXBF0eJwksmiiCcT62nuPkrLGQyYnrUpQo5MNY9WkBgrMJY3ixy8QWNvsDc88sV+wPeDw9fHw4Z/2OAHR3tHe4P9xpFXrvU30zgugmw2pkr2tnZ025HJJ8BxmQLnMqnWwez2X4anD4eY1jD1FLgZdA4qvSuwY+N4yRMfrdkFV5McIZkZDKmmOsKcBmMjHJvkY+mx2wjyosIzQlLbXX8ZCaCCZyUZHUTC4EUpgG4yqTaH+HjaHW9yTlasIpUfZsAhZYJQI2rW4FgSzwoNEfMBBUKwI8jOXxGdOhN9EZJnXZT4HCVmrQd7oIcVyP1g2f5uG5hPMEf0rIFXbPTabocrcABoCGzOKnDnFp9v8fm2xm9r/J+jxm/x+TZ2t7H7bcbuZ+Bzh4ZW43MYsDE+h7G1Oiuw1Fs6A/B7w3QKFccBuTfTvp8ltN2cY3DCFeBK7n02zCE8HcMfu3j4pWoPv1Tzo95w2+J+y1GWhDAyP/r+CIYCAz3VeCxr+ZkLpe/p/PsAtLMk8eAJARtkOIBO2tsFaqTaRKL32lRHxK2i3ZEKrzhiv5YyvYcFFpzoDJIbkdnBA0vOk+gysBhDG/G9odE18pwF+UCu6yR8+nJZLKEVsixT39rVYDwDTudERBHu0FxgcSBE9roGfk5tnmpmaOWbu/KYHuJyy+HCyGmtwV6uscBQB4c12BvBE2ga7OONH35513/FRohGKRvY19CExPYB4ukK3IiyXTPf6sdJVICmb0c1Zx6mYHSxYQhKYe71DHd8c3IJZaALeZvUjpMEpQqctfnLGXxm3oqXMW5VlZ3JxL67YU9jOxHtCys3cS4XL8n1Uia+y6lVLbUqUcOX5Wa4sKq98e3hHB9C3B7BNKStFy9u6VVL9LDHgitIdZ4H1ITjY/YRmJ9b7cV8zNCrIr1ZPm7VOzoFNjuN2czGzJjeSGozf6y1EX9lDF0HQ+VmlEGkvZgtOnpWpYioNuollqp2yaqsAnAk/s4hMJR1Jnu+kHCLBkinAhu2v5JlIS/8Si9J/TojM12+gfqKIwPtf8YbR3M844JVXLBq84Rx/LuDesAsxDbKQHnAOsDp1P6UCRyjpdxoaS3N/ER+l+Zg+cDz6/b4bXxi/ziZJkH3y760g6OLMZCqEXcXDwXxZSRHC2vYjLLyHYN5DS7yG2oonXN6s/wWO1ZYTv9o8qLEzenGSkeFk6+dpVdkkj9O3v0fZbxtpvkzZhqHhNHdaFnXMpSd/I3DdIsbfYZem4V/4S7FKoFuaGmmb8qWCcUhT9GrKar9sRS0RRALniI+3EHP0pF71UVj+EMjSIRGdKo6AZY5NHUyBHq0iZ2vzClgLPhEu+LfJqM+hd7qGUPLKWrsHXRtygezYMeGxzDg3m/atW49sMwVGpad5cYG0BVFmcLz08B2FjEOLvWMRwTS+JlNXNDAKZHrQhP0K2blUYyuhiLUqHdJItMZ4u4zNLYlwz+zFtjduK1nUD1a0b2ANRWkK+yRcRw3C+2fow3eVh2LMMaeEbIuADBRWuGi3V+gCMSUe91OJ6NdN8ns4lgggi2UdZ/Xtb1avUotBb2AY1LockvE8QkF+sjq92/nPfJxuv/+Nb4w4ioKtgK7Me5wIZ+ZbV9sr3jjLe0VobMYgzh4//ERN0GweXrCy/YtdexIQMHo9dPXmldKsv0kyQafJFlqqw/0yuL0KzBux8J+iWRzA2y/KLJOvdOvt7xQvf9fnxdZo8ni8ysvVOS39a2QNYrIP4XyQj1sv/Lx7X3lY4035J9ymXrD3XRXkXbyoNyS6aiw2kn2YUNp1sLjeKRSbAD/1AJw8vRfYnUAxQ==
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 'Retrieves all role mining sessions' (get-role-mining-sessions)"
---

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"}>Retrieves all role mining sessions</h1>

<MethodEndpoint method={"get"} path={"/role-mining-sessions"}></MethodEndpoint>



Returns all role mining sessions that match the query parameters

## 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"},"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**saved**: *eq*\n\n**name**: *eq, sw*","example":"saved eq \"true\" and name sw \"RM Session\""}}></ParamsItem><ParamsItem className={"paramsItem"} param={{"in":"query","name":"sorters","schema":{"type":"string","format":"comma-separated"},"description":"Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results)\n\nSorting is supported for the following fields: **createdBy, createdDate**","example":"createdBy,createdDate"}}></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":"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":"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></ul></div></details><div><div><ApiTabs label={undefined} id={undefined}><TabItem label={"200"} value={"200"}><div>

Succeeded. Returns all role mining sessions that match the query parameters.

</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={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>scope</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

The scope of identities for this role mining session

</div><SchemaItem collapsible={false} name={"identityIds"} required={false} schemaName={"string[]"} qualifierMessage={undefined} schema={{"type":"array","items":{"type":"string"},"description":"The list of identities for this role mining session.","example":["2c918090761a5aac0176215c46a62d58","2c918090761a5aac01722015c46a62d42"]}}></SchemaItem><SchemaItem collapsible={false} name={"criteria"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The \"search\" criteria that produces the list of identities for this role mining session.","nullable":true,"example":"source.name:DataScienceDataset"}}></SchemaItem><SchemaItem collapsible={false} name={"attributeFilterCriteria"} required={false} schemaName={"object[]"} qualifierMessage={undefined} schema={{"type":"array","items":{"type":"object"},"description":"The filter criteria for this role mining session.","nullable":true,"example":{"displayName":{"untranslated":"Location: Miami"},"ariaLabel":{"untranslated":"Location: Miami"},"data":{"displayName":{"translateKey":"IDN.IDENTITY_ATTRIBUTES.LOCATION"},"name":"location","operator":"EQUALS","values":["Miami"]}}}}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={false} name={"pruneThreshold"} required={false} schemaName={"int32"} qualifierMessage={undefined} schema={{"type":"integer","description":"The prune threshold to be used or null to calculate prescribedPruneThreshold","nullable":true,"example":5,"format":"int32"}}></SchemaItem><SchemaItem collapsible={false} name={"prescribedPruneThreshold"} required={false} schemaName={"int32"} qualifierMessage={undefined} schema={{"type":"integer","description":"The calculated prescribedPruneThreshold","nullable":true,"example":10,"format":"int32"}}></SchemaItem><SchemaItem collapsible={false} name={"minNumIdentitiesInPotentialRole"} required={false} schemaName={"int32"} qualifierMessage={undefined} schema={{"type":"integer","description":"Minimum number of identities in a potential role","nullable":true,"example":20,"format":"int32"}}></SchemaItem><SchemaItem collapsible={false} name={"potentialRoleCount"} required={false} schemaName={"int32"} qualifierMessage={undefined} schema={{"type":"integer","description":"Number of potential roles","example":0,"format":"int32"}}></SchemaItem><SchemaItem collapsible={false} name={"potentialRolesReadyCount"} required={false} schemaName={"int32"} qualifierMessage={undefined} schema={{"type":"integer","description":"Number of potential roles ready","example":0,"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"}>status</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

The status of the role mining session

</div><SchemaItem collapsible={false} name={"state"} required={false} schemaName={"RoleMiningSessionState"} qualifierMessage={"**Possible values:** [`CREATED`, `UPDATED`, `IDENTITIES_OBTAINED`, `PRUNE_THRESHOLD_OBTAINED`, `POTENTIAL_ROLES_PROCESSING`, `POTENTIAL_ROLES_CREATED`]"} schema={{"description":"Role mining session state","type":"string","enum":["CREATED","UPDATED","IDENTITIES_OBTAINED","PRUNE_THRESHOLD_OBTAINED","POTENTIAL_ROLES_PROCESSING","POTENTIAL_ROLES_CREATED"],"example":"CREATED","title":"RoleMiningSessionState"}}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={false} name={"type"} required={false} schemaName={"RoleMiningRoleType"} qualifierMessage={"**Possible values:** [`SPECIALIZED`, `COMMON`]"} schema={{"description":"Role mining session type","example":"SPECIALIZED","type":"string","enum":["SPECIALIZED","COMMON"],"title":"RoleMiningRoleType"}}></SchemaItem><SchemaItem collapsible={false} name={"emailRecipientId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The id of the user who will receive an email about the role mining session","nullable":true,"example":"2c918090761a5aac0176215c46a62d58"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><strong>createdBy</strong><span style={{"opacity":"0.6"}}> object</span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

The session created by details

</div></div><div><span className={"badge badge--info"}>oneOf</span><SchemaTabs><TabItem label={"EntityCreatedByDTO"} value={"0-item-properties"}><SchemaItem collapsible={false} name={"id"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"ID of the creator","example":"2c918090761a5aac0176215c46a62d58"}}></SchemaItem><SchemaItem collapsible={false} name={"displayName"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The display name of the creator","example":"Ashley.Pierce"}}></SchemaItem></TabItem><TabItem label={"NullableEntityCreatedByDTO"} value={"1-item-properties"}><div style={{"marginTop":".5rem","marginBottom":".5rem","marginLeft":"1rem"}}>

string

</div></TabItem></SchemaTabs></div></details></SchemaItem><SchemaItem collapsible={false} name={"identityCount"} required={false} schemaName={"int32"} qualifierMessage={undefined} schema={{"type":"integer","description":"Number of identities in the population which meet the search criteria or identity list provided","example":0,"format":"int32"}}></SchemaItem><SchemaItem collapsible={false} name={"saved"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"The session's saved status","default":false,"example":true}}></SchemaItem><SchemaItem collapsible={false} name={"name"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The session's saved name","nullable":true,"example":"Saved RM Session - 07/10"}}></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    \"scope\": {\n      \"identityIds\": [],\n      \"criteria\": \"source.name:DataScienceDataset\",\n      \"attributeFilterCriteria\": {\n        \"displayName\": {\n          \"untranslated\": \"Location: Miami\"\n        },\n        \"ariaLabel\": {\n          \"untranslated\": \"Location: Miami\"\n        },\n        \"data\": {\n          \"displayName\": {\n            \"translateKey\": \"IDN.IDENTITY_ATTRIBUTES.LOCATION\"\n          },\n          \"name\": \"location\",\n          \"operator\": \"EQUALS\",\n          \"values\": [\n            \"Miami\"\n          ]\n        }\n      }\n    },\n    \"pruneThreshold\": 5,\n    \"prescribedPruneThreshold\": 10,\n    \"minNumIdentitiesInPotentialRole\": 20,\n    \"potentialRoleCount\": 0,\n    \"potentialRolesReadyCount\": 0,\n    \"status\": \"CREATED\",\n    \"type\": \"SPECIALIZED\",\n    \"emailRecipientId\": \"2c918090761a5aac0176215c46a62d58\",\n    \"createdBy\": {},\n    \"identityCount\": 0,\n    \"saved\": true,\n    \"name\": \"Saved RM Session - 07/10\"\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>