Package com.authzed.api.v1
package com.authzed.api.v1
-
ClassDescriptionAlgebraicSubjectSet is a subject set which is computed based on applying the specified operation to the operands according to the algebra of sets.AlgebraicSubjectSet is a subject set which is computed based on applying the specified operation to the operands according to the algebra of sets.Protobuf enum
authzed.api.v1.AlgebraicSubjectSet.OperationProtobuf typeauthzed.api.v1.BulkCheckPermissionPairProtobuf typeauthzed.api.v1.BulkCheckPermissionPairNOTE: Deprecated now that BulkCheckPermission has been promoted to the stable API as "CheckBulkPermission".NOTE: Deprecated now that BulkCheckPermission has been promoted to the stable API as "CheckBulkPermission".Protobuf typeauthzed.api.v1.BulkCheckPermissionRequestItemProtobuf typeauthzed.api.v1.BulkCheckPermissionRequestItemProtobuf typeauthzed.api.v1.BulkCheckPermissionResponseProtobuf typeauthzed.api.v1.BulkCheckPermissionResponseProtobuf typeauthzed.api.v1.BulkCheckPermissionResponseItemProtobuf typeauthzed.api.v1.BulkCheckPermissionResponseItemBulkExportRelationshipsRequest represents a resumable request for all relationships from the server.BulkExportRelationshipsRequest represents a resumable request for all relationships from the server.BulkExportRelationshipsResponse is one page in a stream of relationship groups that meet the criteria specified by the originating request.BulkExportRelationshipsResponse is one page in a stream of relationship groups that meet the criteria specified by the originating request.BulkImportRelationshipsRequest represents one batch of the streaming BulkImportRelationships API.BulkImportRelationshipsRequest represents one batch of the streaming BulkImportRelationships API.BulkImportRelationshipsResponse is returned on successful completion of the bulk load stream, and contains the total number of relationships loaded.BulkImportRelationshipsResponse is returned on successful completion of the bulk load stream, and contains the total number of relationships loaded.CaveatEvalInfo holds information about a caveat expression that was evaluated.CaveatEvalInfo holds information about a caveat expression that was evaluated.Protobuf enumauthzed.api.v1.CaveatEvalInfo.ResultProtobuf typeauthzed.api.v1.CheckBulkPermissionsPairProtobuf typeauthzed.api.v1.CheckBulkPermissionsPairCheckBulkPermissionsRequest issues a check on whether a subject has permission or is a member of a relation on a specific resource for each item in the list.CheckBulkPermissionsRequest issues a check on whether a subject has permission or is a member of a relation on a specific resource for each item in the list.Protobuf typeauthzed.api.v1.CheckBulkPermissionsRequestItemProtobuf typeauthzed.api.v1.CheckBulkPermissionsRequestItemProtobuf typeauthzed.api.v1.CheckBulkPermissionsResponseProtobuf typeauthzed.api.v1.CheckBulkPermissionsResponseProtobuf typeauthzed.api.v1.CheckBulkPermissionsResponseItemProtobuf typeauthzed.api.v1.CheckBulkPermissionsResponseItemCheckDebugTrace is a recursive trace of the requests made for resolving a CheckPermission API call.CheckDebugTrace is a recursive trace of the requests made for resolving a CheckPermission API call.Protobuf enumauthzed.api.v1.CheckDebugTrace.PermissionshipProtobuf enumauthzed.api.v1.CheckDebugTrace.PermissionTypeProtobuf typeauthzed.api.v1.CheckDebugTrace.SubProblemsProtobuf typeauthzed.api.v1.CheckDebugTrace.SubProblemsCheckPermissionRequest issues a check on whether a subject has a permission or is a member of a relation, on a specific resource.CheckPermissionRequest issues a check on whether a subject has a permission or is a member of a relation, on a specific resource.Protobuf typeauthzed.api.v1.CheckPermissionResponseProtobuf typeauthzed.api.v1.CheckPermissionResponseProtobuf enumauthzed.api.v1.CheckPermissionResponse.PermissionshipConsistency will define how a request is handled by the backend.Consistency will define how a request is handled by the backend.ContextualizedCaveat represents a reference to a caveat to be used by caveated relationships.ContextualizedCaveat represents a reference to a caveat to be used by caveated relationships.Cursor is used to provide resumption of listing between calls to APIs such as LookupResources.Cursor is used to provide resumption of listing between calls to APIs such as LookupResources.DebugInformation defines debug information returned by an API call in a footer when requested with a specific debugging header.DebugInformation defines debug information returned by an API call in a footer when requested with a specific debugging header.DeleteRelationshipsRequest specifies which Relationships should be deleted, requesting the delete of *ALL* relationships that match the specified filters.DeleteRelationshipsRequest specifies which Relationships should be deleted, requesting the delete of *ALL* relationships that match the specified filters.Protobuf typeauthzed.api.v1.DeleteRelationshipsResponseProtobuf typeauthzed.api.v1.DeleteRelationshipsResponseProtobuf enumauthzed.api.v1.DeleteRelationshipsResponse.DeletionProgressDirectSubjectSet is a subject set which is simply a collection of subjects.DirectSubjectSet is a subject set which is simply a collection of subjects.Defines the supported values for `google.rpc.ErrorInfo.reason` for the `authzed.com` error domain.ExpandPermissionTreeRequest returns a tree representing the expansion of all relationships found accessible from a permission or relation on a particular resource.ExpandPermissionTreeRequest returns a tree representing the expansion of all relationships found accessible from a permission or relation on a particular resource.Protobuf typeauthzed.api.v1.ExpandPermissionTreeResponseProtobuf typeauthzed.api.v1.ExpandPermissionTreeResponseExpCaveat is the representation of a caveat in the schema.ExpCaveat is the representation of a caveat in the schema.ExpCaveatParameter is the representation of a parameter in a caveat.ExpCaveatParameter is the representation of a parameter in a caveat.Protobuf typeauthzed.api.v1.ExpCaveatParameterTypeChangeProtobuf typeauthzed.api.v1.ExpCaveatParameterTypeChangeExpDefinition is the representation of a definition in the schema.ExpDefinition is the representation of a definition in the schema.Protobuf typeauthzed.api.v1.ExperimentalComputablePermissionsRequestProtobuf typeauthzed.api.v1.ExperimentalComputablePermissionsRequestProtobuf typeauthzed.api.v1.ExperimentalComputablePermissionsResponseProtobuf typeauthzed.api.v1.ExperimentalComputablePermissionsResponseProtobuf typeauthzed.api.v1.ExperimentalCountRelationshipsRequestProtobuf typeauthzed.api.v1.ExperimentalCountRelationshipsRequestProtobuf typeauthzed.api.v1.ExperimentalCountRelationshipsResponseProtobuf typeauthzed.api.v1.ExperimentalCountRelationshipsResponseProtobuf typeauthzed.api.v1.ExperimentalDependentRelationsRequestProtobuf typeauthzed.api.v1.ExperimentalDependentRelationsRequestProtobuf typeauthzed.api.v1.ExperimentalDependentRelationsResponseProtobuf typeauthzed.api.v1.ExperimentalDependentRelationsResponseProtobuf typeauthzed.api.v1.ExperimentalDiffSchemaRequestProtobuf typeauthzed.api.v1.ExperimentalDiffSchemaRequestProtobuf typeauthzed.api.v1.ExperimentalDiffSchemaResponseProtobuf typeauthzed.api.v1.ExperimentalDiffSchemaResponseProtobuf typeauthzed.api.v1.ExperimentalReflectSchemaRequestProtobuf typeauthzed.api.v1.ExperimentalReflectSchemaRequestProtobuf typeauthzed.api.v1.ExperimentalReflectSchemaResponseProtobuf typeauthzed.api.v1.ExperimentalReflectSchemaResponseProtobuf typeauthzed.api.v1.ExperimentalRegisterRelationshipCounterRequestProtobuf typeauthzed.api.v1.ExperimentalRegisterRelationshipCounterRequestProtobuf typeauthzed.api.v1.ExperimentalRegisterRelationshipCounterResponseProtobuf typeauthzed.api.v1.ExperimentalRegisterRelationshipCounterResponseExperimentalService exposes a number of APIs that are currently being prototyped and tested for future inclusion in the stable API.ExperimentalService exposes a number of APIs that are currently being prototyped and tested for future inclusion in the stable API.A stub to allow clients to do synchronous rpc calls to service ExperimentalService.A stub to allow clients to do ListenableFuture-style rpc calls to service ExperimentalService.Base class for the server implementation of the service ExperimentalService.A stub to allow clients to do asynchronous rpc calls to service ExperimentalService.Protobuf typeauthzed.api.v1.ExperimentalUnregisterRelationshipCounterRequestProtobuf typeauthzed.api.v1.ExperimentalUnregisterRelationshipCounterRequestProtobuf typeauthzed.api.v1.ExperimentalUnregisterRelationshipCounterResponseProtobuf typeauthzed.api.v1.ExperimentalUnregisterRelationshipCounterResponseExportBulkRelationshipsRequest represents a resumable request for all relationships from the server.ExportBulkRelationshipsRequest represents a resumable request for all relationships from the server.ExportBulkRelationshipsResponse is one page in a stream of relationship groups that meet the criteria specified by the originating request.ExportBulkRelationshipsResponse is one page in a stream of relationship groups that meet the criteria specified by the originating request.ExpPermission is the representation of a permission in the schema.ExpPermission is the representation of a permission in the schema.ExpRelation is the representation of a relation in the schema.ExpRelation is the representation of a relation in the schema.ExpRelationReference is a reference to a relation or permission in the schema.ExpRelationReference is a reference to a relation or permission in the schema.Protobuf typeauthzed.api.v1.ExpRelationSubjectTypeChangeProtobuf typeauthzed.api.v1.ExpRelationSubjectTypeChangeExpSchemaDiff is the representation of a diff between two schemas.ExpSchemaDiff is the representation of a diff between two schemas.ExpSchemaFilter is a filter that can be applied to the schema on reflection.ExpSchemaFilter is a filter that can be applied to the schema on reflection.ExpTypeReference is the representation of a type reference in the schema.ExpTypeReference is the representation of a type reference in the schema.ImportBulkRelationshipsRequest represents one batch of the streaming ImportBulkRelationships API.ImportBulkRelationshipsRequest represents one batch of the streaming ImportBulkRelationships API.ImportBulkRelationshipsResponse is returned on successful completion of the bulk load stream, and contains the total number of relationships loaded.ImportBulkRelationshipsResponse is returned on successful completion of the bulk load stream, and contains the total number of relationships loaded.LookupPermissionship represents whether a Lookup response was partially evaluated or notLookupResourcesRequest performs a lookup of all resources of a particular kind on which the subject has the specified permission or the relation in which the subject exists, streaming back the IDs of those resources.LookupResourcesRequest performs a lookup of all resources of a particular kind on which the subject has the specified permission or the relation in which the subject exists, streaming back the IDs of those resources.LookupResourcesResponse contains a single matching resource object ID for the requested object type, permission, and subject.LookupResourcesResponse contains a single matching resource object ID for the requested object type, permission, and subject.LookupSubjectsRequest performs a lookup of all subjects of a particular kind for which the subject has the specified permission or the relation in which the subject exists, streaming back the IDs of those subjects.LookupSubjectsRequest performs a lookup of all subjects of a particular kind for which the subject has the specified permission or the relation in which the subject exists, streaming back the IDs of those subjects.Protobuf enumauthzed.api.v1.LookupSubjectsRequest.WildcardOptionLookupSubjectsResponse contains a single matching subject object ID for the requested subject object type on the permission or relation.LookupSubjectsResponse contains a single matching subject object ID for the requested subject object type on the permission or relation.ObjectReference is used to refer to a specific object in the system.ObjectReference is used to refer to a specific object in the system.PartialCaveatInfo carries information necessary for the client to take action in the event a response contains a partially evaluated caveatPartialCaveatInfo carries information necessary for the client to take action in the event a response contains a partially evaluated caveatPermissionRelationshipTree is used for representing a tree of a resource and its permission relationships with other objects.PermissionRelationshipTree is used for representing a tree of a resource and its permission relationships with other objects.PermissionsService implements a set of RPCs that perform operations on relationships and permissions.PermissionsService implements a set of RPCs that perform operations on relationships and permissions.A stub to allow clients to do synchronous rpc calls to service PermissionsService.A stub to allow clients to do ListenableFuture-style rpc calls to service PermissionsService.Base class for the server implementation of the service PermissionsService.A stub to allow clients to do asynchronous rpc calls to service PermissionsService.Precondition specifies how and the existence or absence of certain relationships as expressed through the accompanying filter should affect whether or not the operation proceeds.Precondition specifies how and the existence or absence of certain relationships as expressed through the accompanying filter should affect whether or not the operation proceeds.Protobuf enumauthzed.api.v1.Precondition.OperationProtobuf typeauthzed.api.v1.ReadCounterValueProtobuf typeauthzed.api.v1.ReadCounterValueReadRelationshipsRequest specifies one or more filters used to read matching relationships within the system.ReadRelationshipsRequest specifies one or more filters used to read matching relationships within the system.ReadRelationshipsResponse contains a Relationship found that matches the specified relationship filter(s).ReadRelationshipsResponse contains a Relationship found that matches the specified relationship filter(s).ReadSchemaRequest returns the schema from the database.ReadSchemaRequest returns the schema from the database.ReadSchemaResponse is the resulting data after having read the Object Definitions from a Schema.ReadSchemaResponse is the resulting data after having read the Object Definitions from a Schema.Relationship specifies how a resource relates to a subject.Relationship specifies how a resource relates to a subject.RelationshipFilter is a collection of filters which when applied to a relationship will return relationships that have exactly matching fields.RelationshipFilter is a collection of filters which when applied to a relationship will return relationships that have exactly matching fields.RelationshipUpdate is used for mutating a single relationship within the service.RelationshipUpdate is used for mutating a single relationship within the service.Protobuf enumauthzed.api.v1.RelationshipUpdate.OperationResolvedSubject is a single subject resolved within LookupSubjects.ResolvedSubject is a single subject resolved within LookupSubjects.SchemaService implements operations on a Permissions System's Schema.SchemaService implements operations on a Permissions System's Schema.A stub to allow clients to do synchronous rpc calls to service SchemaService.A stub to allow clients to do ListenableFuture-style rpc calls to service SchemaService.Base class for the server implementation of the service SchemaService.A stub to allow clients to do asynchronous rpc calls to service SchemaService.SubjectFilter specifies a filter on the subject of a relationship.SubjectFilter specifies a filter on the subject of a relationship.Protobuf typeauthzed.api.v1.SubjectFilter.RelationFilterProtobuf typeauthzed.api.v1.SubjectFilter.RelationFilterSubjectReference is used for referring to the subject portion of a Relationship.SubjectReference is used for referring to the subject portion of a Relationship.WatchRequest specifies the object definitions for which we want to start watching mutations, and an optional start snapshot for when to start watching.WatchRequest specifies the object definitions for which we want to start watching mutations, and an optional start snapshot for when to start watching.WatchResponse contains all tuple modification events in ascending timestamp order, from the requested start snapshot to a snapshot encoded in the watch response.WatchResponse contains all tuple modification events in ascending timestamp order, from the requested start snapshot to a snapshot encoded in the watch response.A stub to allow clients to do synchronous rpc calls to service WatchService.A stub to allow clients to do ListenableFuture-style rpc calls to service WatchService.Base class for the server implementation of the service WatchService.A stub to allow clients to do asynchronous rpc calls to service WatchService.WriteRelationshipsRequest contains a list of Relationship mutations that should be applied to the service.WriteRelationshipsRequest contains a list of Relationship mutations that should be applied to the service.Protobuf typeauthzed.api.v1.WriteRelationshipsResponseProtobuf typeauthzed.api.v1.WriteRelationshipsResponseWriteSchemaRequest is the required data used to "upsert" the Schema of a Permissions System.WriteSchemaRequest is the required data used to "upsert" the Schema of a Permissions System.WriteSchemaResponse is the resulting data after having written a Schema to a Permissions System.WriteSchemaResponse is the resulting data after having written a Schema to a Permissions System.ZedToken is used to provide causality metadata between Write and Check requests.ZedToken is used to provide causality metadata between Write and Check requests.