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/update-entitlements-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: update-entitlements-potential-role
sidebar_label: Edit entitlements for a potential role to exclude some entitlements
hide_title: true
hide_table_of_contents: true
api: eJztXOtz28YR/1du0A+xPQJf4kPSlw4l0QkTSWRJqp5W1jhH4CgiAQEEB8hmNfrfu7t3AAECfIRx2ySlPWODwN7dvve3h8eL4Qci5JHje33buDDiwOaR6HmRE7liIbxIDv0I/nO4O/JdYZwYEX+SxsWD0e/2GZ5it47neE/G44lhC2mFToCTwVSTuSOZ8OzAd7yIcduWzA9ZKBb+s8ALqyXYLPQXjHtMfLHcWMJw5joyYjOg5yxIGGAhLFcBFgIe8oWIRIiMvBgOrhbwaA6XPLgAv6SQUol0YkhrLhbcuHgxomVAF6MQGX49MULxS+yEAgSPwlgUBRC0JFuQhExPyhycVXzhi8DF6c6s+nlNtDvmWYdzsynsc5Of16amfW63TpvNVuN0NoXFSvkMssr9bdx21xQFbDLHA/2ViHAA/49qfSGjS99eIn/55UclisrYqci95XvILs7Eg8B1LHLC6k8Sp3sp6sGf/iSsCK0fostGjpB41bFlkRm0HHmQP8s6GqhEsshnU8GE7UQC9a1n52HIl/ATzi5kifZfUWPgnLbIXJz6IDRHbeaX788YyYhOn10z590VBmQz7kqgU0FBpBQK0bxArVnQRtNyPxggVd+uoz3xoIFRmPKJPMAgEl9bSMVqLqR7oIlsvMNCr+RsMvA9qZTcqNWLSu7ujug1l/wmR1SQ8Kv5hBUKSGL25XIf9ykau2DOa/QjtAlN7Ie58GlY5/Wz2nmt067zFudWrd5pN+otq9nm7YbdOsPItR0ZuHx5R0G/azl0Xj2AYZrYtnhXzl2xrAwdEVqCXCSxNpl0eZVo4noyKF0oCVWtMjZdMltE3HFlhRgXnoRpMkxDLhdPIiznWlEjw2VpO2W70zoxILcveKQmPG2otTLz7aWk1ZmdSxqpz6uihaWla1l+DOcgY9kiiJCHjHte4bU9BffixVSEa9lGqvS7halGqR50/Nq5oDwkxel5KvtnuQxvD0atw2vTpmgAff0UD3jNeASSGaSGuQd+s6dyUvoD/cKxhfLlgwyiR0O4H2iOZPlrB7U0jRP/XMsRmorxSFFRDKcD9rDBhgSVzrdf8ujbSbrIC5qLBfB2HkboLjo55QTbl08obg6O4e4wx3FZ5UycKiPP37kbI93dLZtA+mKnlP/JxO3Xx9fSwtUvs8Vrxkj9XWgAw2ODH3zNGPH2MtZdJrtvy11j/gypeS2DmazWqdZryBB4zLODaXwcQRIvV0BKQwAN6TaF4zrPAoIJZR0OJr27Sb97A+eGvbvr/t23cHQ1uB3e9CY9OHzf7d/0rhUESdNuZtAOIDLMSwFy/RJzd//qo6l3Zpl6rVYW56FC4HtVHkW7u+gk7mF2eKdtNpszbk5tgNZWu9luNaftdqt+jmtLNPAewHJScBSAVDSYTBrL3PIa/yWYv9QtilB9s0P+diSFK67Q1K7G5Hx22p61RMusi7M6NCYWaK921jFbzbPz1rl9Xrc6dWPvYMtImyqNRsIEsevyaaKyYuSNbtlY6ykTdcD5Xbzop/Wl7+Vb5d1ei0GwiBd7V6ttrDZKnToIY09M5liBfdfeM5BoEFhIj9JwIpagCUBNyAGesrhrxS7mkSCkKabCHuaX28JuaandFgYzHrvR5j593bIqHMqiwfKDDSmSLq1ZAXFihBsZO5z1JV+CHiAJwuwQTw5Hl/RjwOcVdLeLax7xseUIzxJ4KAXV0qQqvndcGHSVDn1Z7x2gQIbck6h43K+58VWPdMFuHb5wUIscBt7wqXD3I7eBiZJ10mE/iCX1QHeV/jWm8sk/PnUnk1H/8n7SG1duBlfdSX9wt4pDw9VrgFhqbwl6FuhH/nbfvRnDuWes+9S7KhYeqd3clVty5X3vSr0NB+xl4lw+fdjd652UkTSgfU5omg3CB1bGwLvT1kfI4Ty05h8NlgwEjnmERd2OLZAhOky0zYlvh8e+bnXZ/RBkqX1mNNlKzIMl+P8InFKUrGvVmDJdGlvbNuxWZYZoN2PA8bB3BWCu/0/AeYT9bkGCHODLUxSZw6PJUjEmy+Fq2VaiIt3M2NWo153QkvfDa32k1d7vjT8NLifd/h2dHY7u73qfJt+NeuPvBjfXuUsJWP00GtzAqOFocNUbjxXQXb+YrJiTfsXGZrMk6BbLDZy+FdHct4taGKvLbEHXVfkFTGDFYYh9fnk92qSe2+7dPWHw7v1k8Gl0m+c6vbrVl1a8bnW7YYokryP/EPfb1oN8Tf/bvTWqt0KbtVqR/yvXQTP0whAylMlGIopDD02ksa3aK2dT314yB9EchK9jf8VNTrVNd+XndqQ3FJH3jifMp5A7yKEgli0YqJpCm7zMD4Xe+UvgOdHl+xnQRKXOLjlAYi3flRYGlRly62dq0nczdO85MJ4lQ/Behcr0pcuKjuDTdu280Zy1m5w3zpr1Tmt6PuOnpzXoBKiFWoD38SdRhg/yS38rPKgsFsNs6zr/AoWEgoPuiQFafP/NGZpjz95D0aZian5ZJL5EJ4D0L6+GrNlhLveeYjrPn9aU4Jn340LFA8nVxIPQeXJKN06T2Lnuve/e30zgzAhqSm8MRzhX4b5d1wNvtdEtfepJ5v5nhS+UAJ85YGzhgjqEXWHv9KzvQCCoe1lCR/2SSwnKZBrBwwi9esmI7NSrGyFJKFHcfInYG6ciKifQksA5aCCsOZty6k08In/XtSwRROaN1uQ7NhfcFuHbCuumO1ZMFVMYv8Tehtu2yq44wSyGUAZmHMh1ccQ8P3Kstb5+pcp1/JFklJusUTA4gPPdftK1ohizIIqZjcLUWzSL2j7As9JcnrtJRmmk0qUXcQuk4K67BDVCAbEgM4FsTiSZTkdoLgmJx0vo0oyVu6uA3NwqZii9I5blsdwj7oYupB+TREsvPAsdfLRnrbIRWSMxk85IcBHFpsGaKjVXEvgAHQX1nMfYPcbuMXb3id31iyN9z1dfJehTcuP33uMx6Dek4lmAPiF5j+ezhIjgjTbkCe4gaYj0/YcJBPbPwkN68SXAhwO+Ij5Spbx41zq1hzo/RfiRGitnC2SQ9KgkmEEmEvYF8b3imBSlVHVaXO29H04dcFCvBCJC1gzZ0o8ZB5WFsUdQmMsTZvtCet9EbM4hP3KICClVBlTP05j0QM0RSR6R5LEaHavRn6caHZHkMXaPsfvHjN2tSDLliqJF4yQZLxY8XCpP09fVDXUgYMnThywNuWf1uEgereBkLMVYRh45GNNGfVqfdSzRtHnTbp+ezxpWu8FbnXqnPm02Oka21j+s4jgNsnxMZeyt7KhvPIbPgONiD5xLRr5v57f/QL2hmGFaw9ST4mbQOaj0McGOrbIdxj5YJEQvHaslNmw1KrzNPWABIKmKmhT5HBHiESEeq8yxyvw5qswRIR5j9xi7f8zY/RUIUaOhzQgRCPZGiEBbqbEUS72nx8j+20CRQkVzQO7NfItu5NsrFEi4Qj0KYAS+pCSC74pdGFW812+qe+Wmvtcvqy/pO26v1fQGuomkcG3tvbLXKr7vZGZfTjDwwVDElUqkOHRhpXkUBfKiWn2B0WDh1woPnEry8JXnf65Y/qI6BfWWZC68ya2iFAlYd9jX2LhCtgkddH+VK2lyZSn9WJ8hwWK0r7l15uR1mKUfQ3akaU7wmQHtinQaWAy4t/xGEnWFXK8gH8h1H7qvv10WNdEGWcrUt3U1oGfA6ZqIKMIjmgtchh6HBnvdAz9XKtF1Y/SSh8cszRiBveKwQLkqVtiONAoMDZCswS4FD6HrUDv0b77/MHnLnhDOUjqJJSJp4WD/AQE5BDeidNlNdqtxEFWw0I+f5iRcN3c/AMOTzVxQCvvojYVgD8nD/XdQR0aQ+EntOEhQrsFRj28SC9riWbhYYisrbaNzOrZXBS1WeW7cWyqn1Hc4nnruFJ8f++iZ7NrBLIcRRTRaRNqKZw9BIhfPyHUoE39JZjPVbCbNJt+ucaFU+2Cp50ssyBEqkiVp6+DF1XxmZj5s0uAMzrrOA2pC85G/i2MlVjuYj9x8Js6X5+Oj92HuQK3OD0uegpJQal2b9Zk1930p/soYug6GysNTDJF2MFufcVGTIsJs1DIsmWpJ0zEBeRJ/NxAYnnImPsXKT8DHB0zo2SpsfyTLQl74Efpym/2Yk5lOP0CBRkrbt+TBPOOCJi5oqjwhNf/6BT5gFmIbZVAvRZIDXK3sT5lAM5rJjWqu0sxP01dpjKGfpKZZZHChflyskqA+Ug9VI3VKA6kagXt6Xwt+Mz0XFsGcspIth3UNFvl1fai9a3pT/KabLliPf2/yosTd1c7MwHOXXztLb8gkv5+8+z/KeMdM82fMNBpK4w7naPW9gt4hL86jyxLrum/JBsqlxoXF3UaJr84I+BeuUrwT8oe+ijpFQkLZiQKXRxgZlBmsuSNonyIQPEKMeYLe6S8omoPQxxQC3ShN9ERvbIcgNofO0sFX3ypsslqZU9ApAIu+gb9lTM0Svb4zh75XVNgHaB09C0yLbSM+jQDXfvJ1/zgG6w7p8x3XicMAcFssYg9ftAO24wXj4JY7vMp2pBWr5AddpCcSXfgEH9NRSSZAd0UR6EFgES7kYIZb4NBdZ5xnx1rgO1Lvf4Pq0Yr6IfuVICPhkncjXb492DU3eKw5F26AjStkbgBxIrPCbX9SmBEm8/QrFX74VNWDZBVpYRJsw5T7nFbqlZpJbQm+vgV9ILTamcnxaw1rX1oo+UgKalp7M5P+QuRGrLvsy+ouwX/wmy26mmEbUg1wew7li1XrpPrcB6Osz4WhF9mvuay1uni5+BGVYrcL4T3HphpWeXnBfSBs/17xNOQI3GTAN7aSzo46LDA2HkM7rj7SsVlpb0b60yZv2aT8tUb1yZhSFST7mN5ytYVhwOHP9PbISnJsYg9i6Vd+F+YAJtf1/4pvOKnNNNKkotJ3b8yJesMkmaVwWwoFVSPUBt1W2sfMpslwgFuVxlR/nmah9n9C/hlO4r8Xxkf4a+DLNSrsgYjOvxjJbirQqHnxz78BPWht1w==
sidebar_class_name: "post 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 'Edit entitlements for a potential role to exclude some entitlements' (update-entitlements-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"}>Edit entitlements for a potential role to exclude some entitlements</h1>
<MethodEndpoint method={"post"} path={"/role-mining-sessions/{sessionId}/potential-roles/{potentialRoleId}/edit-entitlements"}></MethodEndpoint>
This endpoint adds or removes entitlements from an exclusion list for a potential role.
## 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><MimeTabs className={"openapi-tabs__mime"}><TabItem label={"application/json"} value={"application/json-schema"}><details style={{}} className={"openapi-markdown__details mime"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-mime"}><h3 className={"openapi-markdown__details-summary-header-body"}>Body</h3><strong className={"openapi-schema__required"}>required</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}><div style={{"marginTop":"1rem","marginBottom":"1rem"}}>
Role mining session parameters
</div></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"ids"} required={false} schemaName={"string[]"} qualifierMessage={undefined} schema={{"description":"The list of entitlement ids to be edited","type":"array","items":{"type":"string"}}}></SchemaItem><SchemaItem collapsible={false} name={"exclude"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"If true, add ids to be exclusion list. If false, remove ids from the exclusion list."}}></SchemaItem></ul></details></TabItem></MimeTabs><div><div><ApiTabs label={undefined} id={undefined}><TabItem label={"201"} value={"201"}><div>
Adds or removes entitlements from a potential role's entitlement exclusion list.
</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={"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