Modify ASA Access Group - Security Cloud Control Firewall Manager API Documentation

{"type":"api","title":"Modify ASA Access Group","meta":{"id":"/apps/pubhub/media/cdo-api-documentation/ee9bdf946673e45c4f256a22e0a754e29a9b2098/9b0e4c9a-48cb-3530-a00a-1f32fbf2438c","info":{"title":"Cisco Security Cloud Control Firewall Manager API","version":"1.15.0","description":"Use the documentation to explore the endpoints Security Cloud Control Firewall Manager has to offer","contact":{"name":"Cisco Security Cloud Control TAC","email":"cdo.tac@cisco.com"}},"openapi":"3.0.1","servers":[{"url":"https://api.us.security.cisco.com/firewall","description":"US"},{"url":"https://api.eu.security.cisco.com/firewall","description":"EU"},{"url":"https://api.apj.security.cisco.com/firewall","description":"APJ"},{"url":"https://api.au.security.cisco.com/firewall","description":"AUS"},{"url":"https://api.in.security.cisco.com/firewall","description":"IN"},{"url":"https://api.int.security.cisco.com/firewall","description":"Staging"},{"url":"https://scale.manage.security.cisco.com/api/rest","description":"Scale"},{"url":"https://ci.manage.security.cisco.com/api/rest","description":"CI"},{"url":"https://manage.stg.secure.cisco/api/rest","description":"Stgf9"}],"securitySchemes":{"bearerAuth":{"bearerFormat":"JWT","scheme":"bearer","type":"http"}}},"spec":{"description":"Modify Security Cloud Control Access Group by UID.","operationId":"patchAccessGroup","parameters":[{"description":"The unique identifier, represented as a UUID, of the Security Cloud Control Access Group.","in":"path","name":"accessGroupUid","required":true,"schema":{"format":"uuid","type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"appliedTo":{"description":"The set of device unique identifiers to which this Access Group was applied. Only valid for shared access group.","example":"[deviceUid1, deviceUid2, ..., deviceUidN]","items":{"format":"uuid","type":"string"},"type":"array","uniqueItems":true},"isShared":{"description":"The flag that identifies if access group is shared. If set to true, appliedTo field should be provided as well and entityUid should point to source device.","example":false,"type":"boolean"},"name":{"description":"A human-readable name for the Access Group.","example":"Access-Group1","type":"string"},"resources":{"description":"The set of of interface and direction pairs or global resource. Resource is an attribute applicable only to devices and will not be propagated to appliedTo devices if Access Group is shared.","example":"Interface resource: [{\"interfaceName\": \"outside\",\"direction\": \"OUTBOUND\"] or Global resource: [{\"global\": true}]","items":{"additionalProperties":{},"type":"object"},"type":"array","uniqueItems":true}},"type":"object","$$ref":"#/components/schemas/AccessGroupUpdateInput"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"appliedTo":{"description":"The set of device unique identifiers to which this Access Group was applied. Only valid for shared access group.","example":"[deviceUid1, deviceUid2, ..., deviceUidN]","items":{"format":"uuid","type":"string"},"type":"array","uniqueItems":true},"createdDate":{"description":"The time (in UTC) at which Access Group was created, represented using the RFC-3339 standard.","example":"2023-12-13T05:15:44Z","format":"date-time","type":"string"},"entityUid":{"description":"The unique identifier, represented as a UUID, of the device/manager associated with the Access Group.","example":"7131daad-e813-4b8f-8f42-be1e241e8cdb","format":"uuid","type":"string"},"isShared":{"description":"The flag that identifies if access group is shared.","example":false,"type":"boolean"},"name":{"description":"The name of Access Group. Access Group names are unique in Security Cloud Control.","example":"my-example-access-group","type":"string"},"resources":{"description":"The set of of interface and direction pairs or global resource.","example":"Interface resource: [{\"interfaceName\": \"outside\"},{\"direction\": \"OUTBOUND\"}] or Global resource: [{\"global\": true}]","items":{"additionalProperties":{},"type":"object"},"type":"array","uniqueItems":true},"sharedAccessGroupUid":{"description":"The unique identifier, represented as a UUID, of the shared access group manager associated with the Access Group.","example":"7131daad-e813-4b8f-8f42-be1e241e8cdb","format":"uuid","type":"string"},"uid":{"description":"The unique identifier, represented as a UUID, of Access Group in Security Cloud Control.","example":"7131daad-e813-4b8f-8f42-be1e241e8cdb","format":"uuid","type":"string"},"updatedDate":{"description":"The time (in UTC) at which Access Group was updated, represented using the RFC-3339 standard.","example":"2023-12-13T05:15:44Z","format":"date-time","type":"string"}},"required":["entityUid","name","uid"],"type":"object","$$ref":"#/components/schemas/AccessGroup"}}},"description":"Security Cloud Control Access Group"},"400":{"content":{"application/json":{"schema":{"properties":{"details":{"additionalProperties":{"description":"Additional details, if any, about the error.","example":{},"type":"object"},"description":"Additional details, if any, about the error.","example":{},"type":"object"},"errorCode":{"description":"Unique code that describes the error.","enum":["INVALID_INPUT","UNAUTHORIZED","FORBIDDEN","NOT_FOUND","METHOD_NOT_ALLOWED","CONFLICT","TOO_MANY_REQUESTS","SERVER_ERROR","PROXY_ERROR","BAD_REQUEST","UNPROCESSABLE_ENTITY"],"example":"INVALID_INPUT","type":"string"},"errorMsg":{"description":"Human-readable error description in English.","example":"sample error","type":"string"}},"$$ref":"#/components/schemas/CommonApiError"}}},"description":"Invalid input provided. Check the response for details.","$$ref":"#/components/responses/http400BadRequest"},"403":{"content":{"application/json":{"schema":{"properties":{"details":{"additionalProperties":{"description":"Additional details, if any, about the error.","example":{},"type":"object"},"description":"Additional details, if any, about the error.","example":{},"type":"object"},"errorCode":{"description":"Unique code that describes the error.","enum":["INVALID_INPUT","UNAUTHORIZED","FORBIDDEN","NOT_FOUND","METHOD_NOT_ALLOWED","CONFLICT","TOO_MANY_REQUESTS","SERVER_ERROR","PROXY_ERROR","BAD_REQUEST","UNPROCESSABLE_ENTITY"],"example":"INVALID_INPUT","type":"string"},"errorMsg":{"description":"Human-readable error description in English.","example":"sample error","type":"string"}},"$$ref":"#/components/schemas/CommonApiError"}}},"description":"User does not have sufficient privileges to perform this operation.","$$ref":"#/components/responses/http403Forbidden"},"404":{"content":{"application/json":{"schema":{"properties":{"details":{"additionalProperties":{"description":"Additional details, if any, about the error.","example":{},"type":"object"},"description":"Additional details, if any, about the error.","example":{},"type":"object"},"errorCode":{"description":"Unique code that describes the error.","enum":["INVALID_INPUT","UNAUTHORIZED","FORBIDDEN","NOT_FOUND","METHOD_NOT_ALLOWED","CONFLICT","TOO_MANY_REQUESTS","SERVER_ERROR","PROXY_ERROR","BAD_REQUEST","UNPROCESSABLE_ENTITY"],"example":"INVALID_INPUT","type":"string"},"errorMsg":{"description":"Human-readable error description in English.","example":"sample error","type":"string"}},"$$ref":"#/components/schemas/CommonApiError"}}},"description":"Entity not found.","$$ref":"#/components/responses/http404NotFound"},"500":{"content":{"application/json":{"schema":{"properties":{"details":{"additionalProperties":{"description":"Additional details, if any, about the error.","example":{},"type":"object"},"description":"Additional details, if any, about the error.","example":{},"type":"object"},"errorCode":{"description":"Unique code that describes the error.","enum":["INVALID_INPUT","UNAUTHORIZED","FORBIDDEN","NOT_FOUND","METHOD_NOT_ALLOWED","CONFLICT","TOO_MANY_REQUESTS","SERVER_ERROR","PROXY_ERROR","BAD_REQUEST","UNPROCESSABLE_ENTITY"],"example":"INVALID_INPUT","type":"string"},"errorMsg":{"description":"Human-readable error description in English.","example":"sample error","type":"string"}},"$$ref":"#/components/schemas/CommonApiError"}}},"description":"Internal server error."}},"security":[{"bearerAuth":[]}],"summary":"Modify ASA Access Group","tags":["ASA Access Groups"],"__originalOperationId":"patchAccessGroup","method":"patch","path":"/v1/policies/asa/accessgroups/{accessGroupUid}"}}