mirror of
https://github.com/LukeHagar/developer.sailpoint.com.git
synced 2025-12-10 12:27:47 +00:00
72 lines
22 KiB
Plaintext
72 lines
22 KiB
Plaintext
---
|
|
id: get-search-attribute-config
|
|
sidebar_label: Retrieve a list of extended search attributes in IdentityNow.
|
|
hide_title: true
|
|
hide_table_of_contents: true
|
|
api: eJztWm1TGzkS/isq34dNUoxtDIHAlyuHkBRbhOR4qXwg1EWekW0lY8mRNBAvxX+/p1sz4xkMGy6butvd4kuCNa3W06/qlnTdsXPlZNDWHGSd3c5EhRMlXTodhuD0qAhqz5qxnnTWOkFOfGf3vBO/i5pARIoiculcrHUy5VOn5/xzt3M61V4M3x8IpzBDXSovpMi1D8KOhay49OR8nuuUeQjpvU21DCBNC+eUCflCpOUyKhPaiIMMozosjuxV96MZimC/KCOudJiKd8dv/j189fbgSMgiTK0DlQAEp74WmmYHK1KZ5yKUwLoQzik/t8YrSHjdGfT79F9bjMPbiGtAjNnfBgWmIAgYIF4N6XqfPTG87vh0qmaS/gqLucIS0jm5wDwd1Mw3xu3os0oDPswdWSvoCNPImWpQeeAyZKg27iNQEe4wVcKoqyV+UKpvcjbPaTK+vJU6r43auQEf7ee5XBw9aJlTsC8nCPOgJY/whdYUrUUbiqrH79RFe/m3cs7GaTiRzoQ0GYHQbulR2RJNtwkHVk931l/0X4y2d8bZYHMw6K9vy/5o43m20R9v7Gy9wCoKtHah1FExGymH6ffM2er3X9Cc0eqcmxsICR9hFdwdajc3TLTZX1/1wjNT+vRvkCQRxyoUzlBEsLadIkc3tnL836Impkpmyq0J60o68euH0zJiQK++zSkufsRj7/FM5Zx1q+CHYqa8lxN4Co+P4EgMJ9I3nYMAXspcZ1GCMfxEZbuMe4k4aopVtbG62mvrRjpDRK7qSRReObGwhZBQmSuMISTSr4nMKm9+CWIqL5WQaQq8lC84VSiTJXOrTfiJmspUgGh7NntAiL3WRiUTJzUJwipDCsqUAMdLnZEEM+tIt8Syij+ma3k6tNXvrouXMoNavhYKaW2vFIZc08n0C3jRbvA9QGdGY76oplDEjQHqnmXVtpKjrf7OYHO8tSnl4MXm+vbz0c5Ybmz0d57v7NDqpX/4O5Jie+k3yiinU5FbpHIOBqekJ08BgMqdHphHmccDU1ykrcWs/Dmob2EN29rLvfdic1vk0kwKHpeTW0owydkJRkyR53JEQ8EVCpJHxu+cnmhzFxRlihntvq/2Xw/PDk8xcrz/r7P9E/xFvFZ23SFC22TkloAKX5jaK0ZcCnAlvfAqhzoQ+OJZyfUZBJLYyhqEOv7yCw9lwrfGssgDZpSr3zGjyVqMnZ3xR1e6GsfNtyCe6K7qrokRjc1kQEExkh4TYEIifzZE7M1Dclhq8lmZxJ52xTDLNAkpc8oQYIr5CzASEsHOtQExGBeIeMUFgS0CcmLQaTvjN1TZtsYyPx82jULBAeTf95NhGgqAYzGbUVh7SwmxtA8wR8210Z02lMYqXZggU0iB0oWKIZRFaRDYNoQOXpTpiMzlkXhMRacNZ9Fup7nt7BOatxHMq2D5WyoL/4C4e58j/SQsWv3hUpXBx6kyZiO2RmWmMiNxHo2xUlHV5qoCX4y1yrPH2H2M3cfYfWDs3v54XLYy/LVGxdFS1km+mM2kW0RPK79z9SxAIKpWSNQhx6a6Xa0QM1HXWJ125dAZDdZH6+PtVG1mcjPb2tgZD9KtgXy+vb69PtocbHeae/35Mo7rIGvHVMPe0Y6sYhRxl6jjCgPn8sHarOWtpF6nxpTWKPXUdTN0DpVe1LXjYGe1djy1Fr2JWVQVkm/VkGapI8ppoJ0RratoQSDFBHnRCKQqDVzkShpNUSLQLSLa9Exz8JIU4OsWyXAcIEoMlMrJ6lW0SfMCCDkT5JaqZgvH0hBSjanmAweuYCfIzj+xOi1N9IcqeXFMEh+SxGL/W6oUBXpduT+/q9U+AHhHOeIkGpjd+r5uRxo4ABqCmLPquvOxPn+szx/3+Mc9/u+xxz/W54+x+xi7f83Y/S/q87Iaur8+B8GD63PQdvuirqVek3P9z8t0DpUSAbu3sClf6WTLGpzrCrhSef9EOUSGKX70ZJrawgTf83xQntRH90la3UrFHiCiK1yOWdMQ5n6317uG0WCsm66c664ub2aMveqmdtYbQVN3JCGYuAxKIuBbq7hAl9XsNHlyTHvMPCqdBSOfhfL5gPh3OVe3IwtbINExmzUBry+9iocBcY6W4hfP1F32ohX5INeZy2/+uCyR0T2y3KW+310N9AJIb4lIIlyQuWB9MGJ7nQHPXsxZw4Isfn7RpDmhGj0iXKFc7jvU1w1WAL0jsoF4Cb9BAxGvOp78+uH0qZhQZcqZofBUFCtNrQRi6z3ciDPfsDr2p0m8GTlbTKYs3LB1sUKRJsY5lCI+mhOlxHnjBlAcI4ez2mmS4rRBsy6eVBbM1KXKabfsLrVNzqkz04MWe7I17ynvjNxCaIM/Zzza/WgS8UpTwuJbSKIpReSOUJzPK7lkQ64fBfGPilsSuSXMzT+9hSKq9jzNNSXOFOFOLGTuWVs/vHjklzT4Ub+FEeJ6GwNposTRvg5LK6v9MI4Wv4T4tXF8NB+mGttue5qIWU547Jp5Jg5EOrXWq38KQa5DoXI+KRBpPwzrihZNOCKSQb8BKYlLJjpBEcn4DhEYJjqTHNEmzjWMRXlnshi2n9iyyAuf+Br1U0tmHj7HXkuUmU39D2OmBRNaMIl5wpf441ZGjoXYJhk4D0QH2FvanzNBCbSRGyOvOzM/s+/xHNo+UkBlLn6+G3/sLpNg+ZfgD0Rd0yBVUw1eXxDSe4KSF+1nLWVVpwe3NbiKN7fYRm/pLeKtT69oa/2zyUsSD5eHLO9MvvjZWfqeTPLnybv/p4z3mGn+jpmmrIrJ3XjZsn1oOvnLsqZbPfSjU+mpwr/4yrHKBTjam/g6iqqYJqN5LgN5NUd1OqUHWmgx5koGqg/XyLPsjCMRnT2FP5pCZjRxoEHYetStcqRz8OMD7WplyQETi0+yK/32Bfcs/ARrivZTdcUHdHAGZb6j7o2eZODbZ1u2cSewzHsyrHhVGRtF12xWGHrUBdjFTEi41Hc8ItM+LWLiQuNgVKULy6VfPauKYnI1EqHLfYyb+XdjOolGk9sw/HfWgt19eQwN1S+fa3WWghyrPD4dA127tP8eb3hbMlX5nPpHZF0UYKqxwtuD0xWOYGY85EKfbt2kV07yPaIFE2qhovtsdNe7/YRbCozPrQ/oeBvMj8tHfI03fCjKlaHjgdilLR9Y3fUmruWs18tj+r/GM8FyO6M+pDenozZSUhF7p9i0nneqppWb07vbVjQ5U2iWqK+v6WyG+rgbGv5aKGr8zy+WLRq3RZjAZzTcN31RfDbApzjL9n/1noOaqbqzfrMPS9/8B7L7xZ0=
|
|
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 'Retrieve a list of extended search attributes in IdentityNow.' (get-search-attribute-config)"
|
|
---
|
|
|
|
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"}>Retrieve a list of extended search attributes in IdentityNow.</h1>
|
|
|
|
<MethodEndpoint method={"get"} path={"/accounts/search-attribute-config"}></MethodEndpoint>
|
|
|
|
|
|
|
|
This API retrieves a list of attribute/application associates currently configured in IdentityNow.
|
|
A token with ORG_ADMIN authority is required to call this API.
|
|
|
|
## Request
|
|
|
|
<div><div><ApiTabs label={undefined} id={undefined}><TabItem label={"200"} value={"200"}><div>
|
|
|
|
List of attribute configurations in IdentityNow.
|
|
|
|
</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={"name"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Name of the new attribute","example":"newMailAttribute"}}></SchemaItem><SchemaItem collapsible={false} name={"displayName"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The display name of the new attribute","example":"New Mail Attribute"}}></SchemaItem><SchemaItem collapsible={false} name={"applicationAttributes"} required={false} schemaName={"object"} qualifierMessage={undefined} schema={{"type":"object","description":"Map of application id and their associated attribute.","example":{"2c91808b79fd2422017a0b35d30f3968":"employeeNumber","2c91808b79fd2422017a0b36008f396b":"employeeNumber"}}}></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 \"name\": \"newMailAttribute\",\n \"displayName\": \"New Mail Attribute\",\n \"applicationAttributes\": {\n \"2c91808b79fd2422017a0b35d30f3968\": \"employeeNumber\",\n \"2c91808b79fd2422017a0b36008f396b\": \"employeeNumber\"\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> |