{"type":"api","title":"Set an authrole","meta":{"id":"/apps/pubhub/media/crosswork-network-controller-7-1/b95772dc6c621d9842faced8610ee58b0cb9cb02/c0404d8d-ff8e-36e9-bb59-ee336d247534","info":{"title":"Crosswork Change Automation API","version":"7.1.0","contact":{"name":"Crosswork Team, Cisco","email":"support@cisco.com"},"license":{"name":"Cisco Software License Agreement","url":"http://www.cisco.com/public/sw-license-agreement.html"},"description":"A web server dedicated to RESTful queries into the Crosswork Change Automation application."},"x-parser-conf":{"overview":{"markdownPath":"reference/CAHI/change_automation.overview.md"}},"openapi":"3.1.0","servers":[{"url":"https://{server_ip}:30603/crosswork/nca/v1","description":"Generated server url"}]},"spec":{"summary":"Set an authrole","operationId":"PostPbAuthRole","tags":["OAM"],"requestBody":{"description":"Argument for Setting the Label to the given Role","required":true,"content":{"application/json":{"schema":{"type":"object","description":"Generator Playbook Auth Role Set Request","properties":{"roles":{"type":"array","description":"Array of Role Map","items":{"type":"object","description":"Generator Playbook Auth Role Map","properties":{"role":{"type":"string","description":"Role"},"allowed_prop":{"type":"object","description":"Generator Allowed Property","properties":{"labels":{"type":"array","items":{"type":"string"},"title":"Allow role access to run playbook with these labels","description":"Allow role access to run playbook with these labels"}},"$$ref":"#/components/schemas/generatorAllowedProp"}},"$$ref":"#/components/schemas/generatorPbAuthRoleMap"}}},"$$ref":"#/components/schemas/generatorPbAuthRoleSetReq"},"example":{"roles":[{"role":"admin","allowed_prop":{"labels":["critical","finance"]}}]}}}},"responses":{"204":{"description":"Successfully set Auth, no response message-body."},"400":{"description":"Bad Request. The request is malformed in some way and the server cannot process it.","content":{"application/json":{"schema":{"type":"object","description":"Change Automation Error 400","required":["code","severity","message"],"properties":{"code":{"type":"string","description":"HTTP return code","example":"400"},"severity":{"type":"string","description":"Error severity level","enum":["Critical","Warning","Fatal"]},"message":{"type":"string","description":"Error message","example":"top level error string"},"data":{"type":"string","description":"Details of the error","example":"detailed description of the error"}},"example":{"code":"400","severity":"Critical","message":"error message","data":"detailed description of the error"},"$$ref":"#/components/schemas/change_automationError400"}}}},"500":{"description":"Internal Server Error. The server could not fulfill the request.","content":{"application/json":{"schema":{"type":"object","description":"Change Automation Error 500","required":["code","severity","message"],"properties":{"code":{"type":"string","description":"HTTP return code","example":"500"},"severity":{"type":"string","description":"Error severity level","enum":["Critical","Warning","Fatal"]},"message":{"type":"string","description":"Error message","example":"top level error string"},"data":{"type":"string","description":"Error detailed description"}},"example":{"code":"500","severity":"Critical","message":"error message","data":"Server Error. detailed description of the error"},"$$ref":"#/components/schemas/change_automationError500"}}}}},"method":"post","path":"/nca-oam/pbauth/authrole"}}