Get Resource Group - Secure Access for China

{"type":"api","title":"Get Resource Group","meta":{"id":"/apps/pubhub/media/secure-access-for-china/318ddd7717f4865220eea69b480686bd569e1a76/ca825fab-e2c4-3b59-a5cd-105f1099feae","info":{"title":"Cisco Secure Access China 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":"reference/policies/private-resources-overview.md"}},"openapi":"3.0.1","servers":[{"url":"https://cisco.secureaccesschina.cn/{basePath}","variables":{"basePath":{"default":"policies/v2"}}}],"securitySchemes":{"oauthFlow":{"type":"oauth2","description":"The client credential flow.","flows":{"clientCredentials":{"tokenUrl":"https://api.ciscosecureaccess.cn/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":{"summary":"Get Resource Group","operationId":"getPrivateResourceGroup","tags":["Resource Groups","Secure Access"],"description":"Get the details about a Private Resource Group.","security":[{"oauthFlow":["policies.privateresourcegroups:read"]}],"parameters":[{"name":"id","in":"path","description":"The ID of the Private Resource Group.","required":true,"schema":{"type":"integer"},"$$ref":"#/components/parameters/privateResourceGroupId"}],"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":"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"},"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"}}}},"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":"getPrivateResourceGroup","method":"get","path":"/privateResourceGroups/{id}"}}