Add Identity to Policy - Cloud Security Gov

{"type":"api","title":"Add Identity to Policy","meta":{"id":"/apps/pubhub/media/cloud-security-gov/cdd8786b84e1e4d80528d0eeb25987c136a18549/6a0a4614-87f6-3fee-b712-6f6612fb04be","info":{"title":"Cisco Umbrella for Government Deployments Policies API","version":"2.0.0","description":"Manage the policies for the deployments in your organization.","contact":{"name":"Cloud Security Developer Community"}},"security":[{"oauthFlow":[]}],"tags":[{"name":"Policy","description":"Umbrella Policy Management"},{"name":"Umbrella"}],"x-parser-conf":{"overview":{"markdownPath":"reference/deployments/policies-overview.md"}},"openapi":"3.0.1","servers":[{"url":"https://api.umbrellagov.com/{basePath}","variables":{"basePath":{"default":"deployments/v2"}}}],"securitySchemes":{"oauthFlow":{"type":"oauth2","description":"client credential flow","flows":{"clientCredentials":{"tokenUrl":"https://api.umbrellagov.com/auth/v2/token","scopes":{"deployments.policies:write":"Write deployments policies","deployments.policies:read":"Read deployments policies"}}}}}},"spec":{"summary":"Add Identity to Policy","operationId":"updatePolicyIdentities","tags":["Policy","Umbrella"],"description":"Add an identity to your policy.\nPolicy changes may require up to 20 minutes to take effect globally.\nFor DNS policies, TTLs, caching, and session reuse may cause some devices\nand domains to appear to take longer to update.","security":[{"oauthFlow":["deployments.policies:write"]}],"parameters":[{"name":"originId","in":"path","description":"The origin ID of the identity.","required":true,"schema":{"type":"integer","minimum":1,"format":"int32"},"$$ref":"#/components/parameters/networkDeviceOriginIdParam"},{"name":"policyId","in":"path","description":"The ID of the policy.","required":true,"schema":{"type":"integer","minimum":1,"format":"int32"},"$$ref":"#/components/parameters/policyIdParam"}],"responses":{"200":{"description":"OK","headers":{"Content-Type":{"schema":{"type":"string"},"description":"The MIME content type of the response body.","example":"application/json","$$ref":"#/components/headers/Content-Type"},"Date":{"schema":{"type":"string","pattern":"^[0-90-90-90-9-0-90-9-0-90-9T0-90-9:0-90-9:0-90-9Z]+$"},"description":"The timestamp of the response.","example":"2023-03-14T18:34:25Z","$$ref":"#/components/headers/Date"}},"content":{"application/json":{"schema":{"description":"The origin ID of the identity.","type":"integer","minimum":1,"format":"int32","example":358739,"$$ref":"#/components/schemas/OriginId"},"example":123467}}},"400":{"description":"Bad Request","headers":{"Content-Type":{"schema":{"type":"string"},"description":"The MIME content type of the response body.","example":"application/json","$$ref":"#/components/headers/Content-Type"},"Date":{"schema":{"type":"string","pattern":"^[0-90-90-90-9-0-90-9-0-90-9T0-90-9:0-90-9:0-90-9Z]+$"},"description":"The timestamp of the response.","example":"2023-03-14T18:34:25Z","$$ref":"#/components/headers/Date"}},"content":{"application/json":{"schema":{"description":"Bad Request","type":"object","properties":{"statusCode":{"type":"integer","example":400,"description":"HTTP status code"},"error":{"type":"string","example":"Validation Error","description":"A brief description of the error"},"message":{"type":"string","description":"Detailed error message"},"validationErrors":{"type":"object","properties":{"someProperty":{"type":"string","example":"must not be empty","description":"the name of the property failing validation."}}}},"$$ref":"#/components/schemas/BadRequestError"}}},"$$ref":"#/components/responses/InvalidRequest"},"401":{"description":"Unauthorized","headers":{"Content-Type":{"schema":{"type":"string"},"description":"The MIME content type of the response body.","example":"application/json","$$ref":"#/components/headers/Content-Type"},"Date":{"schema":{"type":"string","pattern":"^[0-90-90-90-9-0-90-9-0-90-9T0-90-9:0-90-9:0-90-9Z]+$"},"description":"The timestamp of the response.","example":"2023-03-14T18:34:25Z","$$ref":"#/components/headers/Date"}},"content":{"application/json":{"schema":{"description":"Unauthorized","type":"object","properties":{"statusCode":{"type":"integer","example":401,"description":"HTTP status code"},"error":{"type":"string","example":"Unauthorized","description":"The authorization header is missing or the token is unauthorized"},"message":{"type":"string","description":"Detailed error message"}},"$$ref":"#/components/schemas/UnauthorizedError"}}},"$$ref":"#/components/responses/Unauthorized"},"403":{"description":"Forbidden","headers":{"Content-Type":{"schema":{"type":"string"},"description":"The MIME content type of the response body.","example":"application/json","$$ref":"#/components/headers/Content-Type"},"Date":{"schema":{"type":"string","pattern":"^[0-90-90-90-9-0-90-9-0-90-9T0-90-9:0-90-9:0-90-9Z]+$"},"description":"The timestamp of the response.","example":"2023-03-14T18:34:25Z","$$ref":"#/components/headers/Date"}},"content":{"application/json":{"schema":{"description":"Forbidden","type":"object","properties":{"statusCode":{"type":"integer","example":403,"description":"HTTP status code"},"error":{"type":"string","example":"Forbidden, Invalid authentication credentials","description":"a brief description of the error"},"message":{"type":"string","description":"Detailed error message"}},"$$ref":"#/components/schemas/ForbiddenError"}}},"$$ref":"#/components/responses/Forbidden"},"404":{"description":"Not found","headers":{"Content-Type":{"schema":{"type":"string"},"description":"The MIME content type of the response body.","example":"application/json","$$ref":"#/components/headers/Content-Type"},"Date":{"schema":{"type":"string","pattern":"^[0-90-90-90-9-0-90-9-0-90-9T0-90-9:0-90-9:0-90-9Z]+$"},"description":"The timestamp of the response.","example":"2023-03-14T18:34:25Z","$$ref":"#/components/headers/Date"}},"content":{"application/json":{"schema":{"description":"Not Found","type":"object","properties":{"statusCode":{"type":"integer","example":404,"description":"HTTP status code"},"error":{"type":"string","example":"Not Found","description":"A brief description of the error"},"message":{"type":"string","description":"Detailed error message"}},"$$ref":"#/components/schemas/NotFoundError"}}},"$$ref":"#/components/responses/NotFound"},"500":{"description":"Internal Server Error","headers":{"Content-Type":{"schema":{"type":"string"},"description":"The MIME content type of the response body.","example":"application/json","$$ref":"#/components/headers/Content-Type"},"Date":{"schema":{"type":"string","pattern":"^[0-90-90-90-9-0-90-9-0-90-9T0-90-9:0-90-9:0-90-9Z]+$"},"description":"The timestamp of the response.","example":"2023-03-14T18:34:25Z","$$ref":"#/components/headers/Date"}},"content":{"application/json":{"schema":{"description":"Internal Server Error","type":"object","properties":{"statusCode":{"type":"integer","example":500,"description":"HTTP status code"},"error":{"type":"string","example":"Internal Server Error","description":"The server has an internal error and could not process the request."},"message":{"type":"string","description":"Detailed error message"}},"$$ref":"#/components/schemas/ServerError"}}},"$$ref":"#/components/responses/ServerErr"}},"__originalOperationId":"updatePolicyIdentities","method":"put","path":"/policies/{policyId}/identities/{originId}"}}