{"type":"api","title":"Add role API","meta":{"id":"/apps/pubhub/media/cisco-catalyst-center-api-2-3-7-9/a58b8872fdc3116cb1a0478252ee81e8011d37c2/6a3cd7ca-617e-374c-a10b-740a529a993e","info":{"title":"Intent API","description":"Cisco Catalyst Center Platform v. 2.3.7.9","version":"2.3.7.9"},"tags":[{"name":"Authentication","description":"Access Token Request"},{"name":"Sites","description":"Create sites, assign devices to them and get site health"},{"name":"Topology","description":"Get topology details and overall network health"},{"name":"Devices","description":"Manage network devices"},{"name":"Clients","description":"Get client (by MAC Address) health, status, and information"},{"name":"Users","description":"Obtain information about *Users* and associated connections and devices"},{"name":"Issues","description":"Obtain issue details, impacted hosts, and suggested actions for remediation"},{"name":"Site Design","description":"Design/provision NFV device to site/area/building/floor"},{"name":"Network Settings","description":"Manage Network Settings"},{"name":"Software Image Management (SWIM)","description":"Manage activation and distribution of software images"},{"name":"Device Onboarding (PnP)","description":"Zero-touch deployment of network devices"},{"name":"Configuration Templates","description":"Configure and manage CLI templates"},{"name":"Configuration Archive","description":"Export device configurations to an encrypted zip file"},{"name":"SDA","description":"(BETA) Configure and manage SDA wired fabric border devices"},{"name":"Sensors","description":"Manage sensor test templates"},{"name":"Wireless","description":"Configure and manage SSIDs, Wireless, and RF profiles in non-fabric wireless network"},{"name":"Command Runner","description":"Retrieve real-time device configuration and CLI keywords"},{"name":"Discovery","description":"Discover network devices and manage discovery jobs"},{"name":"Path Trace","description":"Network route and flow analysis"},{"name":"File","description":"Get configuration files by namespace and ID"},{"name":"Task","description":"Get information about asynchronous tasks"},{"name":"Tag","description":"Assign administrator-defined tags to network devices"},{"name":"Application Policy","description":"Create and manage applications, application sets, and application policies"},{"name":"Applications","description":"Intent API to get a list of applications for a specific site, a device, or a client device's MAC address"},{"name":"ITSM","description":"Provide the details of the various third party integrations that are supported"},{"name":"Event Management","description":"Event based notification to external handlers"},{"name":"Security Advisories","description":"Provides the details of advisories on the network and devices"},{"name":"Compliance","description":"Provides compliance status data on the devices"}],"x-parser-conf":{"expand":0,"labelConfig":{"endpoint":"summary"}},"openapi":"3.0.1","servers":[{"url":"/"}]},"spec":{"operationId":"addRoleAPI","tags":["User and Roles"],"deprecated":false,"summary":"Add role API","description":"Add a new role in the system","parameters":[{"name":"Content-Type","description":"The format of the payload","required":true,"schema":{"type":"string","default":"application/json"},"in":"header"}],"requestBody":{"description":"request","content":{"application/json":{"schema":{"type":"object","properties":{"role":{"type":"string","description":"Name of the role"},"description":{"type":"string","description":"Description of role"},"resourceTypes":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","description":"Name of the application in the System"},"operations":{"type":"array","items":{"type":"string"},"description":"List of operations allowed for the application. Possible values are \"gRead\", \"gCreate\", \"gUpdate\", \"gRemove\", or some combination of these."}}},"description":"Only include resourceTypes that you wish to grant one or more of the four operations mentioned below. Exclude any resourceTypes that you do not want to grant permission to."}},"description":"","$$ref":"#/components/schemas/AddRoleAPIRequest"}}},"required":true},"responses":{"200":{"description":"Role created successfully","content":{"application/json":{"schema":{"type":"object","properties":{"response":{"type":"object","properties":{"roleId":{"type":"string","description":""},"message":{"type":"string","description":""}},"description":""}},"description":"","$$ref":"#/components/schemas/AddRoleAPIResponse"}}}},"400":{"description":"Invalid role details provided in payload","content":{}},"409":{"description":"Role with name provided already exists","content":{}},"500":{"description":"Failed to create role","content":{}}},"x-rapi-id":"b697-0a1e-46a9-b542","x-rapi-overview":"Add a new role in the system","x-rapi-domain":"System","x-rapi-subdomain":"User and Roles","x-rapi-version":"1.0.0","x-rapi-internalPath":"/api/system/v1/identitymgmt/role/resource-types","x-rapi-publicPath":"/dna/system/api/v1/role","x-rapi-registerInKONG":true,"x-rapi-banner":[],"x-rapi-rateLimiting":"10~MINUTE","__originalOperationId":"addRoleAPI","method":"post","path":"/dna/system/api/v1/role"}}