Package com.authzed.api.v1
See: Description
-
-
Class Summary Class Description Builder
Protobuf typeReadSchemaRequest returns the schema from the database.authzed.api.v1.ReadSchemaRequestReadSchemaRequest
Protobuf typeReadSchemaRequest returns the schema from the database.authzed.api.v1.ReadSchemaRequestBuilder
Protobuf typeReadSchemaResponse is the resulting data after having read the Object Definitions from a Schema.authzed.api.v1.ReadSchemaResponseReadSchemaResponse
Protobuf typeReadSchemaResponse is the resulting data after having read the Object Definitions from a Schema.authzed.api.v1.ReadSchemaResponseBuilder
Protobuf typeWriteSchemaRequest is the required data used to "upsert" the Schema of a Permissions System.authzed.api.v1.WriteSchemaRequestWriteSchemaRequest
Protobuf typeWriteSchemaRequest is the required data used to "upsert" the Schema of a Permissions System.authzed.api.v1.WriteSchemaRequestBuilder
Protobuf typeWriteSchemaResponse is the resulting data after having written a Schema to a Permissions System.authzed.api.v1.WriteSchemaResponseWriteSchemaResponse
Protobuf typeWriteSchemaResponse is the resulting data after having written a Schema to a Permissions System.authzed.api.v1.WriteSchemaResponseSchemaServiceOuterClass SchemaServiceImplBase SchemaService implements operations on a Permissions System's Schema.SchemaServiceStub SchemaService implements operations on a Permissions System's Schema.SchemaServiceBlockingStub SchemaService implements operations on a Permissions System's Schema.SchemaServiceFutureStub SchemaService implements operations on a Permissions System's Schema.SchemaServiceGrpc SchemaService implements operations on a Permissions System's Schema.Builder
Protobuf typeConsistency will define how a request is handled by the backend. By defining a consistency requirement, and a token at which those requirements should be applied, where applicable.authzed.api.v1.ConsistencyConsistency
Protobuf typeConsistency will define how a request is handled by the backend. By defining a consistency requirement, and a token at which those requirements should be applied, where applicable.authzed.api.v1.ConsistencyBuilder
Protobuf typeRelationshipFilter is a collection of filters which when applied to a relationship will return relationships that have exactly matching fields. resource_type is required. All other fields are optional and if left unspecified will not filter relationships.authzed.api.v1.RelationshipFilterRelationshipFilter
Protobuf typeRelationshipFilter is a collection of filters which when applied to a relationship will return relationships that have exactly matching fields. resource_type is required. All other fields are optional and if left unspecified will not filter relationships.authzed.api.v1.RelationshipFilterBuilder Protobuf type authzed.api.v1.SubjectFilter.RelationFilterRelationFilter Protobuf type authzed.api.v1.SubjectFilter.RelationFilterBuilder
Protobuf typeSubjectFilter specifies a filter on the subject of a relationship. subject_type is required and all other fields are optional, and will not impose any additional requirements if left unspecified.authzed.api.v1.SubjectFilterSubjectFilter
Protobuf typeSubjectFilter specifies a filter on the subject of a relationship. subject_type is required and all other fields are optional, and will not impose any additional requirements if left unspecified.authzed.api.v1.SubjectFilterBuilder
Protobuf typeReadRelationshipsRequest specifies one or more filters used to read matching relationships within the system.authzed.api.v1.ReadRelationshipsRequestReadRelationshipsRequest
Protobuf typeReadRelationshipsRequest specifies one or more filters used to read matching relationships within the system.authzed.api.v1.ReadRelationshipsRequestBuilder
Protobuf typeReadRelationshipsResponse contains a Relationship found that matches the specified relationship filter(s). A instance of this response message will be streamed to the client for each relationship found.authzed.api.v1.ReadRelationshipsResponseReadRelationshipsResponse
Protobuf typeReadRelationshipsResponse contains a Relationship found that matches the specified relationship filter(s). A instance of this response message will be streamed to the client for each relationship found.authzed.api.v1.ReadRelationshipsResponseBuilder
Protobuf typePrecondition specifies how and the existence or absence of certain relationships as expressed through the accompanying filter should affect whether or not the operation proceeds. MUST_NOT_MATCH will fail the parent request if any relationships match the relationships filter. MUST_MATCH will fail the parent request if there are no relationships that match the filter.authzed.api.v1.PreconditionPrecondition
Protobuf typePrecondition specifies how and the existence or absence of certain relationships as expressed through the accompanying filter should affect whether or not the operation proceeds. MUST_NOT_MATCH will fail the parent request if any relationships match the relationships filter. MUST_MATCH will fail the parent request if there are no relationships that match the filter.authzed.api.v1.PreconditionBuilder
Protobuf typeWriteRelationshipsRequest contains a list of Relationship mutations that should be applied to the service. If the optional_preconditions parameter is included, all of the specified preconditions must also be satisfied before the write will be committed.authzed.api.v1.WriteRelationshipsRequestWriteRelationshipsRequest
Protobuf typeWriteRelationshipsRequest contains a list of Relationship mutations that should be applied to the service. If the optional_preconditions parameter is included, all of the specified preconditions must also be satisfied before the write will be committed.authzed.api.v1.WriteRelationshipsRequestBuilder Protobuf type authzed.api.v1.WriteRelationshipsResponseWriteRelationshipsResponse Protobuf type authzed.api.v1.WriteRelationshipsResponseBuilder
Protobuf typeDeleteRelationshipsRequest specifies which Relationships should be deleted, requesting the delete of *ALL* relationships that match the specified filters. If the optional_preconditions parameter is included, all of the specified preconditions must also be satisfied before the delete will be executed.authzed.api.v1.DeleteRelationshipsRequestDeleteRelationshipsRequest
Protobuf typeDeleteRelationshipsRequest specifies which Relationships should be deleted, requesting the delete of *ALL* relationships that match the specified filters. If the optional_preconditions parameter is included, all of the specified preconditions must also be satisfied before the delete will be executed.authzed.api.v1.DeleteRelationshipsRequestBuilder Protobuf type authzed.api.v1.DeleteRelationshipsResponseDeleteRelationshipsResponse Protobuf type authzed.api.v1.DeleteRelationshipsResponseBuilder
Protobuf typeCheckPermissionRequest issues a check on whether a subject has a permission or is a member of a relation, on a specific resource.authzed.api.v1.CheckPermissionRequestCheckPermissionRequest
Protobuf typeCheckPermissionRequest issues a check on whether a subject has a permission or is a member of a relation, on a specific resource.authzed.api.v1.CheckPermissionRequestBuilder Protobuf type authzed.api.v1.CheckPermissionResponseCheckPermissionResponse Protobuf type authzed.api.v1.CheckPermissionResponseBuilder
Protobuf typeExpandPermissionTreeRequest returns a tree representing the expansion of all relationships found accessible from a permission or relation on a particular resource. ExpandPermissionTreeRequest is typically used to determine the full set of subjects with a permission, along with the relationships that grant said access.authzed.api.v1.ExpandPermissionTreeRequestExpandPermissionTreeRequest
Protobuf typeExpandPermissionTreeRequest returns a tree representing the expansion of all relationships found accessible from a permission or relation on a particular resource. ExpandPermissionTreeRequest is typically used to determine the full set of subjects with a permission, along with the relationships that grant said access.authzed.api.v1.ExpandPermissionTreeRequestBuilder Protobuf type authzed.api.v1.ExpandPermissionTreeResponseExpandPermissionTreeResponse Protobuf type authzed.api.v1.ExpandPermissionTreeResponseBuilder
Protobuf typeLookupResourcesRequest 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.authzed.api.v1.LookupResourcesRequestLookupResourcesRequest
Protobuf typeLookupResourcesRequest 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.authzed.api.v1.LookupResourcesRequestBuilder
Protobuf typeLookupResourcesResponse contains a single matching resource object ID for the requested object type, permission, and subject.authzed.api.v1.LookupResourcesResponseLookupResourcesResponse
Protobuf typeLookupResourcesResponse contains a single matching resource object ID for the requested object type, permission, and subject.authzed.api.v1.LookupResourcesResponseBuilder
Protobuf typeLookupSubjectsRequest 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.authzed.api.v1.LookupSubjectsRequestLookupSubjectsRequest
Protobuf typeLookupSubjectsRequest 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.authzed.api.v1.LookupSubjectsRequestBuilder
Protobuf typeLookupSubjectsResponse contains a single matching subject object ID for the requested subject object type on the permission or relation.authzed.api.v1.LookupSubjectsResponseLookupSubjectsResponse
Protobuf typeLookupSubjectsResponse contains a single matching subject object ID for the requested subject object type on the permission or relation.authzed.api.v1.LookupSubjectsResponsePermissionService Builder
Protobuf typeWatchRequest specifies the object definitions for which we want to start watching mutations, and an optional start snapshot for when to start watching.authzed.api.v1.WatchRequestWatchRequest
Protobuf typeWatchRequest specifies the object definitions for which we want to start watching mutations, and an optional start snapshot for when to start watching.authzed.api.v1.WatchRequestBuilder
Protobuf typeWatchResponse contains all tuple modification events in ascending timestamp order, from the requested start snapshot to a snapshot encoded in the watch response. The client can use the snapshot to resume watching where the previous watch response left off.authzed.api.v1.WatchResponseWatchResponse
Protobuf typeWatchResponse contains all tuple modification events in ascending timestamp order, from the requested start snapshot to a snapshot encoded in the watch response. The client can use the snapshot to resume watching where the previous watch response left off.authzed.api.v1.WatchResponseWatchServiceOuterClass WatchServiceImplBase WatchServiceStub WatchServiceBlockingStub WatchServiceFutureStub WatchServiceGrpc PermissionsServiceImplBase PermissionsService implements a set of RPCs that perform operations on relationships and permissions.PermissionsServiceStub PermissionsService implements a set of RPCs that perform operations on relationships and permissions.PermissionsServiceBlockingStub PermissionsService implements a set of RPCs that perform operations on relationships and permissions.PermissionsServiceFutureStub PermissionsService implements a set of RPCs that perform operations on relationships and permissions.PermissionsServiceGrpc PermissionsService implements a set of RPCs that perform operations on relationships and permissions.Openapi Builder
Protobuf typeDebugInformation defines debug information returned by an API call in a footer when requested with a specific debugging header. The specific debug information returned will depend on the type of the API call made. See the github.com/authzed/authzed-go project for the specific header and footer names.authzed.api.v1.DebugInformationDebugInformation
Protobuf typeDebugInformation defines debug information returned by an API call in a footer when requested with a specific debugging header. The specific debug information returned will depend on the type of the API call made. See the github.com/authzed/authzed-go project for the specific header and footer names.authzed.api.v1.DebugInformationBuilder Protobuf type authzed.api.v1.CheckDebugTrace.SubProblemsSubProblems Protobuf type authzed.api.v1.CheckDebugTrace.SubProblemsBuilder
Protobuf typeCheckDebugTrace is a recursive trace of the requests made for resolving a CheckPermission API call.authzed.api.v1.CheckDebugTraceCheckDebugTrace
Protobuf typeCheckDebugTrace is a recursive trace of the requests made for resolving a CheckPermission API call.authzed.api.v1.CheckDebugTraceDebug Builder
Protobuf typeRelationship specifies how a resource relates to a subject. Relationships form the data for the graph over which all permissions questions are answered.authzed.api.v1.RelationshipRelationship
Protobuf typeRelationship specifies how a resource relates to a subject. Relationships form the data for the graph over which all permissions questions are answered.authzed.api.v1.RelationshipBuilder
Protobuf typeSubjectReference is used for referring to the subject portion of a Relationship. The relation component is optional and is used for defining a sub-relation on the subject, e.g. group:123#membersauthzed.api.v1.SubjectReferenceSubjectReference
Protobuf typeSubjectReference is used for referring to the subject portion of a Relationship. The relation component is optional and is used for defining a sub-relation on the subject, e.g. group:123#membersauthzed.api.v1.SubjectReferenceBuilder
Protobuf typeObjectReference is used to refer to a specific object in the system.authzed.api.v1.ObjectReferenceObjectReference
Protobuf typeObjectReference is used to refer to a specific object in the system.authzed.api.v1.ObjectReferenceBuilder
Protobuf typeZedToken is used to provide causality metadata between Write and Check requests. See the authzed.api.v1.Consistency message for more information.authzed.api.v1.ZedTokenZedToken
Protobuf typeZedToken is used to provide causality metadata between Write and Check requests. See the authzed.api.v1.Consistency message for more information.authzed.api.v1.ZedTokenBuilder
Protobuf typeRelationshipUpdate is used for mutating a single relationship within the service. CREATE will create the relationship only if it doesn't exist, and error otherwise. TOUCH will upsert the relationship, and will not error if it already exists. DELETE will delete the relationship and error if it doesn't exist.authzed.api.v1.RelationshipUpdateRelationshipUpdate
Protobuf typeRelationshipUpdate is used for mutating a single relationship within the service. CREATE will create the relationship only if it doesn't exist, and error otherwise. TOUCH will upsert the relationship, and will not error if it already exists. DELETE will delete the relationship and error if it doesn't exist.authzed.api.v1.RelationshipUpdateBuilder
Protobuf typePermissionRelationshipTree is used for representing a tree of a resource and its permission relationships with other objects.authzed.api.v1.PermissionRelationshipTreePermissionRelationshipTree
Protobuf typePermissionRelationshipTree is used for representing a tree of a resource and its permission relationships with other objects.authzed.api.v1.PermissionRelationshipTreeBuilder
Protobuf typeAlgebraicSubjectSet is a subject set which is computed based on applying the specified operation to the operands according to the algebra of sets. UNION is a logical set containing the subject members from all operands. INTERSECTION is a logical set containing only the subject members which are present in all operands. EXCLUSION is a logical set containing only the subject members which are present in the first operand, and none of the other operands.authzed.api.v1.AlgebraicSubjectSetAlgebraicSubjectSet
Protobuf typeAlgebraicSubjectSet is a subject set which is computed based on applying the specified operation to the operands according to the algebra of sets. UNION is a logical set containing the subject members from all operands. INTERSECTION is a logical set containing only the subject members which are present in all operands. EXCLUSION is a logical set containing only the subject members which are present in the first operand, and none of the other operands.authzed.api.v1.AlgebraicSubjectSetBuilder
Protobuf typeDirectSubjectSet is a subject set which is simply a collection of subjects.authzed.api.v1.DirectSubjectSetDirectSubjectSet
Protobuf typeDirectSubjectSet is a subject set which is simply a collection of subjects.authzed.api.v1.DirectSubjectSetCore ChildrenProxy An uninstantiable, behaviorless type to represent the field in generics. Dsl Dsl TracesProxy An uninstantiable, behaviorless type to represent the field in generics. Dsl Dsl Dsl Dsl Dsl OptionalPreconditionsProxy An uninstantiable, behaviorless type to represent the field in generics. Dsl Dsl SubjectsProxy An uninstantiable, behaviorless type to represent the field in generics. Dsl Dsl Dsl Dsl Dsl Dsl ExcludedSubjectIdsProxy An uninstantiable, behaviorless type to represent the field in generics. Dsl Dsl Dsl PermissionsServiceCoroutineStub A stub for issuing RPCs to a(n) authzed.api.v1.PermissionsService service as suspending coroutines. PermissionsServiceCoroutineImplBase Skeletal implementation of the authzed.api.v1.PermissionsService service based on Kotlin coroutines. Dsl Dsl Dsl Dsl Dsl Dsl Dsl Dsl SchemaServiceCoroutineStub A stub for issuing RPCs to a(n) authzed.api.v1.SchemaService service as suspending coroutines. SchemaServiceCoroutineImplBase Skeletal implementation of the authzed.api.v1.SchemaService service based on Kotlin coroutines. Dsl Dsl Dsl OptionalObjectTypesProxy An uninstantiable, behaviorless type to represent the field in generics. Dsl UpdatesProxy An uninstantiable, behaviorless type to represent the field in generics. Dsl WatchServiceCoroutineStub A stub for issuing RPCs to a(n) authzed.api.v1.WatchService service as suspending coroutines. WatchServiceCoroutineImplBase Skeletal implementation of the authzed.api.v1.WatchService service based on Kotlin coroutines. UpdatesProxy An uninstantiable, behaviorless type to represent the field in generics. OptionalPreconditionsProxy An uninstantiable, behaviorless type to represent the field in generics. Dsl Dsl Dsl Dsl Dsl CheckDebugTraceKtKt CheckPermissionRequestKtKt ExpandPermissionTreeRequestKtKt LookupSubjectsRequestKtKt RelationshipKtKt LookupResourcesRequestKtKt ReadRelationshipsRequestKtKt CheckPermissionResponseKtKt ConsistencyKtKt DebugInformationKtKt DeleteRelationshipsRequestKtKt DeleteRelationshipsResponseKtKt ExpandPermissionTreeResponseKtKt LookupResourcesResponseKtKt LookupSubjectsResponseKtKt PermissionRelationshipTreeKtKt PreconditionKtKt ReadRelationshipsResponseKtKt RelationshipUpdateKtKt RelationshipFilterKtKt SubjectFilterKtKt SubjectReferenceKtKt WatchRequestKtKt WatchResponseKtKt WriteRelationshipsResponseKtKt AlgebraicSubjectSetKtKt DirectSubjectSetKtKt ObjectReferenceKtKt ReadSchemaRequestKtKt ReadSchemaResponseKtKt WriteRelationshipsRequestKtKt WriteSchemaRequestKtKt WriteSchemaResponseKtKt ZedTokenKtKt -
Enum Summary Enum Description RequirementCase Operation Protobuf enum authzed.api.v1.Precondition.OperationPermissionship Protobuf enum authzed.api.v1.CheckPermissionResponse.PermissionshipPermissionType Protobuf enum authzed.api.v1.CheckDebugTrace.PermissionTypePermissionship Protobuf enum authzed.api.v1.CheckDebugTrace.PermissionshipResolutionCase Operation Protobuf enum authzed.api.v1.RelationshipUpdate.OperationTreeTypeCase Operation Protobuf enum authzed.api.v1.AlgebraicSubjectSet.Operation -