{"type":"model","meta":{"id":"/apps/pubhub/media/cisco-security-cloud-control-api-documentation/bd3c22528ebef6d885e8228912d519f34bded077/93440196-979f-3e2d-8df3-11ca30919752","info":{"title":"Cisco Security Cloud Control Platform Management APIs","description":"Manage the organizations in Security Cloud Control.","contact":{"name":"Cloud Security Developer Community"},"version":"1.0.3"},"security":[{"bearerHttpAuthentication":[]}],"tags":[{"name":"Admin Groups","description":"Managing groups"},{"name":"Users","description":"Managing users"},{"name":"Roles","description":"Managing roles"},{"name":"Subscriptions","description":"Managing subscriptions"},{"name":"Organizations","description":"Managing organizations"},{"name":"Refresh Token","description":"Refresh the access token."}],"x-parser-conf":{"overview":{"markdownPath":"reference/overview-scc-organizations.md"}},"openapi":"3.1.0","servers":[{"url":"https://api.security.cisco.com/{basePath}","description":"Security Cloud Control (SCC) base server URL","variables":{"basePath":{"description":"API base path version","default":"v1"}}}],"securitySchemes":{"bearerHttpAuthentication":{"type":"http","description":"JWT Authorization header using the Bearer scheme. Example: 'Bearer {token}'.\nRequired scopes: security:enterprise:member (Read organizations),\nsecurity:enterprise:admin (Write organizations)\n","scheme":"bearer","bearerFormat":"JWT"},"refreshTokenAuth":{"type":"http","description":"Refresh token for obtaining a new access token","scheme":"bearer","bearerFormat":"JWT"}}},"spec":{"type":"object","description":"Response containing a list of roles","properties":{"roles":{"type":"array","description":"List of roles within the organization","example":[{"id":"6280494d-dd0f-4655-b558-111111111114","displayName":"Test platform product 2 display name","description":"Test platform product 2 description","type":"STATIC","products":[{"key":"platform-test-product2","name":"Test Platform Product 2"}]}],"items":{"type":"object","description":"Represents a role within an organization. Supports multiple role types with different structures.\n\n**Role Types:**\n1. **STATIC Roles** - System-defined roles provided by the platform\n - Fields: id, displayName, description, type, products\n - Products include: key, name\n - Example:\n {\n \"id\": \"6280494d-dd0f-4655-b558-111111111114\",\n \"displayName\": \"Test platform product 2 display name\",\n \"description\": \"Test platform product 2 description\",\n \"type\": \"STATIC\",\n \"products\": [\n {\n \"key\": \"platform-test-product2\",\n \"name\": \"Test Platform Product 2\"\n }\n ]\n }\n\n2. **CUSTOM Roles** - User-created roles tailored to organizational needs\n - Fields: id, displayName, type, products\n - Products include: id, key, name\n - Example:\n {\n \"id\": \"01a8c996-4297-426e-8e23-9034b267a423\",\n \"displayName\": \"New role 1\",\n \"type\": \"CUSTOM\",\n \"products\": [\n {\n \"key\": \"test-product-1\",\n \"name\": \"Test Product 1\"\n }\n ]\n }","properties":{"id":{"type":"string","description":"Unique identifier for the role","example":"01a8c996-4297-426e-8e23-9034b267a423"},"displayName":{"type":"string","description":"Display name of the role","example":"Paul test 2"},"description":{"type":"string","description":"Description of the role","example":"This is a role for managing workloads"},"type":{"type":"string","description":"Type of the role","enum":["CUSTOM","STATIC"],"example":"CUSTOM"},"products":{"type":"array","description":"List of products associated with the role","example":[{"key":"secure-workload","name":"Cisco Secure Workload"}],"items":{"type":"object","description":"Represents a product associated with a role","properties":{"key":{"type":"string","description":"Product key identifier","example":"secure-workload"},"name":{"type":"string","description":"Name of the product","example":"Cisco Secure Workload"}},"$$ref":"#/components/schemas/Product"}}},"$$ref":"#/components/schemas/Role"}}},"$$ref":"#/components/schemas/RolesResponse","title":"RolesResponse"}}