Policies
List Policies
ListPoliciesResponse contains a list of policies with entity counts.
ErrorResponse defines a common error response structure.
GET /api/rbac/policies/list HTTP/1.1
Host: api.groundcover.com
Authorization: YOUR_API_KEY
Accept: */*
No content
Get Policy by ID
UUID of the policy to retrieve
Add response wrapper definition ---
ErrorResponse defines a common error response structure.
ErrorResponse defines a common error response structure.
ErrorResponse defines a common error response structure.
GET /api/rbac/policy/{id} HTTP/1.1
Host: api.groundcover.com
Authorization: YOUR_API_KEY
Accept: */*
No content
Update Policy
UUID of the policy to update
Optional new claim role for the policy.
The current revision number of the policy being updated (for optimistic locking).
Optional new description for the policy.
New name for the policy.
Add response wrapper definition ---
ErrorResponse defines a common error response structure.
ErrorResponse defines a common error response structure.
ErrorResponse defines a common error response structure.
PUT /api/rbac/policy/{id} HTTP/1.1
Host: api.groundcover.com
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 3110
{
"claimRole": "text",
"currentRevision": 1,
"dataScope": {
"advanced": {
"events": {
"conditions": [
{
"additionalFilter": "text",
"autoComplete": true,
"filterKeys": [
"text"
],
"filters": [
{
"op": "text",
"value": null
}
],
"isNullable": true,
"key": "text",
"origin": "text",
"type": "text"
}
],
"disabled": true,
"groups": [
{
"conditions": [
{
"additionalFilter": "text",
"autoComplete": true,
"filterKeys": [
"text"
],
"filters": [
{
"op": "text",
"value": null
}
],
"isNullable": true,
"key": "text",
"origin": "text",
"type": "text"
}
],
"disabled": true,
"groups": "[Circular Reference]",
"operator": "text"
}
],
"operator": "text"
},
"logs": {
"conditions": [
{
"additionalFilter": "text",
"autoComplete": true,
"filterKeys": [
"text"
],
"filters": [
{
"op": "text",
"value": null
}
],
"isNullable": true,
"key": "text",
"origin": "text",
"type": "text"
}
],
"disabled": true,
"groups": [
{
"conditions": [
{
"additionalFilter": "text",
"autoComplete": true,
"filterKeys": [
"text"
],
"filters": [
{
"op": "text",
"value": null
}
],
"isNullable": true,
"key": "text",
"origin": "text",
"type": "text"
}
],
"disabled": true,
"groups": "[Circular Reference]",
"operator": "text"
}
],
"operator": "text"
},
"metrics": {
"conditions": [
{
"additionalFilter": "text",
"autoComplete": true,
"filterKeys": [
"text"
],
"filters": [
{
"op": "text",
"value": null
}
],
"isNullable": true,
"key": "text",
"origin": "text",
"type": "text"
}
],
"disabled": true,
"groups": [
{
"conditions": [
{
"additionalFilter": "text",
"autoComplete": true,
"filterKeys": [
"text"
],
"filters": [
{
"op": "text",
"value": null
}
],
"isNullable": true,
"key": "text",
"origin": "text",
"type": "text"
}
],
"disabled": true,
"groups": "[Circular Reference]",
"operator": "text"
}
],
"operator": "text"
},
"traces": {
"conditions": [
{
"additionalFilter": "text",
"autoComplete": true,
"filterKeys": [
"text"
],
"filters": [
{
"op": "text",
"value": null
}
],
"isNullable": true,
"key": "text",
"origin": "text",
"type": "text"
}
],
"disabled": true,
"groups": [
{
"conditions": [
{
"additionalFilter": "text",
"autoComplete": true,
"filterKeys": [
"text"
],
"filters": [
{
"op": "text",
"value": null
}
],
"isNullable": true,
"key": "text",
"origin": "text",
"type": "text"
}
],
"disabled": true,
"groups": "[Circular Reference]",
"operator": "text"
}
],
"operator": "text"
},
"workloads": {
"conditions": [
{
"additionalFilter": "text",
"autoComplete": true,
"filterKeys": [
"text"
],
"filters": [
{
"op": "text",
"value": null
}
],
"isNullable": true,
"key": "text",
"origin": "text",
"type": "text"
}
],
"disabled": true,
"groups": [
{
"conditions": [
{
"additionalFilter": "text",
"autoComplete": true,
"filterKeys": [
"text"
],
"filters": [
{
"op": "text",
"value": null
}
],
"isNullable": true,
"key": "text",
"origin": "text",
"type": "text"
}
],
"disabled": true,
"groups": "[Circular Reference]",
"operator": "text"
}
],
"operator": "text"
}
},
"simple": {
"conditions": [
{
"additionalFilter": "text",
"autoComplete": true,
"filterKeys": [
"text"
],
"filters": [
{
"op": "text",
"value": null
}
],
"isNullable": true,
"key": "text",
"origin": "text",
"type": "text"
}
],
"disabled": true,
"groups": [
{
"conditions": [
{
"additionalFilter": "text",
"autoComplete": true,
"filterKeys": [
"text"
],
"filters": [
{
"op": "text",
"value": null
}
],
"isNullable": true,
"key": "text",
"origin": "text",
"type": "text"
}
],
"disabled": true,
"groups": "[Circular Reference]",
"operator": "text"
}
],
"operator": "text"
}
},
"description": "text",
"name": "text",
"role": {
"ANY_ADDITIONAL_PROPERTY": "text"
}
}
No content
Apply Policies to Users
List of user emails to apply policies to.
If true, replaces existing policies; otherwise appends.
List of policy UUIDs to apply.
NoContentResponse indicates success but that no response body is expected or included.
ErrorResponse defines a common error response structure.
ErrorResponse defines a common error response structure.
ErrorResponse defines a common error response structure.
POST /api/rbac/policy/apply HTTP/1.1
Host: api.groundcover.com
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 58
{
"emails": [
"text"
],
"override": true,
"policyUUIDs": [
"text"
]
}
No content
Delete Policy
UUID of the policy to delete
NoContentResponse indicates success but that no response body is expected or included.
ErrorResponse defines a common error response structure.
ErrorResponse defines a common error response structure.
ErrorResponse defines a common error response structure.
DELETE /api/rbac/policy/{id} HTTP/1.1
Host: api.groundcover.com
Authorization: YOUR_API_KEY
Accept: */*
No content
Create Policy
Optional claim role for the policy.
Optional description for the policy.
Name of the policy.
Add response wrapper definition --- Correct location for response wrapper
ErrorResponse defines a common error response structure.
ErrorResponse defines a common error response structure.
POST /api/rbac/policy/create HTTP/1.1
Host: api.groundcover.com
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 3090
{
"claimRole": "text",
"dataScope": {
"advanced": {
"events": {
"conditions": [
{
"additionalFilter": "text",
"autoComplete": true,
"filterKeys": [
"text"
],
"filters": [
{
"op": "text",
"value": null
}
],
"isNullable": true,
"key": "text",
"origin": "text",
"type": "text"
}
],
"disabled": true,
"groups": [
{
"conditions": [
{
"additionalFilter": "text",
"autoComplete": true,
"filterKeys": [
"text"
],
"filters": [
{
"op": "text",
"value": null
}
],
"isNullable": true,
"key": "text",
"origin": "text",
"type": "text"
}
],
"disabled": true,
"groups": "[Circular Reference]",
"operator": "text"
}
],
"operator": "text"
},
"logs": {
"conditions": [
{
"additionalFilter": "text",
"autoComplete": true,
"filterKeys": [
"text"
],
"filters": [
{
"op": "text",
"value": null
}
],
"isNullable": true,
"key": "text",
"origin": "text",
"type": "text"
}
],
"disabled": true,
"groups": [
{
"conditions": [
{
"additionalFilter": "text",
"autoComplete": true,
"filterKeys": [
"text"
],
"filters": [
{
"op": "text",
"value": null
}
],
"isNullable": true,
"key": "text",
"origin": "text",
"type": "text"
}
],
"disabled": true,
"groups": "[Circular Reference]",
"operator": "text"
}
],
"operator": "text"
},
"metrics": {
"conditions": [
{
"additionalFilter": "text",
"autoComplete": true,
"filterKeys": [
"text"
],
"filters": [
{
"op": "text",
"value": null
}
],
"isNullable": true,
"key": "text",
"origin": "text",
"type": "text"
}
],
"disabled": true,
"groups": [
{
"conditions": [
{
"additionalFilter": "text",
"autoComplete": true,
"filterKeys": [
"text"
],
"filters": [
{
"op": "text",
"value": null
}
],
"isNullable": true,
"key": "text",
"origin": "text",
"type": "text"
}
],
"disabled": true,
"groups": "[Circular Reference]",
"operator": "text"
}
],
"operator": "text"
},
"traces": {
"conditions": [
{
"additionalFilter": "text",
"autoComplete": true,
"filterKeys": [
"text"
],
"filters": [
{
"op": "text",
"value": null
}
],
"isNullable": true,
"key": "text",
"origin": "text",
"type": "text"
}
],
"disabled": true,
"groups": [
{
"conditions": [
{
"additionalFilter": "text",
"autoComplete": true,
"filterKeys": [
"text"
],
"filters": [
{
"op": "text",
"value": null
}
],
"isNullable": true,
"key": "text",
"origin": "text",
"type": "text"
}
],
"disabled": true,
"groups": "[Circular Reference]",
"operator": "text"
}
],
"operator": "text"
},
"workloads": {
"conditions": [
{
"additionalFilter": "text",
"autoComplete": true,
"filterKeys": [
"text"
],
"filters": [
{
"op": "text",
"value": null
}
],
"isNullable": true,
"key": "text",
"origin": "text",
"type": "text"
}
],
"disabled": true,
"groups": [
{
"conditions": [
{
"additionalFilter": "text",
"autoComplete": true,
"filterKeys": [
"text"
],
"filters": [
{
"op": "text",
"value": null
}
],
"isNullable": true,
"key": "text",
"origin": "text",
"type": "text"
}
],
"disabled": true,
"groups": "[Circular Reference]",
"operator": "text"
}
],
"operator": "text"
}
},
"simple": {
"conditions": [
{
"additionalFilter": "text",
"autoComplete": true,
"filterKeys": [
"text"
],
"filters": [
{
"op": "text",
"value": null
}
],
"isNullable": true,
"key": "text",
"origin": "text",
"type": "text"
}
],
"disabled": true,
"groups": [
{
"conditions": [
{
"additionalFilter": "text",
"autoComplete": true,
"filterKeys": [
"text"
],
"filters": [
{
"op": "text",
"value": null
}
],
"isNullable": true,
"key": "text",
"origin": "text",
"type": "text"
}
],
"disabled": true,
"groups": "[Circular Reference]",
"operator": "text"
}
],
"operator": "text"
}
},
"description": "text",
"name": "text",
"role": {
"ANY_ADDITIONAL_PROPERTY": "text"
}
}
No content
Last updated