package authzed.api.v1alpha1

Get desktop application:
View/edit binary Protocol Buffers messages

SchemaService implements operations on a Permissions System's Schema.

• rpc ReadSchema (ReadSchemaRequest, ReadSchemaResponse)

  schema.proto:16

  Read returns the current Object Definitions for a Permissions System. Errors include: - INVALID_ARGUMENT: a provided value has failed to semantically validate - NOT_FOUND: one of the Object Definitions being requested does not exist

  message ReadSchemaRequest

  schema.proto:26

  ReadSchemaRequest is the required data to read Object Definitions from a Schema.

  • repeated string object_definitions_names = 1

    The list of names of the Object Definitions that are being requested. These names must be fully qualified with their namespace (e.g. myblog/post).

  message ReadSchemaResponse

  schema.proto:39

  ReadSchemaResponse is the resulting data after having read the Object Definitions from a Schema.

  • repeated string object_definitions = 1

    The Object Definitions that were requested.

  • string computed_definitions_revision = 2

    The computed revision of the returned object definitions.

• rpc WriteSchema (WriteSchemaRequest, WriteSchemaResponse)

  schema.proto:21

  Write overwrites the current Object Definitions for a Permissions System. Any Object Definitions that exist, but are not included will be deleted.

  message WriteSchemaRequest

  schema.proto:49

  WriteSchemaRequest is the required data used to "upsert" the Schema of a Permissions System.

  • string schema = 1

    The Schema containing one or more Object Definitions that will be written to the Permissions System.

    256KiB

  • string optional_definitions_revision_precondition = 2

    If specified, the existing revision of object definitions in the schema that must be present for the write to succeed. If the revision specified differs (i.e. the underlying schema has changed), the write call will fail with a FAILED_PRECONDITION error.

  message WriteSchemaResponse

  schema.proto:62

  WriteSchemaResponse is the resulting data after having written a Schema to a Permissions System.

  • repeated string object_definitions_names = 1

    The names of the Object Definitions that were written.

  • string computed_definitions_revision = 2

    The computed revision of the written object definitions.

WatchResourcesService is used to receive a stream of updates for resources of a specific (resource type, permission, subject) combination.

• rpc WatchResources (WatchResourcesRequest, stream WatchResourcesResponse)

  watchresources_service.proto:18

  WatchResources initiates a watch for permission changes for the provided (resource type, permission, subject) pair.

  message WatchResourcesRequest

  watchresources_service.proto:29

  WatchResourcesRequest starts a watch for specific permission updates for the given resource and subject types.

  • string resource_object_type = 1

    resource_object_type is the type of resource object for which we will watch for changes.

  • string permission = 2

    permission is the name of the permission or relation for which we will watch for changes.

  • string subject_object_type = 3

    subject_object_type is the type of the subject resource for which we will watch for changes.

  • string optional_subject_relation = 4

    optional_subject_relation allows you to specify a group of subjects to watch for a given subject type.

  • optional v1.ZedToken optional_start_cursor = 5

  message WatchResourcesResponse

  watchresources_service.proto:80

  WatchResourcesResponse enumerates the list of permission updates that have occurred as a result of one or more relationship updates.

  • repeated PermissionUpdate updates = 1

  • optional v1.ZedToken changes_through = 2

PermissionUpdate represents a single permission update for a specific subject's permissions.

Used in: WatchResourcesResponse

• optional v1.SubjectReference subject = 1

  subject defines the subject resource whose permissions have changed.

• optional v1.ObjectReference resource = 2

  resource defines the specific object in the system.

• string relation = 3

• PermissionUpdate.Permissionship updated_permission = 4

todo: work this into the v1 core API at some point since it's used across services.

Used in: PermissionUpdate

• PERMISSIONSHIP_UNSPECIFIED = 0

• PERMISSIONSHIP_NO_PERMISSION = 1

• PERMISSIONSHIP_HAS_PERMISSION = 2