Skip to main content

​
Summary

Change which principal is allowed to edit a permission range. Updates the principal fields on the start marker.
  • Operation ID: permissionRanges.updatePrincipal
  • API member path: editor.doc.permissionRanges.updatePrincipal(...)
  • Mutates document: yes
  • Idempotency: idempotent
  • Supports tracked mode: no
  • Supports dry run: yes
  • Deterministic target resolution: yes

​
Expected result

Returns a PermissionRangeMutationResult with the updated range info on success.

​
Input fields

FieldTypeRequiredDescription
idstringyes
principalobjectyes
principal.idstringno
principal.kindenumyes"everyone", "editor"

​
Example request

{
  "id": "id-001",
  "principal": {
    "id": "id-001",
    "kind": "everyone"
  }
}

​
Output fields

No fields.

​
Example response

{}

​
Pre-apply throws

  • TARGET_NOT_FOUND
  • INVALID_TARGET
  • INVALID_INPUT
  • CAPABILITY_UNAVAILABLE

​
Non-applied failure codes

  • None

​
Raw schemas

{
  "additionalProperties": false,
  "properties": {
    "id": {
      "type": "string"
    },
    "principal": {
      "additionalProperties": false,
      "properties": {
        "id": {
          "type": "string"
        },
        "kind": {
          "enum": [
            "everyone",
            "editor"
          ],
          "type": "string"
        }
      },
      "required": [
        "kind"
      ],
      "type": "object"
    }
  },
  "required": [
    "id",
    "principal"
  ],
  "type": "object"
}

{
  "type": "object"
}

{
  "type": "object"
}

{
  "type": "object"
}