List Resource Groups - Cloud Security API

{"type":"api","title":"List Resource Groups","meta":{"id":"/apps/pubhub/media/cloud-security-apis-in-eft/9d37d008417d562ab46d4b67547a68457ce288d2/28c42199-71bc-32ee-998e-c19bc5c8456e","info":{"title":"Cisco Secure Access Private Resources and Resource Groups API","description":"Manage the Private Resources and Resource Groups in the organization.","version":"1.0.0","contact":{"name":"Cloud Security Developer Community"}},"security":[{"oauthFlow":[]}],"tags":[{"name":"Resource Groups","description":"The Secure Access Private Resource Groups"},{"name":"Private Resources","description":"The Secure Access Private Resources"},{"name":"Secure Access"}],"x-parser-conf":{"overview":{"markdownPath":"secure-access/reference/policies/private-resources-overview.md","uri":"secure-access-api-reference-private-resources-overview"}},"openapi":"3.0.1","servers":[{"url":"https://api.sse.cisco.com/{basePath}","variables":{"basePath":{"default":"policies/v2"}}}],"securitySchemes":{"oauthFlow":{"type":"oauth2","description":"The client credential flow.","flows":{"clientCredentials":{"tokenUrl":"https://api.sse.cisco.com/auth/v2/token","scopes":{"policies.privateresourcegroups:read":"Read the Private Resource Groups resources","policies.privateresourcegroups:write":"Write the Private Resource Groups resources","policies.privateresources:read":"Read the Private Resources resources","policies.privateresources:write":"Write the Private Resources resources"}}}}}},"spec":{"tags":["Resource Groups","Secure Access"],"summary":"List Resource Groups","description":"List the Private Resource Groups for the organization.","operationId":"listResourceGroups","security":[{"oauthFlow":["policies.privateresourcegroups:read"]}],"parameters":[{"name":"filters","in":"query","required":false,"description":"Filter the resource groups in the organization by one or more properties: `name`, `description`, `resourceId`, and `accessType`.\n\n* **name**—The name of the resource group. The value is case insensitive.\n* **description**—The description of the Resource Group. The value is case insensitive.\n* **resourceId**—The resource group includes the resource, which you can identify by the ID.\n* **accessType**—The resource group contains at least one resource. The resource has one of the types of access: `branch`, `network`, `client`, or `browser`.\n\nSpecify the filters in the JSON format.\n\nExample:\n\n```\n{ \"name\": \"West coast\", \"description\": \"West Coast\", \"resourceId\": 1234, \"accessType\": \"network\" }\n```","schema":{"type":"object","description":"The filters for the resource groups.","properties":{"name":{"type":"string","description":"The name of the Private Resource Group.\nThe Private Resource Group name must not have any special characters other than spaces and hyphens.","maxLength":100,"pattern":"^[a-zA-Z0-9- ]+$","example":"Westcoast Data Center","$$ref":"#/components/schemas/privateResourceGroupName"},"description":{"type":"string","description":"The description of the Private Resource Group.","maxLength":255,"example":"Private resources in Westcoast Data Center","$$ref":"#/components/schemas/descriptionPrivateResourceGroup"},"resourceId":{"type":"array","description":"The list of IDs for the private resources that belong in the group.\nThe list may be empty.","items":{"type":"integer","example":255,"description":"The private resource ID."},"example":[1234,562],"$$ref":"#/components/schemas/resourceIds"},"accessType":{"type":"array","description":"The list of connection properties that describe how end users can access private resources in the organization.\nBrowser-based access requires that all resource addresses use the HTTP or HTTPS protocols.\nBranch access is always enabled for a private resource.","items":{"anyOf":[{"type":"object","description":"The connection to private resources is defined for the Cisco Secure Client.","properties":{"type":{"type":"string","description":"The type of the connection is Cisco Secure Client.","enum":["client"],"example":"client"},"reachableAddresses":{"type":"array","description":"The list of IP address, CIDRs, FQDN, or wildcard FQDN destinations.\nIPv6 is not supported. Only applies to resources you configure for client-based Zero Trust Access.","items":{"type":"string","description":"An IP or CIDR address, FQDN, or wildcard FQDN destination.","example":"172.6.0.0/32"},"example":["172.6.0.0/32"],"$$ref":"#/components/schemas/reachableAddresses"}},"required":["type","reachableAddresses"],"example":{"type":"client","reachableAddresses":["jira.com"]},"$$ref":"#/components/schemas/clientBasedAccess"},{"type":"object","description":"The connection to private resources that is defined for a network.","properties":{"type":{"type":"string","description":"The type of the connection is network.","enum":["network"],"example":"network"}},"required":["type"],"example":{"type":"network"},"$$ref":"#/components/schemas/networkBasedAccess"},{"type":"object","description":"The properties of the browser-based request.","properties":{"type":{"type":"string","description":"The type of the connection is a browser.","enum":["browser"],"example":"browser"},"protocol":{"type":"string","description":"The protocol for the communication between the proxy and the Private Resource.\nOnly applicable for browser-based Zero Trust Network Access.","enum":["HTTPS","HTTP"],"example":"HTTPS","$$ref":"#/components/schemas/protocolProxyToResource"},"sni":{"type":"string","description":"The Server Name Indication (SNI) domain name.\nOnly applicable for browser-based Zero Trust Access and when you select the HTTPS protocol.\nThe SNI must be a valid domain.","example":"","$$ref":"#/components/schemas/sni"},"sslVerificationEnabled":{"type":"boolean","description":"Specify whether to enable upstream SSL verification for the internally hosted URL by the customer.\nApplicable for browser-based Zero Trust Access only and when you select the HTTPS protocol.","default":true,"example":true,"$$ref":"#/components/schemas/sslVerificationEnabled"},"externalFQDNPrefix":{"type":"string","maxLength":50,"description":"The external fully qualified domain name (FQDN) prefix."}},"required":["type","protocol"],"example":{"type":"browser","protocol":"HTTPS"},"$$ref":"#/components/schemas/browserBasedAccessRequest"}]},"example":[{"type":"browser","externalFQDNPrefix":"jira","protocol":"HTTPS","sni":"xyz123.jira.com","sslVerificationEnabled":true},{"type":"client","reachableAddresses":["192.168.0.1","example.com"]},{"type":"network"}],"$$ref":"#/components/schemas/accessTypesRequest"}}},"example":{"name":"group one"},"$$ref":"#/components/parameters/resourceGroupsFilters"},{"name":"offset","in":"query","description":"An integer that represents an index in the collection. If the limit is `10` and the offset is `0`, the offset for next page is `10`.","schema":{"type":"integer","default":0},"required":false,"example":10,"$$ref":"#/components/parameters/offset"},{"name":"limit","in":"query","description":"The number of items from the collection to return on a page.\nThe default value sets `10` items on a page. The system allows a maximum of 1000 items on a page.","schema":{"type":"integer","default":10,"maximum":1000},"required":false,"example":40,"$$ref":"#/components/parameters/limit"},{"name":"sortBy","in":"query","description":"Specify the field that is used to sort the Private Resource Groups.","schema":{"type":"string","enum":["name","resourceGroupId","resourcesCount","createdAt","modifiedAt"],"default":"name"},"example":"name","$$ref":"#/components/parameters/resourceGroupsSortBy"},{"name":"sortOrder","in":"query","description":"Specify the order to sort the Private Resources. The default value is `asc`.","schema":{"type":"string","enum":["asc","desc"],"default":"asc"},"required":false,"example":"desc","$$ref":"#/components/parameters/sortOrder"}],"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":{"type":"object","description":"List all Private Resource Groups in the organization. If you set query filters on the request,\nyou can get a subset of the Private Resources in the collection.","properties":{"items":{"type":"array","items":{"type":"object","description":"Get the Resource Group.","properties":{"resourceGroupId":{"type":"integer","description":"The ID of the Private Resource Group.","readOnly":true,"example":1122321},"name":{"type":"string","description":"The name of the Private Resource Group.\nThe Private Resource Group name must not have any special characters other than spaces and hyphens.","maxLength":100,"pattern":"^[a-zA-Z0-9- ]+$","example":"Westcoast Data Center","$$ref":"#/components/schemas/privateResourceGroupName"},"description":{"type":"string","description":"The description of the Private Resource Group.","maxLength":255,"example":"Private resources in Westcoast Data Center","$$ref":"#/components/schemas/descriptionPrivateResourceGroup"},"resourceIds":{"type":"array","description":"The list of IDs for the private resources that belong in the group.\nThe list may be empty.","items":{"type":"integer","example":255,"description":"The private resource ID."},"example":[1234,562],"$$ref":"#/components/schemas/resourceIds"},"createdAt":{"type":"string","format":"date-time","readOnly":true,"example":"2021-12-13T16:07:07.222Z","description":"The date and time when the Private Resource Group was created."},"modifiedAt":{"type":"string","format":"date-time","readOnly":true,"example":"2021-12-13T16:07:07.222Z","description":"The date and time when the Private Resource Group was updated."},"createdBy":{"type":"string","description":"The ID of the user who created the Private Resource Group.","example":"123456"},"modifiedBy":{"type":"string","description":"The ID of the user who last modified the Private Resource Group.","example":"987654"}},"example":{"resourceGroupId":1122341,"name":"namePrivateResourceGroup","description":"The description of the private resource group.","resourceIds":[1234,5661],"createdAt":"2021-12-13T16:07:07.222Z","modifiedAt":"2021-12-13T16:07:07.222Z","createdBy":"123455","modifiedBy":"12345"},"$$ref":"#/components/schemas/privateResourceGroupResponse"}},"offset":{"type":"integer","description":"The index where the server starts to read the collection."},"limit":{"type":"integer","description":"The number of items returned on a page in the response."},"total":{"type":"integer","description":"The total count of the Private Resource Groups read in the collection."}},"example":{"items":[{"resourceGroupId":1122341,"name":"namePrivateResourceGroup","description":"The description of the private resource group.","resourceIds":[1234,5661],"createdAt":"2021-12-13T16:07:07.222Z","modifiedAt":"2021-12-13T16:07:07.222Z","createdBy":"123455","modifiedBy":"12345"}],"offset":0,"limit":100,"total":200},"$$ref":"#/components/schemas/privateResourceGroupList"},"example":{"items":[{"resourceGroupId":1122341,"name":"namePrivateResourceGroup","description":"The description of the private resource group.","resourceIds":[1234,5661]}],"offset":0,"limit":100,"total":200}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","description":"Error message explaining the reason for failure.","example":"The organization ID is a numeric value."},"requestId":{"type":"string","description":"The ID of the request.","example":"7d318524-d5a4-4fd8-8b29-ad295b2f035b"}}}}},"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"}},"$$ref":"#/components/responses/400Error"},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","description":"Error message explaining the reason for failure.","example":"Authorization token is invalid."},"requestId":{"type":"string","description":"The ID of the request.","example":"7d318524-d5a4-4fd8-8b29-ad295b2f035b"}}}}},"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"}},"$$ref":"#/components/responses/401Error"},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","description":"Error message explaining the reason for failure.","example":"Not Authorized"},"requestId":{"type":"string","description":"The ID of the request.","example":"7d318524-d5a4-4fd8-8b29-ad295b2f035b"}}}}},"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"}},"$$ref":"#/components/responses/403Error"},"404":{"description":"Not Found","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","description":"Error message explaining the reason for failure.","example":"Not Found"},"requestId":{"type":"string","description":"The ID of the request.","example":"7d318524-d5a4-4fd8-8b29-ad295b2f035b"}}}}},"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"}},"$$ref":"#/components/responses/404Error"},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","description":"Error message explaining the reason for failure.","example":"Internal Server Error"},"requestId":{"type":"string","description":"The ID of the request.","example":"7d318524-d5a4-4fd8-8b29-ad295b2f035b"}}}}},"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"}},"$$ref":"#/components/responses/500Error"}},"__originalOperationId":"listResourceGroups","method":"get","path":"/privateResourceGroups"}}