LukeParke/developer.sailpoint.com
1
0
Fork 0
mirror of https://github.com/LukeHagar/developer.sailpoint.com.git synced 2025-12-10 20:37:47 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
ad727a2d67247b2eb97e69ea22fb548da334f9cb
developer.sailpoint.com/docs/api/beta/get-potential-role.api.mdx
darrell-thobe-sp ad727a2d67 test embbeding
2024-03-06 15:22:04 -05:00

99 lines
40 KiB
Plaintext
Raw Blame History

---
id: get-potential-role
sidebar_label: Retrieves a specific potential role
hide_title: true
hide_table_of_contents: true
api: eJztXOtz2kgS/1emdB822bIwYB7GX66ITXbZ84MDfKk7x5UdpAFmV0iKRkrCufy/X3fPSEggHuuk7nb3+JLI0kxPv/vXoxFPVhCKiMcy8PuudWHNRDwIYuHHknvDwBPWiRXzmbIuHqx+t8/wFruRvvRn1uOJ5QrlRDLE2TB3PJeKLUQ8D1wWiTiJfMU4U6Fw5FQ6LEzpsgipTIMIntLlgggyJZQCShVYM+QRB0oiwpWfLInkQx7P4ZEPD+AvMxiYPrGUMxcLbl08WfEypIdxhBw+n1iR+JjISIBocZSITY5FGQdMIlXxhS9CD8mdO7VOVbTa9nmbc7sh3I7NO9WJ7Xbc5lmj0ayfTSewWCmfYV6bX8dtd12F0mXSL1fiC/h/xPVVGPhAArmrV6v4X5GHUeI4QrjCrbBhZmJPqpgF0zX21G4TO4GPo3EJHoaedMgJT39RuM7TppaCyS/CidE3InTZWGounUjwWLhvlvuHglU3lL6u4/4VChKDXxDhICoosu50aufVTrXdqvEm50611m7Va02n0eKtuts8Rxu6UoUeX96S+fcthw5oJjB0mF2Ld9XcE8vKQIrIEdYzLBXLmJ70QOnx8jLVxNX4rnSh1LuNythkyVwRc+mpCjEufAVkckxLsNBMROVc69HIMF8zfCXPdrt5YoEfLHisCZ7V9Vo5egcpaXVn75JWlsF0vkI37DpOkMA98EFXhDHygENAfwv4/xKfHSi4nywmIkImcgSUDsQdTNVL9SC+OF4C0dTLkdoMOlw2jbHcohD/isUBmwiW0sEljQw8ivgS/pSxWKjSbJPx9mBV27w6aYg6jK+d4QWvWo8wZAoZYe6D3xyonGz8C/1CukL78osMYmZDuL/QHOnyVxK1NElS/1zLEWYU47EeRTGcTTjABlsSVEbvsOTRd9N0URS0EAvg7TyK0V1McioIdiif3HUlzuHeoMDxmk8VnConzz+4l+C42xs2hvTFzij/k4lbz4/5VIYBq/FFv8wWzzkj9d09oYLhscUPvmWM+AcZ6zaX3XflrhH/BKl5LYPZrNo+rVWRIfCYTxLT+CiGJF6ugGwMlVwcty0c13kWEEwo6+Bu3Lsd97vXcG/Qu73q3/4AV5d3N4Pr3rgHl2+7/eveFWLAXNrNTdq0ZwFWDopSgFwfE+4dXn3M6L1ZplatlsV5pLHYQZVHj91fdFL3sNu83bIbjSm3Jy6ALKfVaDUbk1arWevg2goNnFt6EgAp7peuXVzvO8VoMpk0UYXlES8icYP+St0irf8rcL3dIb8eSeGKKzS1D6J2pmetaVM07Zo4rwFEdUB71fO23Wycd5odt1Nz2jXr4GDLSZspjWYCgcTz+CRV2WbkDW/YyOgpF3XA+W2y6Gf1pe8Xu6T9XotBsEgWB1erXazWS506jBJfjOdYgQPPPTCQaBJYyMwycCJRoAlATcgB3nK45yQe5pEwIhIT4Q6Ky+1gt7TU7gqDKU+8eHvHtm5ZHQ5l0eAE4ZYUSY/WrIA4McYedo+zPhVL0AMkQaAO8SQ5umSQAD6voLtdXPGYjxwpfEfgpRJUS9Oq+FZ6MOkym/q03jtAgYy4r1Dx2JtfB7pHuoAOnC8kapHDxGs+Ed5hw11gomSdbNrfxJJ6oNtK/wpT+fifH7rj8bD/5n7cG1Wu7y674/7d7SoOLc+sAWLpfQToWaAf+ft993oE9z5h3afNA80ClPrn/bmlUN4PrtS7cMBBJi7k04f9vd5J2ZB6vZqNadQJHzg5A+9PW+8hh/PImb+3WDoROOYxFnU3cUCG+GWibU98ezz2eafLHoYgS+0zJWIrMV8swf9H4JSiZFOrRpTpsthaz3jDnEJXZYbGbseAo0HvEsBc/1+A8wj73YAEBcBXHLHJHF6Nl5oxVQ5Xh5um1oh1B2OXw153TEveD67MlVF7vzf6cPdm3O3f0t3B8P6292H847A3+vHu+qrwKAWrH4Z31zBrMLy77I1GGuiuP0xXLEi/YmO7WVJ0i+UGbt/Q5mjJrpp+nG6eUvkFTOAkUYR9fnk92qaem+7tPWHw7v347sPwpsh19nSnL6143el2gwxJXsXBS9xvVw/yLf2vVIgihNMR1ijb9Lz0JJqhF0WQoWyz8YkmMthWfIRgjdkkcJdMIpqD8JXuN9zk1Nt0l4F7APZ9K31hzyIukUNBLDswUTeFLnlZEAmz85fCcxpX7GdAE5Uae8MBEhv5Lo0wqMyIO79Sk76foXtfwnyWTsFda53pS5cVbcEnrWqn3pi2GpzXzxu1dnPSmfKzsyp0AtRCLcD7+EyU4YPi0j8IHyqLwzDbevLfAt9LcNA9MUCLH745QzQO7D302ExMwy+LxZf4BJD+m8sBa7SZx/1ZQvf5bE0Jvn0/2qh4ILkmfBfJmSzdOE1j56r3tnt/PYY7Q6gpvRFcIa2NVzZdH7zVRbcMqCeZB581vtACfOaAsYUH6sAN/+8N1e9BIKh7+YFS/6WWCpTJDIKHGWb1khl50mwaBYtCKFHcfInZK1kRlRNoSeAeNBDOnE049SY+Df++6zgijO1ro8nv2VxwV0SvK6yb7VgxXUxh/hJ7G+66OrsigWkCoQzMSMh1Scz8IJbOWl+/UuU6/kgzynXeKBgcwPl+P+k6cYJZEMXMR2HmLYZFYx/gWWuuyN04pzRS6dKPuQNScM9bghqhgDiQmUA2GStm0hGaS0Hi8dNxWcYqvFVAbm40M5TeEcvyRB0QdwMP0o9NomUPPgkTfLRnrbMRWSM1k8lI8BDFpslmVGauNPABOgrqOY+xe4zdY+weErvrD4fmVa95StCntgl97n2egH4jKp4b0Cci7/EDlg4ieGMMeYI7SAYi/fRuDIH9q/BxvPgS4kvub4iPdCnfYL6b2UPfnyD8yIxVsAUySHrUEkwhEwn3gvhecUyK0qo621ztbRBNJDioXwIRIWtGbBkkjIPKosQnKMzVCXMDofzvYjbnkB85RIRSOgPiqr5rh4H04yOSPCLJYzU6VqM/TzU6Islj7B5j948ZuzuRZMYVRYvBSSpZLHi01J5mnusX6jCApYcOWRZyn/RxkSJaQWIsw1hWETlYk3ptUpu2HdFwecNtnXWmdadV5812rV2bNOptK1/rH1ZxnAVZMaZy9tZ2NC8eo0+A4xIfnEvFQeAWt/9AvZGYYlrD1JPhZtA5qPQxw471TskrySBgN9xfpghJFTCkv9IR5jQYu8CxUTqWXh/PIC/6DFKVDPS5ILnAgyMRvrX15EJS8KIUQDda2t0pvnvRgZI6WbaK9Ok4maJM4AWImgNwLAlCiiliPqBACHYG2fkbolNjoq9C8myIEl+jxKz3RR9WZRlyb5bt7/aB+QhzxEgbeMtGr+52uA8OAA2BzlkZ7jzi8yM+P9b4Y43/c9T4Iz4/xu4xdv+Ysfsb8LlBQ9vxOQw4GJ/D2EqVZVjqLR3i+2/DdAoVwwG5NwscOkbhrjA44Qp9EAO/d8Mcgp9sXVineNDC1gcVbHPQQp0+ZZ+aPZ9mpxdsGqoVB6nn9GntO69nCw/jIprUgiSRBwvM4zhUF6enTzAW7Ppc4aGspAfe/OBzxQkWpxNQakm+woMFOjZxAOsO+qYfqZBFIolOrzMkEdf2MUcpLQV2or3knZTTT5CWQQI5kcic4DkN44B0G1gMofv4TtHoCjnchnwg133kPX+9LJrQFlnK1LdzNRjPgNM1EVGERzQXOAodQQd73QM/lzq9dRN0jofH/JgRwnnN4cbIVYnCFrC+wdAdDquzN4JH0GvotyKvfno3fs1mCGIpiSQK8bOQ2HVAGA7AjShJdtM3BDiJ6lYUJLM5CdctvIPBoGRTD5TC3vsjIdhD+kHFLVSPIaR7UjtOEpRhcNbjq9SCrvgkPCyslZW20Tml65+CFk95Yd5rKqLUbUhfn/XFM3vvfZtdScxtGEg0xohIzSN7CFO5eE6ulzLxl5SaranZRE29XuNCq/bB0Wd6HMgMOm4VaevFi2t6do4etmZwB6mu84CaMHwU35w5qdVezEeBno30iny899/NJVTo4rT05JmCAuu5rM+ceRAo8VfG0HUwVB5mCUTai9n6jIvaFBF2vZpjydZL2tIGvEn8XUNg+NqZ+ATrPcGdAJCg7+qw/ZksC3nhZ+jGXfZzQWa6/QBlGUe6gaNezDMuaOOCts4TyvBvPpoEZiG2UQb9ISo5wOXK/pQJDKO53KhplWZ+In9Kcyxzep2oqPBC/3GxSoLmSh9kx9HZGEjVCNezd4nwNzO0sPQVlJVuNKxrcJNfL4CKu6Y3zW+20YVV+PcmL0rcXe3H3Pne8ltn6S2Z5PeTd/9HGe+Yaf6MmcYAaHQ3WtZ0Gnknf2Mw3eb+IG5gzwX8C08pVgmrQydEvR2hmDyh0OMxejVFtTOXgnYWQsFjxIcn6FnBgiIxjAIMf+gfidCMvnCPgGUOvaDETwVp7ztdmVPAaPCJdsW/VULtDX3uNIdOVVTYO2j2fAfMgo0ent6AZ78EpuMbgWUGaFh2lRobQNdikfj4YSKwnSwYB5fa4xGuVE6iExf0fb5IdREQ9MtmpVGMroYi0MFpES3U3RQ3raEfzhl+z1pgd2V2rEH1aEXzUcJKkKHwyDNxXBHa76MN3mbPhRdiqwlZFwCYyK1w0x9vUARivvkEJYhmp2aSOsWxQARbKO0+Z5VapWpTS4GfuwUqhuY4RxxfbKCP7PjVkXWXfFrt23/Lny8xpQV7gtMQd8iQ4UT3MbrXfLDKek2YepH/YZNt7SaOW/9hEehO5qASJP30hPsv2IA94+2PicDmHr9TS3sr6nHAZHgNbfAUksj6p3Z51bwamh8meU1vkLb+ZEqp3On+ob9cbR1YcPkrfTOzEhfbyBex9Bt/F+UFTK7r+hm/69KbWKRJPUpvc+Xmb7wIwhYy23r4oQf+/fwfjEjbpQ==
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 a specific potential role' (get-potential-role)"
---
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 a specific potential role</h1>
<MethodEndpoint method={"get"} path={"/role-mining-sessions/{sessionId}/potential-role-summaries/{potentialRoleId}"}></MethodEndpoint>
This method returns a specific potential role for a role mining session.
## Request
<details style={{"marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collapsed={false} open={true}><summary style={{}}><h3 className={"openapi-markdown__details-summary-header-params"}>Path Parameters</h3></summary><div><ul><ParamsItem className={"paramsItem"} param={{"in":"path","name":"sessionId","schema":{"type":"string"},"required":true,"description":"The role mining session id","example":"8c190e67-87aa-4ed9-a90b-d9d5344523fb"}}></ParamsItem><ParamsItem className={"paramsItem"} param={{"in":"path","name":"potentialRoleId","schema":{"type":"string"},"required":true,"description":"A potential role id in a role mining session","example":"8c190e67-87aa-4ed9-a90b-d9d5344523fb"}}></ParamsItem></ul></div></details><div><div><ApiTabs label={undefined} id={undefined}><TabItem label={"200"} value={"200"}><div>
Succeeded. Returns a list of potential roles for a role mining session.
</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"}>createdBy</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
The session created by details.
</div><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></div></details></SchemaItem><SchemaItem collapsible={false} name={"density"} required={false} schemaName={"int32"} qualifierMessage={undefined} schema={{"type":"integer","description":"The density of a potential role.","example":75,"format":"int32"}}></SchemaItem><SchemaItem collapsible={false} name={"description"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The description of a potential role.","example":"Potential Role for Accounting dept"}}></SchemaItem><SchemaItem collapsible={false} name={"entitlementCount"} required={false} schemaName={"int32"} qualifierMessage={undefined} schema={{"type":"integer","description":"The number of entitlements in a potential role.","example":25,"format":"int32"}}></SchemaItem><SchemaItem collapsible={false} name={"excludedEntitlements"} required={false} schemaName={"string[]"} qualifierMessage={undefined} schema={{"description":"The list of entitlement ids to be excluded.","type":"array","items":{"type":"string"},"example":["07a0b4e2","13b4e2a0"]}}></SchemaItem><SchemaItem collapsible={false} name={"freshness"} required={false} schemaName={"int32"} qualifierMessage={undefined} schema={{"type":"integer","description":"The freshness of a potential role.","example":75,"format":"int32"}}></SchemaItem><SchemaItem collapsible={false} name={"identityCount"} required={false} schemaName={"int32"} qualifierMessage={undefined} schema={{"type":"integer","description":"The number of identities in a potential role.","example":25,"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"}>identityDistribution</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
Identity attribute distribution.
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"attributeName"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Id of the potential role","example":"department"}}></SchemaItem><SchemaItem collapsible={false} name={"distribution"} required={false} schemaName={"object[]"} qualifierMessage={undefined} schema={{"type":"array","items":{"type":"object","additionalProperties":{"type":"string"}},"example":[{"attributeValue":"NM Tier 3","count":6}]}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem><SchemaItem collapsible={false} name={"identityIds"} required={false} schemaName={"string[]"} qualifierMessage={undefined} schema={{"description":"The list of ids in a potential role.","type":"array","items":{"type":"string"},"example":["07a0b4e2","13b4e2a0"]}}></SchemaItem><SchemaItem collapsible={false} name={"name"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Name of the potential role.","example":"Saved Potential Role - 07/10"}}></SchemaItem><SchemaItem collapsible={false} name={"provisionState"} required={false} schemaName={"RoleMiningPotentialRoleProvisionState"} qualifierMessage={"**Possible values:** [`POTENTIAL`, `PENDING`, `COMPLETE`, `FAILED`]"} schema={{"description":"The provisioning state of a potential role.","type":"string","enum":["POTENTIAL","PENDING","COMPLETE","FAILED"],"example":"POTENTIAL","title":"RoleMiningPotentialRoleProvisionState"}}></SchemaItem><SchemaItem collapsible={false} name={"quality"} required={false} schemaName={"int32"} qualifierMessage={undefined} schema={{"type":"integer","description":"The quality of a potential role.","example":100,"format":"int32"}}></SchemaItem><SchemaItem collapsible={false} name={"roleId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The roleId of a potential role.","example":"07a0b4e2-7a76-44fa-bd0b-c64654b66519"}}></SchemaItem><SchemaItem collapsible={false} name={"saved"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"The potential role's saved status.","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"}>session</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
The session parameters of the potential role.
</div><SchemaItem collapsible={false} name={"id"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The ID of the role mining session","example":"9f36f5e5-1e81-4eca-b087-548959d91c71"}}></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><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={"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={"saved"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","default":true,"description":"The session's saved status","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"}>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={"type"} required={false} schemaName={"RoleMiningRoleType"} qualifierMessage={"**Possible values:** [`SPECIALIZED`, `COMMON`]"} schema={{"description":"Role mining potential type","type":"string","enum":["SPECIALIZED","COMMON"],"example":"SPECIALIZED","title":"RoleMiningRoleType"}}></SchemaItem><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><SchemaItem collapsible={false} name={"scopingMethod"} required={false} schemaName={"RoleMiningSessionScopingMethod"} qualifierMessage={"**Possible values:** [`MANUAL`, `AUTO_RM`]"} schema={{"description":"Scoping method used in current role mining session","type":"string","enum":["MANUAL","AUTO_RM"],"example":"MANUAL","title":"RoleMiningSessionScopingMethod"}}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={false} name={"type"} required={false} schemaName={"RoleMiningRoleType"} qualifierMessage={"**Possible values:** [`SPECIALIZED`, `COMMON`]"} schema={{"description":"Role mining potential type.","type":"string","enum":["SPECIALIZED","COMMON"],"example":"SPECIALIZED","title":"RoleMiningRoleType"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"createdBy\": {\n \"id\": \"2c918090761a5aac0176215c46a62d58\",\n \"displayName\": \"Ashley.Pierce\"\n },\n \"density\": 75,\n \"description\": \"Potential Role for Accounting dept\",\n \"entitlementCount\": 25,\n \"excludedEntitlements\": [\n \"07a0b4e2\",\n \"13b4e2a0\"\n ],\n \"freshness\": 75,\n \"identityCount\": 25,\n \"identityDistribution\": [\n {\n \"attributeName\": \"department\",\n \"distribution\": [\n {\n \"attributeValue\": \"NM Tier 3\",\n \"count\": 6\n }\n ]\n }\n ],\n \"identityIds\": [\n \"07a0b4e2\",\n \"13b4e2a0\"\n ],\n \"name\": \"Saved Potential Role - 07/10\",\n \"provisionState\": \"POTENTIAL\",\n \"quality\": 100,\n \"roleId\": \"07a0b4e2-7a76-44fa-bd0b-c64654b66519\",\n \"saved\": true,\n \"session\": {\n \"id\": \"9f36f5e5-1e81-4eca-b087-548959d91c71\",\n \"name\": \"Saved RM Session - 07/10\",\n \"minNumIdentitiesInPotentialRole\": 20,\n \"pruneThreshold\": 5,\n \"saved\": true,\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 \"type\": \"SPECIALIZED\",\n \"state\": \"CREATED\",\n \"scopingMethod\": \"MANUAL\"\n },\n \"type\": \"SPECIALIZED\"\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>
Reference in New Issue View Git Blame Copy Permalink