mirror of
https://github.com/LukeHagar/developer.sailpoint.com.git
synced 2025-12-11 04:19:42 +00:00
45 lines
10 KiB
Plaintext
45 lines
10 KiB
Plaintext
---
|
|
id: get-attribute-options
|
|
sidebar_label: Get option based attribute values
|
|
hide_title: true
|
|
hide_table_of_contents: true
|
|
api: eJydVm1v4zYM/iuCPuxTXpy+3N0CFEOGdYcM63Vou30pgoKx6UR3tuST5DRB4P8+Uk4cN82l6eVDEkkk9ZB8SGotTYEWvDJ6nMihnKEfeW/VtPR4W/C2kx2ZoIutCkuS+YxemLAQU3CYCNhqiAVkJbKGh5mTw0e5OzIba5OOLMBCjh4ti6ylpgWZ/V6iXZGq0q3Fy5tHWWaenUiNFQXMlA64BehEOGO90rMeqVj8XiqL5E0KmcOOdPEcc5DDtfSrgm8y068YexItLHvvFUGm00zlyrfElPY4Q0tyuIS8yGhvEEVVR5o0dfiG5GUQtAnt7uQcBUPP2mIytggekyfwsqpaBw0cunJ342XUGN3XdH4VDCaIxe3WQVwWmUlo29sSq04Ta41PTWaeVHI86uM/hEkpyq08cwZSlVEKa3/ejnnjOqnmBHkoyzJcvAvF+XkafTxLku7gfHrRvRjgoPsJIeoOPqRncPnr9PJj/IldbbwgDkECHo7Dv0NfWu2Iqz6eEwaxVRNKCz9HYdEVxEw8yY+pMRmCDrekUGa+EW0cCbGuJmytNhzYdRZF/PMS2/WyoERRCW1FhTcCuIwU75FDjtMYGyKYDoyDoshUHIjf/+rYyPpkgr/I+rYed1pgLYQC9Ji7t61R9k5IL5E0udXZaktBWR7Wy5X+G/XMz+Xw/IyWsGwvX1nZJ/CbSLgaN1HfF+Xq8coHDu41v+5ZOH1qmPbTTeRY2+D7jYfs8JHGpT/eQ/qok8KQym/h9qtB9Et919WHiC0UFhfKlO5nrVxEL2J0sw1GFT4deXGI2r9DIu5qBouuKDVMs8Du2PB9Hnvv4bXReJuGYbEf/S2osQ5F8xercov4kdx/LBWuubbW0ASqJrUTl4ecGBM+qyET92gXaEXQIXds6ClUtzR+Sj2nCZTRApcx1lX1LueOEwr5ytfIRtTGnIMZinp/yp2Nu1kt307svbF2RROSSBz63zOhEs/WBOpvUshnZvMAYAjAlSf7BzsGdcUQjXp6l5Z4K+feF27Y76/JZdD+CzXoqqcpbYTBrBB7lPY+FIqUF2AVk6GmYyNeu7hpqRLiHGPzqpc/BHHB/V+Ac2rGOWBSlc6Tf5YdmjC+uLTKrwLAKYJFOyrZo8dJ+/ieU1DjaAs1GWGn5GYGhN4fhGin/vPntsE8mG9Io4S/r1amtPXfUDNKp4YtcrhqFwa9qBe1CPnl+u5GjP4Zv/aVkrk9FDGN3ymK0tX+QhxT9sPLJzeJSleCo0olzoOEENApT7cABvVCUbJzyjrTkoiIPOyGzRi9GT8ErIVxPgfdOjnlpfcC9HrH+tOeiXWgPbW4fpGB4tqtGbXecPDx8NSiLM4JLp+v12z+X5tVFW/XjwBOfKIc82w3zH8I9YQXzkGk33B18DEV/KOT0IlOh/Gel8oRPK1n0Q7IZFd4oQwofjRT+SFJkar1RjG3r5bWq7bFVppO8fmaafM/bgk/PA==
|
|
sidebar_class_name: "get api-method"
|
|
info_path: docs/api/nerm/v1/nerm-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 option based attribute values' (get-attribute-options)"
|
|
---
|
|
|
|
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 option based attribute values</h1>
|
|
|
|
<MethodEndpoint method={"get"} path={"/ne_attribute_options"}></MethodEndpoint>
|
|
|
|
|
|
|
|
Get option based attribute values
|
|
|
|
## 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={{"name":"query","in":"query","description":"Allows for pagination and sorting.","required":false,"schema":{"type":"object","properties":{"limit":{"type":"integer","example":100},"offset":{"type":"integer","example":50},"order":{"type":"string","example":"created_at"}},"example":{"limit":100,"offset":50,"order":"created_at"}},"style":"deepObject","explode":true}}></ParamsItem><ParamsItem className={"paramsItem"} param={{"name":"ne_attribute_id","in":"query","description":"ID of an attribute for filtering","required":false,"schema":{"type":"string","format":"uuid","example":"33f072dd-13b4-41e1-8ea0-16f2a59b57c8"}}}></ParamsItem><ParamsItem className={"paramsItem"} param={{"name":"metadata","in":"query","description":"Returns batching metadata in the response","required":false,"schema":{"type":"boolean","default":false,"example":true}}}></ParamsItem></ul></div></details><div><div><ApiTabs><TabItem label={"200"} value={"200"}><div>
|
|
|
|
Expected response to a valid request
|
|
|
|
</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>ne_attribute_options</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"id"} required={false} schemaName={"uuid"} qualifierMessage={undefined} schema={{"type":"string","format":"uuid","readOnly":true}}></SchemaItem><SchemaItem collapsible={false} name={"uid"} required={false} schemaName={"string"} qualifierMessage={"**Possible values:** `>= 32 characters` and `<= 32 characters`"} schema={{"type":"string","minLength":32,"maxLength":32,"readOnly":true}}></SchemaItem><SchemaItem collapsible={false} name={"ne_attribute_id"} required={false} schemaName={"uuid"} qualifierMessage={undefined} schema={{"type":"string","format":"uuid"}}></SchemaItem><SchemaItem collapsible={false} name={"option"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string"}}></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"}>_metadata</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"limit"} required={false} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer"}}></SchemaItem><SchemaItem collapsible={false} name={"offset"} required={false} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer"}}></SchemaItem><SchemaItem collapsible={false} name={"total"} required={false} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer"}}></SchemaItem><SchemaItem collapsible={false} name={"next"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"/endpoint?limit=10&offset=60"}}></SchemaItem><SchemaItem collapsible={false} name={"previous"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"/endpoint?limit=10&offset=40"}}></SchemaItem></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"ne_attribute_options\": [\n {\n \"id\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n \"uid\": \"string\",\n \"ne_attribute_id\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n \"option\": \"string\"\n }\n ],\n \"_metadata\": {\n \"limit\": 0,\n \"offset\": 0,\n \"total\": 0,\n \"next\": \"/endpoint?limit=10&offset=60\",\n \"previous\": \"/endpoint?limit=10&offset=40\"\n }\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"400"} value={"400"}><div>
|
|
|
|
Bad Request - unable to complete.
|
|
|
|
</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"}}><div><span className={"badge badge--info"}>oneOf</span><SchemaTabs><TabItem label={"InvalidJson"} value={"0-item-properties"}><SchemaItem collapsible={false} name={"error"} required={false} schemaName={""} qualifierMessage={undefined} schema={{"example":"Invalid JSON syntax. Please check your syntax and try again."}}></SchemaItem></TabItem><TabItem label={"ValidationErrors"} value={"1-item-properties"}><SchemaItem collapsible={false} name={"error"} required={false} schemaName={""} qualifierMessage={undefined} schema={{"example":"The <object> failed to create/update"}}></SchemaItem><SchemaItem collapsible={false} name={"errors"} required={false} schemaName={""} qualifierMessage={undefined} schema={{"example":{"attribute":"can't be blank"}}}></SchemaItem></TabItem></SchemaTabs></div></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"500"} value={"500"}><div>
|
|
|
|
Internal Server Error - returned on unhandled exceptions.
|
|
|
|
</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":"Sorry something went wrong"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"error\": \"Sorry something went wrong\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem></ApiTabs></div></div> |