https://docs.prospectis.immo/assets/js/1b393084.5229b618.js

1"use strict";(self.webpackChunkprospectis=self.webpackChunkprospectis||[]).push([[843],{97187:(e,t,a)=>{a.r(t),a.d(t,{assets:()=>y,contentTitle:()=>u,default:()=>f,frontMatter:()=>m,metadata:()=>b,toc:()=>h});var s=a(87462),r=(a(67294),a(3905)),o=a(26389),l=a(94891),i=a(75190),p=a(47507),n=a(24310),c=a(63303),d=(a(75035),a(85162));const m={id:"delete-a-batch-of-roles",title:"Delete a batch of roles",description:"Delete a batch of roles",sidebar_label:"Delete a batch of roles",hide_title:!0,hide_table_of_contents:!0,api:{parameters:[{schema:{type:"integer"},name:"user",in:"path",required:!0}],requestBody:{content:{"application/json":{schema:{type:"object",properties:{resources:{type:"array",items:{type:"integer",description:"A list of resource IDs"}}}}}}},responses:{200:{description:"OK",content:{"application/json":{schema:{type:"object",properties:{data:{type:"array",items:{title:"RoleResource",allOf:[{title:"Role",type:"object",properties:{name:{type:"string"},guard_name:{type:"string"}}},{type:"object",properties:{id:{type:"integer"}}}]}}}}}}},401:{description:"Unauthenticated"}

1,403:{description:"Unauthorized"},404:{description:"Resource not found"},422:{description:"Validation error"}},tags:["User Roles"],description:"Delete a batch of roles",method:"delete",path:"/api/users/{user}/roles/batch",servers:[{url:"https://manager.prospectis.immo",description:"Default Environment"}],security:[{BearerAuth:[]}],securitySchemes:{BearerAuth:{type:"http",scheme:"bearer"}},jsonRequestBodyExample:{resources:[0]},info:{title:"Prospectis",version:"1.0.0"},postman:{name:"Delete a batch of roles",description:{type:"text/plain"},url:{path:["api","users",":user","roles","batch"],host:["{{baseUrl}}"],query:[],variable:[{disabled:!1,description:{content:"(Required) ",type:"text/plain"},type:"any",value:"",key:"user"}]},header:[{key:"Content-Type",value:"application/json"},{key:"Accept",value:"application/json"}],method:"DELETE",body:{mode:"raw",raw:'""',options:{raw:{language:"json"}}}}},sidebar_class_name:"delete api-method",info_path:"docs/prospectis-37cb-4770-bc5660ebe1e4-a907-65772db2/prospectis",custom_edit_url:null},u=void 0,b={unversionedId:"prospectis-37cb-4770-bc5660ebe1e4-a907-65772db2/delete-a-batch-of-roles",id:"prospectis-37cb-4770-bc5660ebe1e4-a907-65772db2/delete-a-batch-of-roles",title:"Delete a batch of roles",description:"Delete a batch of roles",source:"@site/docs/prospectis-37cb-4770-bc5660ebe1e4-a907-65772db2/delete-a-batch-of-roles.api.mdx",sourceDirName:"prospectis-37cb-4770-bc5660ebe1e4-a907-65772db2",slug:"/prospectis-37cb-4770-bc5660ebe1e4-a907-65772db2/delete-a-batch-of-roles",permalink:"/docs/prospectis-37cb-4770-bc5660ebe1e4-a907-65772db2/delete-a-batch-of-roles",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"delete-a-batch-of-roles",title:"Delete a batch of roles",description:"Delete a batch of roles",sidebar_label:"Delete a batch of roles",hide_title:!0,hide_table_of_contents:!0,api:{parameters:[{schema:{type:"integer"},name:"user",in:"path",required:!0}],requestBody:{content:{"application/json":{schema:{type:"object",properties:{resources:{type:"array",items:{type:"integer",description:"A list of resource IDs"}}}}}}},responses:{200:{description:"OK",content:{"application/json":{schema:{type:"object",properties:{data:{type:"array",items:{title:"RoleResource",allOf:[{title:"Role",type:"object",properties:{name:{type:"string"},guard_name:{type:"string"}}},{type:"object",properties:{id:{type:"integer"}}}]}}}}}}},401:{description:"Unauthenticated"}

1,403:{description:"Unauthorized"},404:{description:"Resource not found"},422:{description:"Validation error"}},tags:["User Roles"],description:"Delete a batch of roles",method:"delete",path:"/api/users/{user}/roles/batch",servers:[{url:"https://manager.prospectis.immo",description:"Default Environment"}],security:[{BearerAuth:[]}],securitySchemes:{BearerAuth:{type:"http",scheme:"bearer"}},jsonRequestBodyExample:{resources:[0]},info:{title:"Prospectis",version:"1.0.0"},postman:{name:"Delete a batch of roles",description:{type:"text/plain"},url:{path:["api","users",":user","roles","batch"],host:["{{baseUrl}}"],query:[],variable:[{disabled:!1,description:{content:"(Required) ",type:"text/plain"},type:"any",value:"",key:"user"}]},header:[{key:"Content-Type",value:"application/json"},{key:"Accept",value:"application/json"}],method:"DELETE",body:{mode:"raw",raw:'""',options:{raw:{language:"json"}}}}},sidebar_class_name:"delete api-method",info_path:"docs/prospectis-37cb-4770-bc5660ebe1e4-a907-65772db2/prospectis",custom_edit_url:null},sidebar:"openApiSidebar",previous:{title:"Update a batch of roles",permalink:"/docs/prospectis-37cb-4770-bc5660ebe1e4-a907-65772db2/update-a-batch-of-roles"},next:{title:"Detach roles",permalink:"/docs/prospectis-37cb-4770-bc5660ebe1e4-a907-65772db2/detach-roles"}},y={},h=[{value:"Delete a batch of roles",id:"delete-a-batch-of-roles",level:2}],k={toc:h};function f(e){let{components:t,...a}=e;return(0,r.kt)("wrapper",(0,s.Z)({},k,a,{components:t,mdxType:"MDXLayout"}),(0,r.kt)("h2",{id:"delete-a-batch-of-roles"},"Delete a batch of roles"),(0,r.kt)("p",null,"Delete a batch of roles"),(0,r.kt)("details",{style:{marginBottom:"1rem"},"data-collapsed":!1,open:!0},(0,r.kt)("summary",{style:{}},(0,r.kt)("strong",null,"Path Parameters")),(0,r.kt)("div",null,(0,r.kt)("ul",null,(0,r.kt)(i.Z,{className:"paramsItem",param:{schema:{type:"integer"},name:"user",in:"path",required:!0},mdxType:"ParamsItem"})))),(0,r.kt)(l.Z,{mdxType:"MimeTabs"},(0,r.kt)(d.Z,{label:"application/json",value:"application/json-schema",mdxType:"TabItem"},(0,r.kt)("details",{style:{},"data-collapsed":!1,open:!0},(0,r.kt)("summary",{style:{textAlign:"left"}},(0,r.kt)("strong",null,"Request Body")),(0,r.kt)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,r.kt)("ul",{style:{marginLeft:"1rem"}},(0,r.kt)(n.Z,{collapsible:!1,name:"resources",required:!1,schemaName:"integer[]",qualifierMessage:void 0,schema:{type:"array",items:{type:"integer",description:"A list of resource IDs"}},mdxType:"SchemaItem"}))))),(0,r.kt)("div",null,(0,r.kt)(o.Z,{mdxType:"ApiTabs"},(0,r.kt)(d.Z,{label:"200",value:"200",mdxType:"TabItem"},(0,r.kt)("div",null,(0,r.kt)("p",null,"OK")),(0,r.kt)("div",null,(0,r.kt)(l.Z,{schemaType:"response",mdxType:"MimeTabs"},(0,r.kt)(d.Z,{label:"application/json",value:"application/json",mdxType:"TabItem"},(0,r.kt)(c.Z,{mdxType:"SchemaTabs"},(0,r.kt)(d.Z,{label:"Schema",value:"Schema",mdxType:"TabItem"},(0,r.kt)("details",{style:{},"data-collapsed":!1,open:!0},(0,r.kt)("summary",{style:{textAlign:"left"}},(0,r.kt)("strong",null,"Schema")),(0,r.kt)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,r.kt)("ul",{style:{marginLeft:"1rem"}},(0,r.kt)(n.Z,{collapsible:!1,name:"data",required:!1,schemaName:"object[]",qualifierMessage:void 0,schema:{type:"array",items:{title:"RoleResource",allOf:[{title:"Role",type:"object",properties:{name:{type:"string"},guard_name:{type:"string"}}},{type:"object",properties:{id:{type:"integer"}}}]}},mdxType:"SchemaItem"})))),(0,r.kt)(d.Z,{label:"Example (from schema)",value:"Example (from schema)",mdxType:"TabItem"},(0,r.kt)(p.Z,{responseExample:'{\n  "data": [\n    {\n      "name": "string",\n      "guard_name": "string",\n      "id": 0\n    }\n  ]\n}',language:"json",mdxType:"ResponseSamples"}))))))),(0,r.kt)(d.Z,{label:"401",value:"401",mdxType:"TabItem"},(0,r.kt)("div",null,(0,r.kt)("p",null,"Unauthenticated")),(0,r.kt)("div",null)),(0,r.kt)(d.Z,{label:"403",value:"403",mdxType:"TabItem"},(0,r.kt)("div",null,(0,r.kt)("p",null,"Unauthorized")),(0,r.kt)("div",null)),(0,r.kt)(d.Z,{label:"404",value:"404",mdxType:"TabItem"},(0,r.kt)("div",null,(0,r.kt)("p",null,"Resource not found")),(0,r.kt)("div",null)),(0,r.kt)(d.Z,{label:"422",value:"422",mdxType:"TabItem"},(0,r.kt)("div",null,(0,r.kt)("p",null,"Validation error")),(0,r.kt)("div",null)))))}f.isMDXComponent=!0}}]);