---
updatedAt: 2026-04-29T23:07:57.000Z
agentTools:
  projectIndex: https://docs.bigeye.com/llms.txt
---

# Change a group's access to workspaces

# OpenAPI definition

```json
{
  "openapi": "3.0.0",
  "info": {
    "title": "Metadata",
    "version": "version not set"
  },
  "paths": {
    "/api/v1/groups/grants": {
      "put": {
        "operationId": "GroupService_BulkChangeGroupGrants",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/generatedBulkChangeGroupGrantsRequest"
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "description": "A successful response.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/generatedBulkChangeGroupGrantsResponse"
                }
              }
            }
          },
          "default": {
            "description": "An unexpected error response.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/runtimeError"
                }
              }
            }
          }
        },
        "summary": "Change a group's access to workspaces",
        "tags": [
          "GroupService"
        ]
      }
    }
  },
  "security": [
    {
      "basicAuth": []
    },
    {
      "Personal_API_Key": []
    }
  ],
  "servers": [
    {
      "url": "https://app.bigeye.com"
    }
  ],
  "components": {
    "securitySchemes": {
      "basicAuth": {
        "type": "http",
        "scheme": "basic"
      },
      "Personal_API_Key": {
        "description": "Add 'apikey ' to the beginning of your api key",
        "in": "header",
        "name": "Authorization",
        "type": "apiKey"
      }
    },
    "schemas": {
      "generatedBulkChangeGroupGrantsRequest": {
        "properties": {
          "operation": {
            "$ref": "#/components/schemas/generatedRoleOperation"
          },
          "requests": {
            "items": {
              "$ref": "#/components/schemas/generatedGrant"
            },
            "type": "array"
          }
        },
        "type": "object"
      },
      "generatedBulkChangeGroupGrantsResponse": {
        "properties": {
          "failedUpdates": {
            "items": {
              "$ref": "#/components/schemas/generatedFailedGroupRoleUpdate"
            },
            "type": "array"
          },
          "successfulRequests": {
            "items": {
              "$ref": "#/components/schemas/generatedGrant"
            },
            "type": "array"
          }
        },
        "type": "object"
      },
      "generatedFailedGroupRoleUpdate": {
        "properties": {
          "reason": {
            "type": "string"
          },
          "request": {
            "$ref": "#/components/schemas/generatedGrant"
          }
        },
        "type": "object"
      },
      "generatedGrant": {
        "properties": {
          "group": {
            "$ref": "#/components/schemas/generatedIdAndDisplayName"
          },
          "id": {
            "format": "int32",
            "type": "integer"
          },
          "role": {
            "$ref": "#/components/schemas/generatedRoleV2"
          },
          "workspace": {
            "$ref": "#/components/schemas/generatedIdAndDisplayName"
          }
        },
        "type": "object"
      },
      "generatedIdAndDisplayName": {
        "properties": {
          "displayName": {
            "type": "string"
          },
          "id": {
            "format": "int32",
            "type": "integer"
          }
        },
        "type": "object"
      },
      "generatedPermissionAction": {
        "default": "PERMISSION_ACTION_UNSPECIFIED",
        "enum": [
          "PERMISSION_ACTION_UNSPECIFIED",
          "PERMISSION_ACTION_ALL",
          "PERMISSION_ACTION_PREVIEW",
          "PERMISSION_ACTION_WRITE",
          "PERMISSION_ACTION_EXECUTE",
          "PERMISSION_ACTION_READ",
          "PERMISSION_ACTION_VIEW",
          "PERMISSION_ACTION_MANAGE",
          "PERMISSION_ACTION_REFRESH",
          "PERMISSION_ACTION_CREATE",
          "PERMISSION_ACTION_DELETE",
          "PERMISSION_ACTION_ASSIGN",
          "PERMISSION_ACTION_DOWNLOAD",
          "PERMISSION_ACTION_INGEST",
          "PERMISSION_ACTION_RUN"
        ],
        "type": "string"
      },
      "generatedPermissionDomain": {
        "default": "PERMISSION_DOMAIN_UNSPECIFIED",
        "enum": [
          "PERMISSION_DOMAIN_UNSPECIFIED",
          "PERMISSION_DOMAIN_ALL",
          "PERMISSION_DOMAIN_TABLE",
          "PERMISSION_DOMAIN_CUSTOM_RULE",
          "PERMISSION_DOMAIN_COLLECTION",
          "PERMISSION_DOMAIN_WORKSPACE_TAG",
          "PERMISSION_DOMAIN_WORKSPACE_TAG_ENTITY",
          "PERMISSION_DOMAIN_PROFILE",
          "PERMISSION_DOMAIN_SCAN_JOB",
          "PERMISSION_DOMAIN_DATA_CLASS",
          "PERMISSION_DOMAIN_CLASSIFIER",
          "PERMISSION_DOMAIN_GLOSSARY_TERM",
          "PERMISSION_DOMAIN_AI_AGENT_USAGE_USER",
          "PERMISSION_DOMAIN_USER",
          "PERMISSION_DOMAIN_SERVICE_ACCOUNT",
          "PERMISSION_DOMAIN_ROLE",
          "PERMISSION_DOMAIN_GROUP",
          "PERMISSION_DOMAIN_WORKSPACE",
          "PERMISSION_DOMAIN_BIGEYE_AGENT",
          "PERMISSION_DOMAIN_ADVANCED_SETTING",
          "PERMISSION_DOMAIN_DOMAIN",
          "PERMISSION_DOMAIN_ATTRIBUTE_CONFIG",
          "PERMISSION_DOMAIN_BIGAI_CHAT",
          "PERMISSION_DOMAIN_CONNECTION",
          "PERMISSION_DOMAIN_DATA_ASSET",
          "PERMISSION_DOMAIN_LINEAGE",
          "PERMISSION_DOMAIN_ISSUE",
          "PERMISSION_DOMAIN_EXTERNAL_TICKET",
          "PERMISSION_DOMAIN_SCHEDULE",
          "PERMISSION_DOMAIN_NOTIFICATION_CONFIG",
          "PERMISSION_DOMAIN_METRIC",
          "PERMISSION_DOMAIN_SQL_RULE",
          "PERMISSION_DOMAIN_JOIN_RULE",
          "PERMISSION_DOMAIN_DELTA",
          "PERMISSION_DOMAIN_BIGCONFIG",
          "PERMISSION_DOMAIN_METRIC_TEMPLATE",
          "PERMISSION_DOMAIN_GLOBAL_METRIC_TEMPLATE",
          "PERMISSION_DOMAIN_VIRTUAL_TABLE",
          "PERMISSION_DOMAIN_DIMENSION",
          "PERMISSION_DOMAIN_LINKED_ASSET",
          "PERMISSION_DOMAIN_AI_AGENT",
          "PERMISSION_DOMAIN_POLICY"
        ],
        "type": "string"
      },
      "generatedRoleOperation": {
        "default": "ROLE_OPERATION_UNSPECIFIED",
        "enum": [
          "ROLE_OPERATION_UNSPECIFIED",
          "ROLE_OPERATION_GRANT",
          "ROLE_OPERATION_REVOKE"
        ],
        "type": "string"
      },
      "generatedRolePermission": {
        "properties": {
          "actions": {
            "items": {
              "$ref": "#/components/schemas/generatedPermissionAction"
            },
            "type": "array"
          },
          "domains": {
            "items": {
              "$ref": "#/components/schemas/generatedPermissionDomain"
            },
            "type": "array"
          }
        },
        "type": "object"
      },
      "generatedRoleType": {
        "default": "ROLE_TYPE_UNSPECIFIED",
        "enum": [
          "ROLE_TYPE_UNSPECIFIED",
          "ROLE_TYPE_ADMIN",
          "ROLE_TYPE_MANAGE",
          "ROLE_TYPE_EDIT",
          "ROLE_TYPE_VIEW",
          "ROLE_TYPE_CUSTOM"
        ],
        "type": "string"
      },
      "generatedRoleV2": {
        "properties": {
          "description": {
            "type": "string"
          },
          "id": {
            "format": "int32",
            "type": "integer"
          },
          "name": {
            "type": "string"
          },
          "rolePermissions": {
            "items": {
              "$ref": "#/components/schemas/generatedRolePermission"
            },
            "type": "array"
          },
          "roleType": {
            "$ref": "#/components/schemas/generatedRoleType"
          }
        },
        "type": "object"
      },
      "protobufAny": {
        "properties": {
          "typeUrl": {
            "type": "string"
          },
          "value": {
            "format": "byte",
            "type": "string"
          }
        },
        "type": "object"
      },
      "runtimeError": {
        "properties": {
          "code": {
            "format": "int32",
            "type": "integer"
          },
          "details": {
            "items": {
              "$ref": "#/components/schemas/protobufAny"
            },
            "type": "array"
          },
          "error": {
            "type": "string"
          },
          "message": {
            "type": "string"
          }
        },
        "type": "object"
      }
    }
  }
}
```