mirror of
https://github.com/LukeHagar/developer.sailpoint.com.git
synced 2025-12-10 04:19:42 +00:00
105 lines
46 KiB
Plaintext
105 lines
46 KiB
Plaintext
---
|
|
id: create-potential-role-provision-request
|
|
sidebar_label: Create request to provision a potential role into an actual role.
|
|
hide_title: true
|
|
hide_table_of_contents: true
|
|
api: eJztXOtz2kgS/1emdB82SVkYMBjjL1fEJrvs+bWAK3Vnu7IjaYDJCkmrRxzO5f/9untGL5ABO7nsbpb9kDXSTE+/+9cjaR4MPxAhj6XvDRzj2LBDwWNx5cfCiyV3h74rrkL/k4xgwFD8nogoNvaMmE8j4/jGGPQGDIewc+lJb2rc7RmOiOxQBkgQyI1nMmJzEc98h0UxD+OIcfbRt1jssyClC5eCdEEWAjlYIeAhh3kixHUeDInEAh7P4JYHN+BXJKJIcb1nRPZMzLlx/GDEi4BuxiHy87hnhMC0DAXIFoeJWOVP0IpsTgIwTZRJpCo+83ngIrkju9Gti8OOedTh3GwJp2vybt0yna7TPmi12s2DiQWLVfIZFHX5Zdz2lvQEbDKJ6qsQ4Qv4ByuHi1wAoGviorEr5vB/M/CDxOWhjHFMmUF0g3kyZ/kQlkrEJn7IuMcKlNAJLBDCs93EESRKDPbI/AIuoWA1o6iXCXcjUEwUL0gyoDonUQPXd0SqthUNSy8WUxESwxOeuLFxXN9DyZBd9Tf/rP5u1OuPT6lCs2ra/nzueya3bVD2ihbe+sA1iOqg/2qr3M8gCETI1EymZhaVEbF76brfSh+WYrGoDxz5+HinaEOYv/WdBc4oyzZMzSk9XIoSB9pR5Q1wRU/cpzFs+x56KxLhQeBKm0bvf4yQ0sMqU771UdiYXkBiSEqxFBHeRWoXpP/lgFlWPI5i/oS0lvIBGkX9K/7KUf1OetyzBTNZz7b9BGyhgxCmnRYJb1p3NPPDmBWuPYOJH4UH+ddNPYKiJOMGaEIijNE/kDH/HsZimt7E0OA05UA65GML+MFj5WJABX5BXtZmynlpWu3DI/uwbdkHdstud3jrwHK6HXHAj0SrYUBY5IOLdqnWZIUit5e2IOxGtqAeYRShd8KCqhStr2CPj4+UbKPA9yLlZc16c9XbQRoRgMVqbCjiJPSilVLFomQ+5+FCRy1KgWqHWhcnUWoEFcHgFmFWQb9SbMhtnMHJ+FiusrnpRd22207HMa1JZ2K2JkcN02ryiXl0dNS26l2n220eoKa9ZwfimkUzIykQYTLFBa5TqppDMVm1zamIuXTBIpafxNUr/S11tzkcUJ0wKk0NJxh+T9TKZazkJXMLqhiwp2eDLhUEKbOKNUrVB0XwoFlkvtnGTJLXvpdxUCqez+ah0S6o4MfQT4IRxexmA43z+Mb8Rak0S7NTpATVXtozZgMGgHp+awz7v1z3R+P+6a3BYMatcfl23Btc4O+STdPLFABpzkK2xKr7j0tZJhuNCSjjakkf7CRl6Opy3L8YD3pnt8Ye/uxfnA4uflQ/3vUGZ8jZnmL15PL86qw/7t8atbL/qTl5lGXaEh7CqJt8EbiWj07pwZ9qJWwats3fShe6RD+vEC6jKPSYweAXFHJwelFj7CKB2ignVZpjMx4xz49BecIrUkKVeDCPW26GtQrllLcscTix7AnULXF4aHXbvG432pOJ0+5S3QKviRBHb+f6ejT2U6G02au6CVj1tRKwwto/ySkiznTWJ+4mFKwOFhuQSd2O5FxqqM4BmU6juIgbILzXh1G3DmJMoJLOPITC2wmSjX+mKPm8ZWGqjIadpx+C2mQE6MKO5SeB8BsgBrgAQFbxmW5MafQGMTso5u8Jd7e3lh79TBHTWdsIiF6JVsxMzD0n19F6gY5QICXFCsQvNJP5iji2tibaR1f9E4j1wX8goinKzy8vMLTzcCiPWA15/GuM1IGztImtTnu6Sc/3CKrrZYHdL4AAuGKeRjZ12t3JweGkLdpmQwAMaAmbm1b9qGO2W0fdNkCBht1pbI8FCtL+ELGIfwLPpZnr0s6Ihg3P2UjryWT1zn6jjssC5xfJfJAF98ArJdotXDtt8bdFAutYbdZXXJQqX+KJ8Qz92HedLaONJoGF9Cy9tZBEoAnI8MgBdanctRMX4ykIiYQlnKvycmvYbVdxS0bZ3FlvY1lVzovuRD05tu9+VaASDby1ZIWs/m9w1ocM/wwc3GaDaAXqEE+So0v6SWiLGrrb8SmP+ciWAno8/DMSGEo8Bqe1kli8ky5MOsmmAp8yCly+SLt2QHch9yKXmt9j48xX3c4xO5d8LlGLUID4GbeEu91wB5ioWCeb9i+xoOJ/URucIgYZ//tDbzweDt5ej/uj2tnlSW88gPSUxaHh6jWw76T9UD+EqwDbemcjuKayMaY5xcId9Y+bcktBt5l78DDkuKEEuppXYM3HKj9xoU49w8QlnHZjNO1u46jerXcOG7zNuV1vdA6bjbbdOuSHTad9BKMrhjSb9WxMqwkCF31jm7R1Czmch/YMIG86Ue1BgJacBLp/SqcvEO3pxLfBYx/XuuwG+2gjV9pnQsRyMV8swd8jcCobVF2rRpTpXgBNvh0yqW7HhqumZmro04ydDPu9MS15fXWq/9JqH/RHH7JuENqn4fVF/8P4p2F/9NPl2WnpVtplfRhensGsq+HlSX80Us3W8s10xZL0ORtPmyXtu7DcwOVzeqKzqoWRup0+8aHyC5jATsIQ9/ur69FT6jnvXVxT89i7Hl9+GJ6Xuc7urvWlnNe1bneVIcnT2N9mC2Wkdv30RmKrXl/VxYkrUeZ+GEI6MPUGIupDA0m1Fcgs31lgqyI9iBVJHeVX2ht0aIPshB4DbMrY76QnzGnIJXIoiGUbJqpel3Y1VStFJFMsTOPKuwKgiVqDveWAP7V8J1oY1GnI7d+A1jaN+7UnYT5Lp+CTLpVWK5cVHcGtw3q32ZoctjhvHrUanbbVnfCDgzrA7i5BXzA1n4qqYlxemvaooWPD1ObK/+J+geC4e4sM0OJP14dlGxCNLYG+GpuJqfllsfgc7wGsfntyxVod5nJvmtB1Pl1Sgmdej1bKC0iuCF+GciorH2akAXfaf9e7PhvDFb1hZewhrZWHuj0v7Ut9agBm/r0q5kqAe2hLI+GCOnDj/I2m+gYEgiJTHCjVr2gRgTKZhsswQ69eMaNIGjpdf14KJYqbzzF7JWuitgf4H64BWrdnzOLUCKjnaW/Urr55pjX5hs0Ed0T4usZ6jiNRSCgqugGf8wU2EtwpPJCbJBDKwIyExJLEuDEkbVG2Ra7K5WKfJpazolEwOIDzzX7Ss+MEKx6KWYzCzFs0i+m+gaM1V+ZuXFAaqXThxdwGKbjrLkCNkK1tyEwgm4wjptMRmiuCxOOl47KMVcyXlO7OFTNpLrV5Em0Rd1cupB+TRMtufBI6+KLsjQGHrJGaSWckuIli02Q9KjNXGviA0wQ1eLvY3cXuLna3id3lm0P9xFTfJejTWIU+1x5PQL8hFc8V6BOS93g+SweplwiUIempg4ZIP78fQ2D/JjwcLz4H+N7BV8RHqpSvPvPN7KGuW+kz3bT057ZABkmPSoIJZCLhHBPfOcekKKWqg9XV3vmhJcFBvQqICFkzZAs/YRxUFiYe4WYe7THHF5H3Q8xmHPKjfpROGRBX9Rwz8KUX75DkDknuqtGuGn0/1WiHJHexu4vdv2bsrkWSGVcULRon6RfrlKfp+ygtZzCApe/usSzkyFTLaAWJsQxjGWXkYFjNhtWYdGzRcnjLOTzoTpr2YZO3O41Ow2o1O0ax1t/kcZwFWTmmCvZWdtRP+cJPgOMSD5wrin3fKW//gXpDMcG0hqknw82gc1DpXY4dW6vY8cKPQTYgDNgxfGJ78Xp4hvTxGTmSR73RUxKE2Up16qkMQkp6xYXeithBxx103JWfXfn5bsrPDjruYncXu3/N2H0WdGxtgo6tZ0DHFkOINUGI9UdCRwdwB0KzCRgFZMiepgt8iQ3+0ruPOuxjHk5FnAG9IopsVz2nHoBxQnTYkVrtiQfWateWewBkxedABVAGgnZgcQcWdwVnV3C+j4KzA4u72N3F7l8zdp8BFjUaehoswoCtwSKMrdVZhqXe0Zv/3xozUqhoDsi9mW8TWnRyFEi4Qr29aQQ+bfXReRXHxj6+nmmq1zNN/XpmtP+QnbPxuJ+9cmvSJ1P7D0tnW8CI9Ns4A7/hQTypRElCF1aYxXEQHe/vP8AssOxjjQeylr4n7/n3Nduf71ug1oqMha9IqujEAax3NdDwuEY2CSW6vcqRRFxZSH+BYURgKXoqvpaypz+9XQByZorMHr5drF2QLtMXZN7ih4hG18jlVuQDua5D9/HLZVGEnpClSn1rV4PxDDhdEhFFuENzgavQ521gr2vg50QluF6C3nFzVxwzQkCvOFwZmRcp3MxurjB0icOa7K3gIXQb6v2OVz+/H79mUzocANNIEiGCFhL7DgjEK3AjSpO99F0HnESVK/ST6YyE65XeJsGwZBMXlMJuvZEQ7EZ/9LS4gPoxhIRPasdJgnIMzrp7lVrQEZ+Ei6W1lmsbnVM63j5ocZ+X5r2mMkr9RuFYjNqtZ7JTidkNI4nGaBHpRQ52E6Ry8YJcL2XiHyk1fSyJSdSi10tcKNXe2OrtZBtyg4rgiLT14sUVPbNAD5szuIJUl3lATWg+yu8A2anVXsxHiZ6J9Mp83Hrv6dvs8rTsiCIosa7DBsye+X4k/skYug6Gys00gUh7MVv0QbhJEWE26wWWTLWkKU1AnMTfGQSGp5xJHW1AgMdX3T+F7a9kWcgLv9IXn7+WZKbLN1CYcaTj29GLecYFTVzQVHki0vyruoeOBbGNMlAeUA5wktufMoFmtJAbFa3KzE/k92mOoT96IypRcKx+HOdJUP+lvn/D0dkYSNUI2LO3ouA307Sw+JWUlW41LGtwlV/Xh5q7pDfFb/bIDuvwn01elLiX78hceu7ia2fpJzLJnyfv/kEZb5dpvsdMoyE07mwO83Oy+n/KU5EwJkg3uiEqRuJbDTxXtzEj/IxawL9wlxIKtRTQsFELSlCrSChweYyhR6nHnklBGyCB4DGC2D10f39O6QJ6AxRPRIrQlA7DCkGvHFpWiace1Ng4X5lTVCuEjM6Hv6NEv7LgQ9xAQy1q7D30pB7oKsR+FF+WhXsffd2YjsB9rtD72GnqkYAM5/PEw+MSgO1kzjj4/Qa3dWRkJyq7QnvqiVQXfqwO2NCz0lSD8YAi0PkDIpxHlxPcW4e2veCdG9YC54z0xjqoHq2oP7jMBRkKl8IHx5X7j020ISTMmXADdBIoDYASRWGF88F4hSIQ8/TzBD+c7utJ0T6OBSLY5yn3Oag1anWT+h46xSmKoYcvED9R58Sl+wFrj4FEz/PxkQNX+xDpmQ4lh33IHz68/LRJXQuxidkPcFMPmU9U46W64xujqjuGqcfFcyiXGmS8vXr8Y94jQ0c1wxYcqD884K4RNo2PeFmdO4idGNgMAyk/6e9J6f9vhy9Wauc3+lJ47dmQeqfEoJMlt5fjGxyfuEaip454zIW5y3v0Z1roVXp64mtGm2JPHTxayV66E+2VVJuynXvh85RdYOmZp4u+gMnlWHjEYwXUdihpUo3Sz9/MsfqsO6Wy8mARBVUz1Bbr2rF3hW2vq0vcbDYsfcDlXO3ghfweizP8e2zcGnQylx+o/IplHa8/GOl+OIxRdPG//wERXlLV
|
|
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 'Create request to provision a potential role into an actual role.' (create-potential-role-provision-request)"
|
|
---
|
|
|
|
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"}>Create request to provision a potential role into an actual role.</h1>
|
|
|
|
<MethodEndpoint method={"post"} path={"/role-mining-sessions/{sessionId}/potential-roles/{potentialRoleId}/provision"}></MethodEndpoint>
|
|
|
|
|
|
|
|
This method starts a job to provision 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><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":"min-entitlement-popularity","description":"Minimum popularity required for an entitlement to be included in the provisioned role.","required":false,"style":"form","explode":true,"schema":{"type":"integer","default":0,"minimum":0,"maximum":100}}}></ParamsItem><ParamsItem className={"paramsItem"} param={{"in":"query","name":"include-common-access","description":"Boolean determining whether common access entitlements will be included in the provisioned role.","required":false,"style":"form","explode":true,"schema":{"type":"boolean","default":true}}}></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></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}><div style={{"marginTop":"1rem","marginBottom":"1rem"}}>
|
|
|
|
Required information to create a new role
|
|
|
|
</div></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"roleName"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Name of the new role being created","example":"Finance - Accounting"}}></SchemaItem><SchemaItem collapsible={false} name={"roleDescription"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Short description of the new role being created","example":"General access for accounting department"}}></SchemaItem><SchemaItem collapsible={false} name={"ownerId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"ID of the identity that will own this role","example":"2b568c65bc3c4c57a43bd97e3a8e41"}}></SchemaItem></ul></details></TabItem></MimeTabs><div><div><ApiTabs><TabItem label={"202"} value={"202"}><div>
|
|
|
|
Accepted. Returns a potential role summary including the status of the provison request
|
|
|
|
</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"id"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Id of the potential role","example":"e0cc5d7d-bf7f-4f81-b2af-8885b09d9923"}}></SchemaItem><SchemaItem collapsible={false} name={"name"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Name of the potential role","example":"Potential Role - e0cc5d"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>potentialRoleRef</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
|
|
|
Details about the potential role
|
|
|
|
</div><SchemaItem collapsible={false} name={"id"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Id of the potential role","example":"e0cc5d7d-bf7f-4f81-b2af-8885b09d9923"}}></SchemaItem><SchemaItem collapsible={false} name={"name"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Name of the potential role","example":"Potential Role - e0cc5d"}}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={false} name={"identityCount"} required={false} schemaName={"int32"} qualifierMessage={undefined} schema={{"type":"integer","description":"The number of identities in a potential role.","format":"int32","example":25}}></SchemaItem><SchemaItem collapsible={false} name={"entitlementCount"} required={false} schemaName={"int32"} qualifierMessage={undefined} schema={{"type":"integer","description":"The number of entitlements in a potential role.","format":"int32","example":15}}></SchemaItem><SchemaItem collapsible={false} name={"identityGroupStatus"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The status for this identity group which can be \"REQUESTED\" or \"OBTAINED\"","example":"OBTAINED"}}></SchemaItem><SchemaItem collapsible={false} name={"provisionState"} required={false} schemaName={"RoleMiningPotentialRoleProvisionState"} qualifierMessage={"**Possible values:** [`POTENTIAL`, `PENDING`, `COMPLETE`, `FAILED`]"} schema={{"description":"The status of provisioning for this potential role. Can be \"POTENTIAL\", \"PENDING\", \"FAILED\", or \"COMPLETE\".","example":"PENDING","type":"string","enum":["POTENTIAL","PENDING","COMPLETE","FAILED"],"title":"RoleMiningPotentialRoleProvisionState"}}></SchemaItem><SchemaItem collapsible={false} name={"roleId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"ID of the provisioned role in IIQ or IDN. Null if this potential role has not been provisioned.","nullable":true,"example":"2a4be6fbcf3c4e66b95a0c15ffd591"}}></SchemaItem><SchemaItem collapsible={false} name={"density"} required={false} schemaName={"int32"} qualifierMessage={undefined} schema={{"type":"integer","description":"The density metric (0-100) of this potential role. Higher density values indicate higher similarity amongst the identities.","format":"int32","example":90}}></SchemaItem><SchemaItem collapsible={false} name={"freshness"} required={false} schemaName={"int32"} qualifierMessage={undefined} schema={{"type":"integer","description":"The freshness metric (0-100) of this potential role. Higher freshness values indicate this potential role is more distinctive compared to existing roles.","format":"int32","example":70}}></SchemaItem><SchemaItem collapsible={false} name={"quality"} required={false} schemaName={"int32"} qualifierMessage={undefined} schema={{"type":"integer","description":"The quality metric (0-100) of this potential role. Higher quality values indicate this potential role has high density and freshness.","format":"int32","example":80}}></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={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></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"id\": \"e0cc5d7d-bf7f-4f81-b2af-8885b09d9923\",\n \"name\": \"Potential Role - e0cc5d\",\n \"potentialRoleRef\": {\n \"id\": \"e0cc5d7d-bf7f-4f81-b2af-8885b09d9923\",\n \"name\": \"Potential Role - e0cc5d\"\n },\n \"identityCount\": 25,\n \"entitlementCount\": 15,\n \"identityGroupStatus\": \"OBTAINED\",\n \"provisionState\": \"PENDING\",\n \"roleId\": \"2a4be6fbcf3c4e66b95a0c15ffd591\",\n \"density\": 90,\n \"freshness\": 70,\n \"quality\": 80,\n \"type\": \"SPECIALIZED\",\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}"} 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={"404"} value={"404"}><div>
|
|
|
|
Not Found - returned if the request URL refers to a resource or object that does not exist
|
|
|
|
</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={"404"} value={"404"}><p> An example of a 404 response object</p><ResponseSamples responseExample={"{\n \"detailCode\": \"404 Not found\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The server did not find a current representation for the target resource.\"\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"}><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> |