Expand description
Contains clients to connect to OpenFGA:
OpenFgaServiceClientis the generated client that allows full control over all parameters.OpenFgaClientis a wrapper around the generated client, that provides a more convenient interface and addsstore_id,authorization_model_idandconsistencyto all requests.
Modules§
- batch_
check_ single_ result - Nested message and enum types in
BatchCheckSingleResult. - check_
error - Nested message and enum types in
CheckError. - condition_
param_ type_ ref - Nested message and enum types in
ConditionParamTypeRef. - open_
fga_ service_ client - Generated client implementations.
- relation_
reference - Nested message and enum types in
RelationReference. - user
- Nested message and enum types in
User. - userset
- Nested message and enum types in
Userset. - userset_
tree - Nested message and enum types in
UsersetTree.
Structs§
- Aborted
Message Response - Assertion
- Assertion
Tuple Key - Assertions
- Authorization
Model - Batch
Check Item - Batch
Check Request - Batch
Check Response - Batch
Check Single Result - Check
Error - Check
Request - Check
Request Tuple Key - Check
Response - Computed
Userset - Condition
- Condition
Metadata - Condition
Param Type Ref - Contextual
Tuple Keys - Create
Store Request - Create
Store Response - Delete
Store Request - Delete
Store Response - Difference
- Direct
Userset - A DirectUserset is a sentinel message for referencing the direct members specified by an object/relation mapping.
- Error
Message Request - Expand
Request - Expand
Request Tuple Key - Expand
Response - Forbidden
Response - GetStore
Request - GetStore
Response - Internal
Error Message Response - List
Objects Request - List
Objects Response - List
Stores Request - List
Stores Response - List
Users Request - List
Users Response - Metadata
- Object
- Object represents an OpenFGA Object.
- Object
Relation - Open
FgaClient - Wrapper around the generated
OpenFgaServiceClient. - Open
FgaService Client - Path
Unknown Error Message Response - Read
Assertions Request - Read
Assertions Response - Read
Authorization Model Request - Read
Authorization Model Response - Read
Authorization Models Request - Read
Authorization Models Response - Read
Changes Request - Read
Changes Response - Read
Request - Read
Request Tuple Key - Read
Response - Relation
- Relation
Metadata - Relation
Reference - RelationReference represents a relation of a particular object type (e.g. ‘document#viewer’).
- Relation
Type Info - Relationship
Condition - Source
Info - Store
- Streamed
List Objects Request - Streamed
List Objects Response - The response for a StreamedListObjects RPC.
- Tuple
- Tuple
Change - Tuple
Key - Tuple
KeyWithout Condition - Tuple
Keys - Tuple
ToUserset - Type
Definition - Typed
Wildcard - Type bound public access.
- Unauthenticated
Response - Unprocessable
Content Message Response - Update
Store Request - Update
Store Response - User
- User.
- User
Type Filter - Userset
- Userset
Tree - A UsersetTree contains the result of an Expansion.
- Userset
User - Userset.
- Usersets
- Validation
Error Message Response - Wildcard
- Write
Assertions Request - Write
Assertions Response - Write
Authorization Model Request - Write
Authorization Model Response - Write
Options - Options for write operations.
- Write
Request - Write
Request Deletes - Write
Request Writes - Write
Response
Enums§
- Auth
Error Code - Conflict
Behavior - Behavior when encountering conflicts during write operations.
- Consistency
Preference - Controls the consistency preferences when calling the query APIs.
- Error
Code - Internal
Error Code - NotFound
Error Code - Tuple
Operation - buf:lint:ignore ENUM_ZERO_VALUE_SUFFIX
- Unprocessable
Content Error Code
Constants§
- FILE_
DESCRIPTOR_ SET - Encoded file descriptor set for the
openfga.v1package