{"type":"api","title":"Retrieve playbook execution permissions for role","meta":{"id":"/apps/pubhub/media/crosswork-network-controller-7-1/f445c17e25a1120e8fbde4bd413083d0fd88b2b3/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":"Retrieve playbook execution permissions for role","operationId":"GetPbAuthRole","tags":["OAM"],"requestBody":{"description":"Argument for setting auth to allow execution of playbook for a role","required":true,"content":{"application/json":{"schema":{"type":"object","description":"Generator Playbook Auth Role Get Request","properties":{"role":{"type":"array","items":{"type":"string"},"title":"Filter by role","description":"Filter by role"}},"$$ref":"#/components/schemas/generatorPbAuthRoleGetReq"},"example":{"role":["admin"]}}}},"responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"type":"object","description":"Generator Playbook Auth Role Get Response","properties":{"roles":{"type":"array","description":"List of AuthRole 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"}}},"example":{"roles":[{"role":"admin","allowed_prop":{"labels":["test_label"]}}]},"$$ref":"#/components/schemas/generatorPbAuthRoleGetResp"}}}},"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/query"}}