mirror of
https://github.com/LukeHagar/developer.sailpoint.com.git
synced 2025-12-10 12:27:47 +00:00
98 lines
41 KiB
Plaintext
98 lines
41 KiB
Plaintext
---
|
|
id: list-identity-profiles
|
|
sidebar_label: Identity Profiles List
|
|
hide_title: true
|
|
hide_table_of_contents: true
|
|
api: eJztHGlz2zb2r2C4H9poRNk6fM7s7Di203Unib0+NrvrZLYQCUpoKIAhSDuqx/9933sAKVKkZcfNtE1XH9rIJPDw7gsA7zydiJRnUquT0Nv3Ymmyk1CoTGbzs1RHMhbG63oZnxhv/9orXrHy3YeuFwoTpDJBGADhcioNS0WWp8owzhAg0xFrzGRjbkTItGLZVDCTiEBGEh58ykU6ZwlP+UxkIjW99+qAZfqjUOxWZlN2ev7Dfw+O3py8ZTplB2cnjOfZVKcImhb+lMsUwGSaBTyOATg8xWHwYCKyVRj1gNDFukDunSeRIsII3il4QyyaycxbJvsN/8xUPhuLFGGnwuRxZnBRywqg4kIIdv3PISFzkXEV8jRkhzqORYAw2Fm59Ifvp1mWmP2NjVDciBgl1DNcxomWKusFerYhQ7XBE7lhHBw/KOH4CxJesAh4NNOpYFLBzxnJGcks2OTtRzw2ouuJz3yWxEDeYGuz65lgKmbc27/zsnmCNMO6YiJSmGnB2EfDATyYSSVn+czbh3kz/tn+JiihiDhwgf66v++2c1NHkRFNdp7SY0AbOIj6EeUgS8tVBi967MrkIN55RXFIOzoknQ4yPuETqXgmYH6q88mU4DjBfDPi+BXCKNn/MPMDnasm708i1snSXHSYzICrwPhEJ3lsWSlY51/+pc547B/i7A6yNNHKCDYVPAT1JzngwBZzmHKAqPM4ZGPhLAMkJ6NSbsA/1rE60WG3Alk1UcCxECQGMpMqEGTjwmRSTcCaM0SFESFg8IpN+Y2AxyAjYg6Ol7OEB1kXqSEPARKbCRXCwkpnqClG4KodAvJXoryDOBG2NzzOheUCjga0c1Ng801oENLTokRjrWPBlVfRE5r5oK6AiyS32LJWA7jJUpCOd19Bw5MhE5/Ye09Ew91obzQc7Yi90db2YLw1Hu+OBiO+tT3c2wl333sNhXxFS5dalBsUPUWNgutmrjJwwHbaGFVK/cai+YvlD2DmOzxfoI68Kp6i6pk8SXSaAXooRnJrAErf4mtwYXFoSP9tRNap2UcInY4MO5191hGfukyJLkQx+A/VWXVZDL9j/G0UOMguM7cdOweFVpu1cnSSSoqglRkd7yFFMEjClylCxVOh8XHfCOQccGJZR7q0yLICXMCSf3DxI1eWhX9hnz1N9MB5kDSwHiB2WSGRLgtSgYzqgtmHFOi6TN8qQFOWv6ywvfsPKBLrjA0KYbC5if/UefnapT9yKctDLxJoCC0QEWAST5JYBuRfNn42OPOuKV6ephw1Q2ZiRitCSD6NKHNyI/T4Z+BVTVeurSIBskmK/M6kxVaGTWQv5gZA+xOhBKkLy5UEdWQnR0gCsvG0WGBZ46pa1R8MR1uEBA9PVTy3XvG+UOnlVd/C0y+Az3E8KrITVRPgIb5AxQsxiD4d8mCzv+VvbvmD3cv+aH9zZ7+/85+qMSE4P5NkMQ3aCn1pUQEOKmBfB781XoAYaB1BeQkFwCG4A62OMk3uZpXSFGk+IHwjLnSeBi06VKOz6YWWKxXBKk8K+pfrgl6N9DdzFuQm0zMWQUbEcAAYKw1EFwl+lY+LsAu0koFWUClJa6JCQ1chUQe+TLpdoEmzUJgPQul2dPz28uTy3y0VG8wo1rX4YVJ0O5XB1JZPqYggE8NUirwCVYQLjpSAgVxrw6vZvrDdZyw2CPb6u5u7w62wv9fnu9ugiOFgd7S1NR6NB8MB9ypGvRqNv+eQHfqonchTFkqTxHxO7vdX4PcOEkXJZwz+Rad5j/pe+PJHU/jtUatiFPMpdECKu1JB+5uwYputtOjglynQxenV+eHxV1cfB3atPAD1nB0EKDJ2BF4vgBRwbjWoiNXnIoIAPz0v3eKj6XxDWOA5sLbhZfxHnBAoZilKCCiLegxEKgMqr4H8CSgqltdToWBaMOVqIsq2DekWFF0GKiN4P4MKsKaOzg0Wi1HJ2GoHTbVflI9uNrDL1mRjSNQwBdQPuspGYVwitFvB5iAD8sZ5BlFIRXLyuJs+EpFUgIVtLIkFD3kBCTiQJJjUBQQyt601AyxF8Ydu/lTf2n6UTWuwk+WySozEnAxdcFCa5gIGc9uG7MCSA2FsB6tm1EKhgrbkAMjhMQ8+YulL1a2GGI1wZhoQoqrX2CK4jG8bBW1AiYPbW6QJD2vgsjKUtFymXBkUlVmVUz5RJKCqDppLafCFpJ/ObzaZ2eRXQzXePskfVDPG9mUWVg4ptIzR1ZQIH5WotsvJCG4S4MrDJFbk8IXevblaVvHn5YJLa1WS34DaJiW/vKqAW+XHw5Dg8PishiFX83rtUHYRlmHcf7hfRvwgHUtANp2zj2Lu26ZNwmVKLVhI11LwuGrOoFjjpYUtvHSVorsF+lb2nvBJYlDekrdzT9/MXWAtnlP/3IWYnR2+O9gW27ubffgVbI43hyHv862h9edFBnzZogHV9yfL2lhOqMNpjHMOreLrjj8Hgph1LrAQPS8CUZuEHkk0ufl4TlXuSWvALn1vnkNEb9MwGZb6BbBcYV9Xq8F4d7gbij0/HO+NfT4OIl9sj7b9cBQNdkY8HA2Gu0heStQ8ZKS1tJ0rlXNsIuOM9ohTsWI7rNcqjgd5CWMhFF5C4YO1TYjiaFr0iQqx7KJg5jyt7ZFSUDdnAtI9GOFifSW0FDrbFvC+0AnfY69gmSwHDlULqR61dQ8OIWlRGTtOU0DGZ+eVFq7lGrVm2ViHtB0jFdAnw+f0Fh7wYyFYsIwPdfgEb/YKIoM/SblEDAWhHMBEjGc3MsRIRq1UC7IQPI2rKyNwotdnL3nIzh19h44Y68WDjwCr3RjqCF3Z7kUxBQ2hEGrLsmJH8PH25t5gFG2POIdMtb+zNd6L+HC4ube1t4erzyDq84loC6D1pX/AXEMGLNaQ2MlfgCGQvRoXHGnxVTG3LgOC8cRoYseWZDp8WSY+Z10I2i8Pz9hoh8WQVOb0nE+WmKD8q4u2ytoCPoX8VLbW+kXZcnT86uDq9SU8OT/+x9XxBfxCWI0y5gASBGuZmpJOytEWBNxCimsEpmiYIHcc1A4QBB65OlDavwx1rpgzQ5jhVm+ZUQXNIsjAaqZEdvM5Y9/Lnuh1IffF3g3PIDmsbaB2DgJ0Sv5rx8mO24550WMHZcAt8roZ5BJjiIhhaHuldocNTFnQ7o3OM9zskMFS5rJg5XKEKFzJ66pQ0DgA88f1BIoe9MxEZtUKS21xKDr5AM6Wc3XsLitMI5ZiUxjKKVvIBDrFkoqBJ2UyM8y5I+rNguNRxbjSY1UdP7m7NxYZ6lVhs4/n5gl2dxaD+/GJtPLFjXDGR9mJ9UYkjUJMziO5Aocmu1GluArDt93jte2ubXdtu0+03eWX527PxL2l1KffTH2ulGurYfBspD4paY/SxXGUX2yJZgXZxQrfpUg/vrt0x1mwjP6cYCPnK+ZHNpQ3kD8o5eE2yYo9tCL0L2SBCBIfLQUReCIR7hPeC4xtkkisGjZXe6WhHAMFVS0pInjNlM11zjiwLM2Von1802WhFkZ9l7kd/AD7GdYDUrsh9O2W3DqTXGeS62i0jkZ/mmi0ziTXtru23W/TdldmkiVWZC0uTzL5bMbTudU09x6p5QwGLI5SliZHolrOVhAYK3Msr545eONBf9yPdgIxCvko3B7uRYNge8C3dvo7/fFosONVY/31wo5LI6vbVEXeVo5uSyK9gTwuV6BcJtM6rLf/cjyuFaFbQ9dT5s3A8x5274vccbDXsuGhNXuDvXqXIZlaDqkWPEKfBmNnODYtxkrco5yAX1R4BFRq22mWMwFQaKuNzpnSHifgC3DTuX8Q4elCd3rVKVm5ilRBnIduz67YdrzlEnchI8z5AAJlsBPwzl8xO3Ui+lWZPDtHil8jxQx71ri5y8rMfautv3sCyKfoIy6sgB9o9NpqhytQACgIrM8q8851fr7Oz9cxfh3j/xwxfp2fr213bbvfpu1+QX7usqGH83MY8OT8HMb2NlmZS72infjfOk0nU3EYkHozHQR5Su3mIgcHJhgBD+l0KixyBXn9oVXlA0ja0TJlqPaLQyS+Owm2jycfvQ94iGAmQBORngnd4ks4zvI2lmfgQUdbM1hq8jSGYcXdizsQMgj3vscT2SumKn1LFzBuhi0uC88WmOJwWpjbax143cMu0iPRpBK137pKWsAKyh2M8Mp7HivhF4dC5joH50hgunhGymkiPQY0EyhDvjM0ukea16ARaLtK4/vH6HHXVh6gwwJ5gI429q1cC8YzwHKJPM8eDykU4wLzdbt6Qz0WMQhrvEFjsVMcNmAvBU+hmLDbHt//+O7yBatc6aD7PEJiWQF2dgYqQl7woNgCwEkUmBbXOA9qmyxodSyKgWDmbuUVR1reQng4B39OLMVJglwIznr6zR9em/fAHbz3ynendvG8J41xJNp7itdJQRev0PVcJP5SQPMtNJ+g4a2jGhaWtdeBPbQTgOkjCB4b4tazF7fw/Ao8rL3gCUJdxgE54fCob40FhdSejUcNno/w6ni8V+/o6HV9GrMui5kpXUQ9YcFUayP+xhiqDprB9SQHK3o2WnTe2yeL8AebFZR8u6QvfUgoCb/XYBjKKhMfY0B3J4MjCKLWJH8iyYLN/0R3A3+q0UyPryHu4shQB19wnW0JZ1zQxwV96wOMw9+GNVQsPNkHNJAfsApwuJA/eQKHaMXnWVitXp3Ab9AcDA0BoEpQTLJv/9hfODj3i9ELHF2OARfs0RlUt1mIB7MdrPvFPQjLrKKTsMzBJr6xhpC6xDeLb9nJwjD7R6MXKT5YNFzw0tXX9tIPeJI/jt/9nTze2tP8GT2Ny5BR3WjZpfOyqOQ2W2u2/wx9KwH+D2/JUikVh0Jn8XmEKpgk5hkds0ebDqZSUOMgETzDzK+LeqVnZIfupgeUhwRoQldOU0CYQ6knY4DXY++gMlMBsBirMjxqAVB/1q48uwAun6GQ2FEhOIa3MHPlrpjlM8ZBPR6RbihNkFsnBEWaEgVlmtK4clZhkag2yAo6qyzSmTmNsMMs8QC698S1QIbGtZeBkSgRdyN9Qci5iO2FGxhXT78fgw2a409FnGBdCB4UkilRWeHNyWUDIgBT9uR/T6eTDTfJbOBYAIKljlWGYQ+qQXyUaJNBEVuB2/wqDl7PXlanu0VL/Rv/vI6LQ1hAbCTYL0O25LagsaXjtdcsHaEYmQLr8OXdHdKFddQ9PrafJsCCEuTobjq13XurcvDb+lJPK8c+CuxQFB8icj0Ij27KPJ0P/1+f2FnBx/ITRM9k5Pp7Od/e93JWqEPxUaRnasP6YzW/x8dqVkp08emiZ8p0/f2Zp3x/ZqUMFl8NWsjgw6K5CTEcL3Val0gB3U6z+yWVWY0TBbUm9A/HmKfxB6pe9wOXur//Hynzbtc=
|
|
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 'Identity Profiles List' (list-identity-profiles)"
|
|
---
|
|
|
|
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"}>Identity Profiles List</h1>
|
|
|
|
<MethodEndpoint method={"get"} path={"/identity-profiles"}></MethodEndpoint>
|
|
|
|
|
|
|
|
This returns a list of Identity Profiles based on the specified query parameters.
|
|
A token with ORG_ADMIN or API authority is required to call this API to get a list of Identity Profiles.
|
|
|
|
## 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","required":false,"schema":{"type":"string"},"example":"id eq \"ef38f94347e94562b5bb8424a56397d8\"","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, ne, ge, gt, in, le, lt, isnull, sw*\n\n**name**: *eq, ne, in, le, lt, isnull, sw*\n\n**priority**: *eq, ne*"}}></ParamsItem><ParamsItem className={"paramsItem"} param={{"in":"query","name":"sorters","required":false,"schema":{"type":"string","format":"comma-separated"},"example":"id,name","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: **id, name, priority, created, modified, owner.id, owner.name**"}}></ParamsItem></ul></div></details><div><div><ApiTabs><TabItem label={"200"} value={"200"}><div>
|
|
|
|
List of identityProfiles.
|
|
|
|
</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"id"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"description":"System-generated unique ID of the Object","type":"string","example":"id12345","readOnly":true}}></SchemaItem><SchemaItem collapsible={false} name={"name"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"description":"Name of the Object","type":"string","example":"aName"}}></SchemaItem><SchemaItem collapsible={false} name={"created"} required={false} schemaName={"date-time"} qualifierMessage={undefined} schema={{"description":"Creation date of the Object","type":"string","example":"2015-05-28T14:07:17Z","format":"date-time","readOnly":true}}></SchemaItem><SchemaItem collapsible={false} name={"modified"} required={false} schemaName={"date-time"} qualifierMessage={undefined} schema={{"description":"Last modification date of the Object","type":"string","example":"2015-05-28T14:07:17Z","format":"date-time","readOnly":true}}></SchemaItem><SchemaItem collapsible={false} name={"description"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The description of the Identity Profile.","example":"My custom flat file profile","nullable":true}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>owner</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"}}>
|
|
|
|
The owner of the Identity Profile.
|
|
|
|
</div><SchemaItem collapsible={false} name={"type"} required={false} schemaName={"string"} qualifierMessage={"**Possible values:** [`IDENTITY`]"} schema={{"type":"string","enum":["IDENTITY"],"description":"Type of the object to which this reference applies","example":"IDENTITY"}}></SchemaItem><SchemaItem collapsible={false} name={"id"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"ID of the object to which this reference applies","example":"2c9180835d191a86015d28455b4b232a"}}></SchemaItem><SchemaItem collapsible={false} name={"name"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Human-readable display name of the object to which this reference applies","example":"William Wilson"}}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={false} name={"priority"} required={false} schemaName={"int64"} qualifierMessage={undefined} schema={{"type":"integer","format":"int64","description":"The priority for an Identity Profile.","example":10}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>authoritativeSource</strong><span className={"openapi-schema__name"}> object</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__required"}>required</span></span></summary><div style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"type"} required={false} schemaName={"string"} qualifierMessage={"**Possible values:** [`SOURCE`]"} schema={{"type":"string","enum":["SOURCE"],"description":"Type of the object to which this reference applies","example":"SOURCE"}}></SchemaItem><SchemaItem collapsible={false} name={"id"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"ID of the object to which this reference applies","example":"2c9180835d191a86015d28455b4b232a"}}></SchemaItem><SchemaItem collapsible={false} name={"name"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Human-readable display name of the object to which this reference applies","example":"HR Active Directory"}}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={false} name={"identityRefreshRequired"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","default":false,"description":"True if a identity refresh is needed. Typically triggered when a change on the source has been made.","example":true}}></SchemaItem><SchemaItem collapsible={false} name={"identityCount"} required={false} schemaName={"int32"} qualifierMessage={undefined} schema={{"type":"integer","description":"The number of identities that belong to the Identity Profile.","format":"int32","example":8}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>identityAttributeConfig</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
|
|
|
Defines all the identity attribute mapping configurations. This defines how to generate or collect data for each identity attributes in identity refresh process.
|
|
|
|
</div><SchemaItem collapsible={false} name={"enabled"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"description":"The backend will only promote values if the profile/mapping is enabled.","type":"boolean","default":false,"example":true}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>attributeTransforms</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={"identityAttributeName"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Name of the identity attribute.","example":"email"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>transformDefinition</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
|
|
|
The seaspray transformation definition.
|
|
|
|
</div><SchemaItem collapsible={false} name={"type"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The type of the transform definition.","example":"accountAttribute"}}></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"}}>
|
|
|
|
Arbitrary key-value pairs to store any metadata for the object
|
|
|
|
</div><SchemaItem collapsible={false} name={"anyOf"} required={false} schemaName={""} qualifierMessage={undefined} schema={[{"type":"string"},{"type":"object"}]}></SchemaItem></div></details></SchemaItem></div></details></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></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"}>identityExceptionReportReference</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"}}><SchemaItem collapsible={false} name={"taskResultId"} required={false} schemaName={"uuid"} qualifierMessage={undefined} schema={{"type":"string","format":"uuid","description":"The id of the task result.","example":"2b838de9-db9b-abcf-e646-d4f274ad4238"}}></SchemaItem><SchemaItem collapsible={false} name={"reportName"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"My annual report","description":"The name of the report."}}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={false} name={"hasTimeBasedAttr"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"description":"Indicates the value of requiresPeriodicRefresh attribute for the Identity Profile.","type":"boolean","default":false,"example":true}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"[\n {\n \"id\": \"id12345\",\n \"name\": \"aName\",\n \"created\": \"2015-05-28T14:07:17Z\",\n \"modified\": \"2015-05-28T14:07:17Z\",\n \"description\": \"My custom flat file profile\",\n \"owner\": {\n \"type\": \"IDENTITY\",\n \"id\": \"2c9180835d191a86015d28455b4b232a\",\n \"name\": \"William Wilson\"\n },\n \"priority\": 10,\n \"authoritativeSource\": {\n \"type\": \"SOURCE\",\n \"id\": \"2c9180835d191a86015d28455b4b232a\",\n \"name\": \"HR Active Directory\"\n },\n \"identityRefreshRequired\": true,\n \"identityCount\": 8,\n \"identityAttributeConfig\": {\n \"enabled\": true,\n \"attributeTransforms\": [\n {\n \"identityAttributeName\": \"email\",\n \"transformDefinition\": {\n \"type\": \"accountAttribute\",\n \"attributes\": {\n \"attributeName\": \"e-mail\",\n \"sourceName\": \"MySource\",\n \"sourceId\": \"2c9180877a826e68017a8c0b03da1a53\"\n }\n }\n }\n ]\n },\n \"identityExceptionReportReference\": {\n \"taskResultId\": \"2b838de9-db9b-abcf-e646-d4f274ad4238\",\n \"reportName\": \"My annual report\"\n },\n \"hasTimeBasedAttr\": true\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> |