Policies

get

List Policies

Authorizations
Responses
200

ListPoliciesResponse contains a list of policies with entity counts.

No content

get
GET /api/rbac/policies/list HTTP/1.1
Host: api.groundcover.com
Authorization: YOUR_API_KEY
Accept: */*

No content

get

Get Policy by ID

Authorizations
Path parameters
idstringRequired

UUID of the policy to retrieve

Responses
200

Add response wrapper definition ---

No content

get
GET /api/rbac/policy/{id} HTTP/1.1
Host: api.groundcover.com
Authorization: YOUR_API_KEY
Accept: */*

No content

put

Update Policy

Authorizations
Path parameters
idstringRequired

UUID of the policy to update

Body
claimRolestringOptional

Optional new claim role for the policy.

currentRevisioninteger · int32Optional

The current revision number of the policy being updated (for optimistic locking).

descriptionstringOptional

Optional new description for the policy.

namestringRequired

New name for the policy.

Responses
202

Add response wrapper definition ---

No content

put
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

post

Apply Policies to Users

Authorizations
Body
emailsstring[] · min: 1Required

List of user emails to apply policies to.

overridebooleanOptional

If true, replaces existing policies; otherwise appends.

policyUUIDsstring[] · min: 1Required

List of policy UUIDs to apply.

Responses
200Success

No content

post
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

Delete Policy

Authorizations
Path parameters
idstringRequired

UUID of the policy to delete

Responses
200Success

No content

delete
DELETE /api/rbac/policy/{id} HTTP/1.1
Host: api.groundcover.com
Authorization: YOUR_API_KEY
Accept: */*

No content

post

Create Policy

Authorizations
Body
claimRolestringOptional

Optional claim role for the policy.

descriptionstringOptional

Optional description for the policy.

namestringRequired

Name of the policy.

Responses
201

Add response wrapper definition --- Correct location for response wrapper

No content

post
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