Write Bundle

POST /v1/tenants/{tenant_id}/bundle/write The Write Bundle endpoint stores named bundle definitions for a tenant. Each bundle describes a set of relationship and attribute write/delete operations parameterized with template variables. Bundles are executed via the Run Bundle endpoint (POST /v1/tenants/{tenant_id}/data/run-bundle), letting you atomically apply a predictable set of authorization data changes in response to application events (e.g. organization_created, user_invited).

Path Parameters

string

required

The tenant identifier. Use t1 for single-tenant deployments. Must match ^([a-zA-Z0-9_\-@\.:+]{1,128}|\*)$.

Request Body

array

required

One or more bundle definitions to write.

Show item properties

string

required

A unique name for the bundle (e.g. organization_created). Used to reference the bundle when running it.

array

required

List of argument names (strings) that callers must supply when running the bundle (e.g. ["creatorID", "organizationID"]).

array

required

List of operations that define what data to write or delete. Each operation is applied atomically.

Show operation properties

array

Relationship tuples to create, using Go template syntax for substitution (e.g. "organization:{{.organizationID}}#admin@user:{{.creatorID}}").

array

Relationship tuples to delete, using template syntax.

array

Attributes to write, using template syntax (e.g. "organization:{{.organizationID}}$public|boolean:false").

array

Attributes to delete, using template syntax.

Response

array

The names of the bundles that were successfully written.

Example

curl --location --request POST 'localhost:3476/v1/tenants/{tenant_id}/bundle/write' \
--header 'Content-Type: application/json' \
--data-raw '{
    "bundles": [
        {
            "name": "organization_created",
            "arguments": [
                "creatorID",
                "organizationID"
            ],
            "operations": [
                {
                    "relationships_write": [
                        "organization:{{.organizationID}}#admin@user:{{.creatorID}}",
                        "organization:{{.organizationID}}#manager@user:{{.creatorID}}"
                    ],
                    "attributes_write": [
                        "organization:{{.organizationID}}$public|boolean:false"
                    ]
                }
            ]
        }
    ]
}'

Request body

{
  "bundles": [
    {
      "name": "organization_created",
      "arguments": ["creatorID", "organizationID"],
      "operations": [
        {
          "relationships_write": [
            "organization:{{.organizationID}}#admin@user:{{.creatorID}}",
            "organization:{{.organizationID}}#manager@user:{{.creatorID}}"
          ],
          "attributes_write": [
            "organization:{{.organizationID}}$public|boolean:false"
          ]
        }
      ]
    }
  ]
}

Response

{
  "names": ["organization_created"]
}

Error Codes

HTTP Status	Description
`400`	Bad request — invalid bundle definition
`401`	Unauthorized
`404`	Tenant not found
`429`	Rate limit exceeded
`500`	Internal server error

Introduction

Permission Service

Schema Service

Data Service

Tenancy & Bundle

Watch Service

Path Parameters

Request Body

Response

Example

Error Codes

​Path Parameters

​Request Body

​Response

​Example

​Error Codes

Path Parameters

Request Body

Response

Example

Error Codes