-
Notifications
You must be signed in to change notification settings - Fork 16
/
Copy pathopenfga_service.proto
1566 lines (1425 loc) · 59.9 KB
/
openfga_service.proto
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
syntax = "proto3";
package openfga.v1;
import "google/api/annotations.proto";
import "google/api/field_behavior.proto";
import "google/api/visibility.proto";
import "google/protobuf/struct.proto";
import "google/protobuf/timestamp.proto";
import "google/protobuf/wrappers.proto";
import "openfga/v1/authzmodel.proto";
import "openfga/v1/openfga.proto";
import "protoc-gen-openapiv2/options/annotations.proto";
import "validate/validate.proto";
service OpenFGAService {
rpc Read(ReadRequest) returns (ReadResponse) {
option (google.api.http) = {
post: "/stores/{store_id}/read"
body: "*"
};
option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_operation) = {
summary: "Get tuples from the store that matches a query, without following userset rewrite rules"
tags: ["Relationship Tuples"]
operation_id: "Read"
description:
"The Read API will return the tuples for a certain store that match a "
"query filter specified in the body of the request. \n"
"The API doesn't guarantee order by any field. \n"
"It is different from the `/stores/{store_id}/expand` API in that it only "
"returns relationship tuples that are stored in the system and satisfy the query. \n"
"In the body:\n"
"1. `tuple_key` is optional. If not specified, it will return all tuples in the store.\n"
"2. `tuple_key.object` is mandatory if `tuple_key` is specified. It can be a full object (e.g., "
"`type:object_id`) or type only (e.g., `type:`).\n"
"3. `tuple_key.user` is mandatory if tuple_key is specified in the case the `tuple_key.object` is a type only.\n"
"## Examples\n"
"### Query for all objects in a type definition\n"
"To query for all objects that `user:bob` has `reader` relationship in "
"the `document` type definition, call read API with body of\n"
"```json\n"
"{\n"
" \"tuple_key\": {\n"
" \"user\": \"user:bob\",\n"
" \"relation\": \"reader\",\n"
" \"object\": \"document:\"\n"
" }\n"
"}\n"
"```\n"
"The API will return tuples and a continuation token, something like\n"
"```json\n"
"{\n"
" \"tuples\": [\n"
" {\n"
" \"key\": {\n"
" \"user\": \"user:bob\",\n"
" \"relation\": \"reader\",\n"
" \"object\": \"document:2021-budget\"\n"
" },\n"
" \"timestamp\": \"2021-10-06T15:32:11.128Z\"\n"
" }\n"
" ],\n"
" \"continuation_token\": \"eyJwayI6IkxBVEVTVF9OU0NPTkZJR19hdXRoMHN0b3JlIiwic2siOiIxem1qbXF3MWZLZExTcUoyN01MdTdqTjh0cWgifQ==\"\n"
"}\n"
"```\n"
"This means that `user:bob` has a `reader` relationship with 1 document "
"`document:2021-budget`. Note that this API, unlike the List Objects API, does not evaluate the tuples in the store.\n"
"The continuation token will be empty if there are no more tuples to query.\n"
"### Query for all stored relationship tuples that have a particular relation and object\n"
"To query for all users that have `reader` relationship with "
"`document:2021-budget`, call read API with body of \n"
"```json\n"
"{\n"
" \"tuple_key\": {\n"
" \"object\": \"document:2021-budget\",\n"
" \"relation\": \"reader\"\n"
" }\n"
"}\n"
"```\n"
"The API will return something like \n"
"```json\n"
"{\n"
" \"tuples\": [\n"
" {\n"
" \"key\": {\n"
" \"user\": \"user:bob\",\n"
" \"relation\": \"reader\",\n"
" \"object\": \"document:2021-budget\"\n"
" },\n"
" \"timestamp\": \"2021-10-06T15:32:11.128Z\"\n"
" }\n"
" ],\n"
" \"continuation_token\": \"eyJwayI6IkxBVEVTVF9OU0NPTkZJR19hdXRoMHN0b3JlIiwic2siOiIxem1qbXF3MWZLZExTcUoyN01MdTdqTjh0cWgifQ==\"\n"
"}\n"
"```\n"
"This means that `document:2021-budget` has 1 `reader` (`user:bob`). "
"Note that, even if the model said that all `writers` are also `readers`, the API will not return writers such as "
"`user:anne` because it only returns tuples and does not evaluate them.\n"
"### Query for all users with all relationships for a particular document\n"
"To query for all users that have any relationship with "
"`document:2021-budget`, call read API with body of \n"
"```json\n"
"{\n"
" \"tuple_key\": {\n"
" \"object\": \"document:2021-budget\"\n"
" }\n"
"}\n"
"```\n"
"The API will return something like \n"
"```json\n"
"{\n"
" \"tuples\": [\n"
" {\n"
" \"key\": {\n"
" \"user\": \"user:anne\",\n"
" \"relation\": \"writer\",\n"
" \"object\": \"document:2021-budget\"\n"
" },\n"
" \"timestamp\": \"2021-10-05T13:42:12.356Z\"\n"
" },\n"
" {\n"
" \"key\": {\n"
" \"user\": \"user:bob\",\n"
" \"relation\": \"reader\",\n"
" \"object\": \"document:2021-budget\"\n"
" },\n"
" \"timestamp\": \"2021-10-06T15:32:11.128Z\"\n"
" }\n"
" ],\n"
" \"continuation_token\": \"eyJwayI6IkxBVEVTVF9OU0NPTkZJR19hdXRoMHN0b3JlIiwic2siOiIxem1qbXF3MWZLZExTcUoyN01MdTdqTjh0cWgifQ==\"\n"
"}\n"
"```\n"
"This means that `document:2021-budget` has 1 `reader` (`user:bob`) "
"and 1 `writer` (`user:anne`).\n"
};
}
rpc Write(WriteRequest) returns (WriteResponse) {
option (google.api.http) = {
post: "/stores/{store_id}/write"
body: "*"
};
option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_operation) = {
summary: "Add or delete tuples from the store"
tags: ["Relationship Tuples"]
operation_id: "Write"
description:
"The Write API will transactionally update the tuples for a certain store. Tuples and "
"type definitions allow OpenFGA to determine whether a "
"relationship exists between an object and an user.\n"
"In the body, `writes` adds new tuples and `deletes` removes existing tuples. When deleting a tuple, any `condition` specified with it is ignored.\n"
"The API is not idempotent: if, later on, you try to add the same tuple key (even if the `condition` is different), or if you try to delete a non-existing tuple, it will throw an error.\n"
"The API will not allow you to write tuples such as `document:2021-budget#viewer@document:2021-budget#viewer`, because they are implicit.\n"
"An `authorization_model_id` may be specified in the body. If it is, it will be used to assert that each written tuple (not deleted) "
"is valid for the model specified. If it is not specified, the latest authorization model ID will be used.\n"
"## Example\n"
"### Adding relationships\n"
"To add `user:anne` as a `writer` for `document:2021-budget`, call "
"write API with the following \n"
"```json\n"
"{\n"
" \"writes\": {\n"
" \"tuple_keys\": [\n"
" {\n"
" \"user\": \"user:anne\",\n"
" \"relation\": \"writer\",\n"
" \"object\": \"document:2021-budget\"\n"
" }\n"
" ]\n"
" },\n"
" \"authorization_model_id\": \"01G50QVV17PECNVAHX1GG4Y5NC\"\n"
"}\n"
"```\n"
"### Removing relationships\n"
"To remove `user:bob` as a `reader` for `document:2021-budget`, call "
"write API with the following \n"
"```json\n"
"{\n"
" \"deletes\": {\n"
" \"tuple_keys\": [\n"
" {\n"
" \"user\": \"user:bob\",\n"
" \"relation\": \"reader\",\n"
" \"object\": \"document:2021-budget\"\n"
" }\n"
" ]\n"
" }\n"
"}\n"
"```\n"
};
}
rpc Check(CheckRequest) returns (CheckResponse) {
option (google.api.http) = {
post: "/stores/{store_id}/check"
body: "*"
};
option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_operation) = {
summary: "Check whether a user is authorized to access an object"
tags: ["Relationship Queries"]
operation_id: "Check"
description:
"The Check API returns whether a given user has a relationship with a given object in a given store.\n"
"The `user` field of the request can be a specific target, such as `user:anne`, or a userset (set of users) such as `group:marketing#member` or a type-bound public access `user:*`.\n"
"To arrive at a result, the API uses: an authorization model, explicit tuples written through the Write API, contextual tuples present in the request, and implicit tuples that exist by virtue of applying set theory "
"(such as `document:2021-budget#viewer@document:2021-budget#viewer`; the set of users who are viewers of `document:2021-budget` are the set of users who are the viewers of `document:2021-budget`).\n"
"A `contextual_tuples` object may also be included in the body of the request. This object contains one field `tuple_keys`, which is an array of tuple keys. Each of these tuples may have an associated `condition`.\n"
"You may also provide an `authorization_model_id` in the body. This will be used to assert that the input `tuple_key` is valid for the model specified. "
"If not specified, the assertion will be made against the latest authorization model ID. It is strongly recommended to specify authorization model id for better performance.\n"
"You may also provide a `context` object that will be used to evaluate the conditioned tuples in the system. It is strongly recommended to provide a value for all the input parameters of all the conditions, to ensure that all tuples be evaluated correctly.\n"
"The response will return whether the relationship exists in the field `allowed`.\n\n"
"Some exceptions apply, but in general, if a Check API responds with `{allowed: true}`, then you can expect the equivalent ListObjects query to return the object, and viceversa. \n"
"For example, if `Check(user:anne, reader, document:2021-budget)` responds with `{allowed: true}`, then `ListObjects(user:anne, reader, document)` may include `document:2021-budget` in the response.\n"
"## Examples\n"
"### Querying with contextual tuples\n"
"In order to check if user `user:anne` of type `user` has a `reader` relationship with object `document:2021-budget` given the following contextual tuple\n"
"```json\n"
"{\n"
" \"user\": \"user:anne\",\n"
" \"relation\": \"member\",\n"
" \"object\": \"time_slot:office_hours\"\n"
"}\n"
"```\n"
"the Check API can be used with the following request body:\n"
"```json\n"
"{\n"
" \"tuple_key\": {\n"
" \"user\": \"user:anne\",\n"
" \"relation\": \"reader\",\n"
" \"object\": \"document:2021-budget\"\n"
" },\n"
" \"contextual_tuples\": {\n"
" \"tuple_keys\": [\n"
" {\n"
" \"user\": \"user:anne\",\n"
" \"relation\": \"member\",\n"
" \"object\": \"time_slot:office_hours\"\n"
" }\n"
" ]\n"
" },\n"
" \"authorization_model_id\": \"01G50QVV17PECNVAHX1GG4Y5NC\"\n"
"}\n"
"```\n"
"### Querying usersets\n"
"Some Checks will always return `true`, even without any tuples. For example, for the following authorization model\n"
"```python\n"
"model\n"
" schema 1.1\n"
"type user\n"
"type document\n"
" relations\n"
" define reader: [user]\n"
"```\n"
"the following query\n"
"```json\n"
"{\n"
" \"tuple_key\": {\n"
" \"user\": \"document:2021-budget#reader\",\n"
" \"relation\": \"reader\",\n"
" \"object\": \"document:2021-budget\"\n"
" }\n"
"}\n"
"```\n"
"will always return `{ \"allowed\": true }`. This is because usersets are self-defining: the userset `document:2021-budget#reader` will always have the `reader` relation with `document:2021-budget`.\n"
"### Querying usersets with difference in the model\n"
"A Check for a userset can yield results that must be treated carefully if the model involves difference. For example, for the following authorization model\n"
"```python\n"
"model\n"
" schema 1.1\n"
"type user\n"
"type group\n"
" relations\n"
" define member: [user]\n"
"type document\n"
" relations\n"
" define blocked: [user]\n"
" define reader: [group#member] but not blocked\n"
"```\n"
"the following query\n"
"```json\n"
"{\n"
" \"tuple_key\": {\n"
" \"user\": \"group:finance#member\",\n"
" \"relation\": \"reader\",\n"
" \"object\": \"document:2021-budget\"\n"
" },\n"
" \"contextual_tuples\": {\n"
" \"tuple_keys\": [\n"
" {\n"
" \"user\": \"user:anne\",\n"
" \"relation\": \"member\",\n"
" \"object\": \"group:finance\"\n"
" },\n"
" {\n"
" \"user\": \"group:finance#member\",\n"
" \"relation\": \"reader\",\n"
" \"object\": \"document:2021-budget\"\n"
" },\n"
" {\n"
" \"user\": \"user:anne\",\n"
" \"relation\": \"blocked\",\n"
" \"object\": \"document:2021-budget\"\n"
" }\n"
" ]\n"
" },\n"
"}\n"
"```\n"
"will return `{ \"allowed\": true }`, even though a specific user of the userset `group:finance#member` does not have the `reader` relationship with the given object.\n"
};
}
rpc Expand(ExpandRequest) returns (ExpandResponse) {
option (google.api.http) = {
post: "/stores/{store_id}/expand"
body: "*"
};
option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_operation) = {
summary: "Expand all relationships in userset tree format, and following userset rewrite rules. Useful to reason about and debug a certain relationship"
tags: ["Relationship Queries"]
operation_id: "Expand"
description:
"The Expand API will return all users and usersets "
"that have certain relationship with an object in a certain store.\n"
"This is different from the `/stores/{store_id}/read` API in that both users and "
"computed usersets are returned.\n"
"Body parameters `tuple_key.object` and `tuple_key.relation` are all required.\n"
"The response will return a tree whose leaves are the specific users and usersets. "
"Union, intersection and difference operator are located in the intermediate nodes.\n\n"
"## Example\n"
"To expand all users that have the `reader` relationship with object `document:2021-budget`, "
"use the Expand API with the following request body\n"
"```json\n"
"{\n"
" \"tuple_key\": {\n"
" \"object\": \"document:2021-budget\",\n"
" \"relation\": \"reader\"\n"
" },\n"
" \"authorization_model_id\": \"01G50QVV17PECNVAHX1GG4Y5NC\"\n"
"}\n"
"```\n"
"OpenFGA's response will be a userset tree of the users and usersets that have "
"read access to the document.\n"
"```json\n"
"{\n"
" \"tree\":{\n"
" \"root\":{\n"
" \"type\":\"document:2021-budget#reader\",\n"
" \"union\":{\n"
" \"nodes\":[\n"
" {\n"
" \"type\":\"document:2021-budget#reader\",\n"
" \"leaf\":{\n"
" \"users\":{\n"
" \"users\":[\n"
" \"user:bob\"\n"
" ]\n"
" }\n"
" }\n"
" },\n"
" {\n"
" \"type\":\"document:2021-budget#reader\",\n"
" \"leaf\":{\n"
" \"computed\":{\n"
" \"userset\":\"document:2021-budget#writer\"\n"
" }\n"
" }\n"
" }\n"
" ]\n"
" }\n"
" }\n"
" }\n"
"}\n"
"```\n"
"The caller can then call expand API for the `writer` relationship for the `document:2021-budget`."
};
}
rpc ReadAuthorizationModels(ReadAuthorizationModelsRequest) returns (ReadAuthorizationModelsResponse) {
option (google.api.http) = {get: "/stores/{store_id}/authorization-models"};
option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_operation) = {
summary: "Return all the authorization models for a particular store"
tags: ["Authorization Models"]
operation_id: "ReadAuthorizationModels"
description:
"The ReadAuthorizationModels API will return all the authorization models for a certain store.\n"
"OpenFGA's response will contain an array of all authorization models, sorted in descending order of creation.\n\n"
"## Example\n"
"Assume that a store's authorization model has been configured twice. To get all the authorization models that have been created in this store, call GET authorization-models. The API will return a response that looks like:\n"
"```json\n"
"{\n"
" \"authorization_models\": [\n"
" {\n"
" \"id\": \"01G50QVV17PECNVAHX1GG4Y5NC\",\n"
" \"type_definitions\": [...]\n"
" },\n"
" {\n"
" \"id\": \"01G4ZW8F4A07AKQ8RHSVG9RW04\",\n"
" \"type_definitions\": [...]\n"
" },\n"
" ],\n"
" \"continuation_token\": \"eyJwayI6IkxBVEVTVF9OU0NPTkZJR19hdXRoMHN0b3JlIiwic2siOiIxem1qbXF3MWZLZExTcUoyN01MdTdqTjh0cWgifQ==\"\n"
"}\n"
"```\n"
"If there are no more authorization models available, the `continuation_token` field will be empty\n"
"```json\n"
"{\n"
" \"authorization_models\": [\n"
" {\n"
" \"id\": \"01G50QVV17PECNVAHX1GG4Y5NC\",\n"
" \"type_definitions\": [...]\n"
" },\n"
" {\n"
" \"id\": \"01G4ZW8F4A07AKQ8RHSVG9RW04\",\n"
" \"type_definitions\": [...]\n"
" },\n"
" ],\n"
" \"continuation_token\": \"\"\n"
"}\n"
"```\n"
""
};
}
rpc ReadAuthorizationModel(ReadAuthorizationModelRequest) returns (ReadAuthorizationModelResponse) {
option (google.api.http) = {get: "/stores/{store_id}/authorization-models/{id}"};
option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_operation) = {
summary: "Return a particular version of an authorization model"
tags: ["Authorization Models"]
operation_id: "ReadAuthorizationModel"
description:
"The ReadAuthorizationModel API returns an authorization model by its identifier.\n"
"The response will return the authorization model for the particular version.\n\n"
"## Example\n"
"To retrieve the authorization model with ID `01G5JAVJ41T49E9TT3SKVS7X1J` for the store, "
"call the GET authorization-models by ID API with `01G5JAVJ41T49E9TT3SKVS7X1J` as the "
"`id` path parameter. The API will return:\n"
"```json\n"
"{\n"
" \"authorization_model\":{\n"
" \"id\":\"01G5JAVJ41T49E9TT3SKVS7X1J\",\n"
" \"type_definitions\":[\n"
" {\n"
" \"type\":\"user\"\n"
" },\n"
" {\n"
" \"type\":\"document\",\n"
" \"relations\":{\n"
" \"reader\":{\n"
" \"union\":{\n"
" \"child\":[\n"
" {\n"
" \"this\":{}\n"
" },\n"
" {\n"
" \"computedUserset\":{\n"
" \"object\":\"\",\n"
" \"relation\":\"writer\"\n"
" }\n"
" }\n"
" ]\n"
" }\n"
" },\n"
" \"writer\":{\n"
" \"this\":{}\n"
" }\n"
" }\n"
" }\n"
" ]\n"
" }\n"
"}\n"
"```\n"
"In the above example, there are 2 types (`user` and `document`). The `document` type "
"has 2 relations (`writer` and `reader`)."
};
}
rpc WriteAuthorizationModel(WriteAuthorizationModelRequest) returns (WriteAuthorizationModelResponse) {
option (google.api.http) = {
post: "/stores/{store_id}/authorization-models"
body: "*"
};
option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_operation) = {
summary: "Create a new authorization model"
tags: ["Authorization Models"]
operation_id: "WriteAuthorizationModel"
description:
"The WriteAuthorizationModel API will add a new authorization model "
"to a store.\n"
"Each item in the `type_definitions` array is a type "
"definition as specified in the field `type_definition`.\n"
"The response will return the authorization model's ID in the `id` field.\n\n"
"## Example\n"
"To add an authorization model with `user` and `document` type definitions, call POST "
"authorization-models API with the body: \n"
"```json\n"
"{\n"
" \"type_definitions\":[\n"
" {\n"
" \"type\":\"user\"\n"
" },\n"
" {\n"
" \"type\":\"document\",\n"
" \"relations\":{\n"
" \"reader\":{\n"
" \"union\":{\n"
" \"child\":[\n"
" {\n"
" \"this\":{}\n"
" },\n"
" {\n"
" \"computedUserset\":{\n"
" \"object\":\"\",\n"
" \"relation\":\"writer\"\n"
" }\n"
" }\n"
" ]\n"
" }\n"
" },\n"
" \"writer\":{\n"
" \"this\":{}\n"
" }\n"
" }\n"
" }\n"
" ]\n"
"}\n"
"```\n"
"OpenFGA's response will include the version id for this authorization model, "
"which will look like \n"
"```\n"
"{\"authorization_model_id\": \"01G50QVV17PECNVAHX1GG4Y5NC\"}\n"
"```\n"
responses: {
key: "201"
value: {
description: "A successful response."
schema: {
json_schema: {ref: ".openfga.v1.WriteAuthorizationModelResponse"}
}
}
}
};
}
rpc WriteAssertions(WriteAssertionsRequest) returns (WriteAssertionsResponse) {
option (google.api.http) = {
put: "/stores/{store_id}/assertions/{authorization_model_id}"
body: "*"
};
option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_operation) = {
summary: "Upsert assertions for an authorization model ID"
tags: ["Assertions"]
operation_id: "WriteAssertions"
description:
"The WriteAssertions API will upsert new assertions for an authorization model id, "
"or overwrite the existing ones. An assertion is an object that contains a "
"tuple key, and the expectation of whether a call to the Check API of that tuple key "
"will return true or false. "
responses: {
key: "204"
value: {
description: "A successful response."
schema: {
json_schema: {ref: ".openfga.v1.WriteAssertionsResponse"}
}
}
}
};
}
rpc ReadAssertions(ReadAssertionsRequest) returns (ReadAssertionsResponse) {
option (google.api.http) = {get: "/stores/{store_id}/assertions/{authorization_model_id}"};
option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_operation) = {
summary: "Read assertions for an authorization model ID"
tags: ["Assertions"]
operation_id: "ReadAssertions"
description:
"The ReadAssertions API will return, for a given authorization model id, "
"all the assertions stored for it. An assertion is an object that contains a "
"tuple key, and the expectation of whether a call to the Check API of that tuple key "
"will return true or false. "
};
}
rpc ReadChanges(ReadChangesRequest) returns (ReadChangesResponse) {
option (google.api.http) = {get: "/stores/{store_id}/changes"};
option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_operation) = {
summary: "Return a list of all the tuple changes"
tags: ["Relationship Tuples"]
operation_id: "ReadChanges"
description:
"The ReadChanges API will return a paginated list of tuple changes (additions and deletions) that occurred "
"in a given store, sorted by ascending time. The response will include a continuation token "
"that is used to get the next set of changes. If there are no changes after the provided continuation token, "
"the same token will be returned in order for it to be used when new changes are recorded. "
"If the store never had any tuples added or removed, this token will be empty.\n"
"You can use the `type` parameter to only get the list of tuple changes that affect objects of that type.\n"
"When reading a write tuple change, if it was conditioned, the condition will be returned.\n"
"When reading a delete tuple change, the condition will NOT be returned regardless of whether it was originally conditioned or not.\n"
};
}
rpc CreateStore(CreateStoreRequest) returns (CreateStoreResponse) {
option (google.api.http) = {
post: "/stores",
body: "*"
};
option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_operation) = {
summary: "Create a store"
tags: ["Stores"]
operation_id: "CreateStore"
description: "Create a unique OpenFGA store which will be used to store authorization models and relationship tuples."
responses: {
key: "201"
value: {
description: "A successful response."
schema: {
json_schema: {ref: ".openfga.v1.CreateStoreResponse"}
}
}
}
};
}
rpc UpdateStore(UpdateStoreRequest) returns (UpdateStoreResponse) {
option (google.api.method_visibility).restriction = "UNIMPLEMENTED";
option (google.api.http) = {
patch: "/stores/{store_id}",
body: "*"
};
option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_operation) = {
summary: "Update a store"
tags: ["Stores"]
operation_id: "UpdateStore"
description: "Updates an existing store."
responses: {
key: "200"
value: {
description: "A successful response."
schema: {
json_schema: {ref: ".openfga.v1.UpdateStoreResponse"}
}
}
}
};
}
rpc DeleteStore(DeleteStoreRequest) returns (DeleteStoreResponse) {
option (google.api.http) = {delete: "/stores/{store_id}"};
option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_operation) = {
summary: "Delete a store"
tags: ["Stores"]
operation_id: "DeleteStore"
description: "Delete an OpenFGA store. This does not delete the data associated with the store, like tuples or authorization models."
responses: {
key: "204"
value: {
description: "A successful response."
schema: {
json_schema: {ref: ".openfga.v1.DeleteStoreResponse"}
}
}
}
};
}
rpc GetStore(GetStoreRequest) returns (GetStoreResponse) {
option (google.api.http) = {get: "/stores/{store_id}"};
option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_operation) = {
summary: "Get a store"
tags: ["Stores"]
operation_id: "GetStore"
description: "Returns an OpenFGA store by its identifier"
};
}
rpc ListStores(ListStoresRequest) returns (ListStoresResponse) {
option (google.api.http) = {get: "/stores"};
option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_operation) = {
summary: "List all stores"
tags: ["Stores"]
operation_id: "ListStores"
description:
"Returns a paginated list of OpenFGA stores and a continuation token to get additional stores.\n"
"The continuation token will be empty if there are no more stores.\n"
};
}
rpc StreamedListObjects(StreamedListObjectsRequest) returns (stream StreamedListObjectsResponse) {
option (google.api.http) = {
post: "/stores/{store_id}/streamed-list-objects",
body: "*"
};
option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_operation) = {
summary: "Stream all objects of the given type that the user has a relation with"
tags: ["Relationship Queries"]
operation_id: "StreamedListObjects"
description:
"The Streamed ListObjects API is very similar to the the ListObjects API, with two differences: \n"
"1. Instead of collecting all objects before returning a response, it streams them to the client as they are collected. \n"
"2. The number of results returned is only limited by the execution timeout specified in the flag OPENFGA_LIST_OBJECTS_DEADLINE. \n"
};
}
rpc ListObjects(ListObjectsRequest) returns (ListObjectsResponse) {
option (google.api.http) = {
post: "/stores/{store_id}/list-objects",
body: "*"
};
option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_operation) = {
summary: "List all objects of the given type that the user has a relation with"
tags: ["Relationship Queries"]
operation_id: "ListObjects"
description:
"The ListObjects API returns a list of all the objects of the given type that the user has a relation with.\n "
"To arrive at a result, the API uses: an authorization model, explicit tuples written through the Write API, contextual tuples present in the request, and implicit tuples that exist by virtue of applying set theory "
"(such as `document:2021-budget#viewer@document:2021-budget#viewer`; the set of users who are viewers of `document:2021-budget` are the set of users who are the viewers of `document:2021-budget`).\n"
"An `authorization_model_id` may be specified in the body. If it is not specified, the latest authorization "
"model ID will be used. It is strongly recommended to specify authorization model id for better performance.\n"
"You may also specify `contextual_tuples` that will be treated as regular tuples. Each of these tuples may have an associated `condition`.\n"
"You may also provide a `context` object that will be used to evaluate the conditioned tuples in the system. It is strongly recommended to provide a value for all the input parameters of all the conditions, to ensure that all tuples be evaluated correctly.\n"
"The response will contain the related objects in an array in the \"objects\" field of the response and they will "
"be strings in the object format `<type>:<id>` (e.g. \"document:roadmap\").\n"
"The number of objects in the response array will be limited by the execution timeout specified in the flag OPENFGA_LIST_OBJECTS_DEADLINE "
"and by the upper bound specified in the flag OPENFGA_LIST_OBJECTS_MAX_RESULTS, whichever is hit first.\n"
"The objects given will not be sorted, and therefore two identical calls can give a given different set of objects."
};
}
rpc ListUsers(ListUsersRequest) returns (ListUsersResponse) {
option (google.api.http) = {
post: "/stores/{store_id}/list-users",
body: "*"
};
option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_operation) = {
summary: "[EXPERIMENTAL] List the users matching the provided filter who have a certain relation to a particular type."
tags: ["Relationship Queries"]
operation_id: "ListUsers"
description:
"The ListUsers API returns a list of all the users of a specific type that have a relation to a given object.\n "
"This API is available in an experimental capacity and can be enabled with the `--experimentals enable-list-users` flag. \n"
"To arrive at a result, the API uses: an authorization model, explicit tuples written through the Write API, contextual tuples present in the request, and implicit tuples that exist by virtue of applying set theory "
"(such as `document:2021-budget#viewer@document:2021-budget#viewer`; the set of users who are viewers of `document:2021-budget` are the set of users who are the viewers of `document:2021-budget`).\n"
"An `authorization_model_id` may be specified in the body. If it is not specified, the latest authorization "
"model ID will be used. It is strongly recommended to specify authorization model id for better performance.\n"
"You may also specify `contextual_tuples` that will be treated as regular tuples. Each of these tuples may have an associated `condition`.\n"
"You may also provide a `context` object that will be used to evaluate the conditioned tuples in the system. It is strongly recommended to provide a value for all the input parameters of all the conditions, to ensure that all tuples be evaluated correctly.\n"
"The response will contain the related users in an array in the \"users\" field of the response. These results may include specific objects, usersets \n"
"or type-bound public access. Each of these types of results is encoded in its own type and not represented as a string."
"In cases where a type-bound public acces result is returned (e.g. `user:*`), it cannot be inferred that all subjects\n"
"of that type have a relation to the object; it is possible that negations exist and checks should still be queried\n"
"on individual subjects to ensure access to that document."
"The number of users in the response array will be limited by the execution timeout specified in the flag OPENFGA_LIST_USERS_DEADLINE "
"and by the upper bound specified in the flag OPENFGA_LIST_USERS_MAX_RESULTS, whichever is hit first.\n"
"The returned users will not be sorted, and therefore two identical calls may yield different sets of users."
};
}
}
message ListObjectsRequest {
string store_id = 1 [
json_name = "store_id",
(validate.rules).string = {pattern: "^[ABCDEFGHJKMNPQRSTVWXYZ0-9]{26}$"},
(grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = {example: "\"01YCP46JKYM8FJCQ37NMBYHE5X\""}
];
string authorization_model_id = 2 [
json_name = "authorization_model_id",
(validate.rules).string = {
pattern: "^[ABCDEFGHJKMNPQRSTVWXYZ0-9]{26}$",
ignore_empty: true
},
(grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = {example: "\"01G5JAVJ41T49E9TT3SKVS7X1J\""}
];
string type = 3 [
json_name = "type",
(validate.rules).string = {pattern: "^[^:#@\\s]{1,254}$"},
(grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = {example: "\"document\""},
(google.api.field_behavior) = REQUIRED
];
string relation = 4 [
(validate.rules).string = {pattern: "^[^:#@\\s]{1,50}$"},
(google.api.field_behavior) = REQUIRED,
(grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = {example: "\"reader\""}
];
string user = 5 [
(validate.rules).string = {
min_bytes: 1,
max_bytes: 512
},
(grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = {
min_length: 1,
max_length: 512,
example: "\"user:anne\""
},
(google.api.field_behavior) = REQUIRED
];
openfga.v1.ContextualTupleKeys contextual_tuples = 6 [json_name = "contextual_tuples"];
// Additional request context that will be used to evaluate any ABAC conditions encountered
// in the query evaluation.
google.protobuf.Struct context = 7;
}
message ListObjectsResponse {
repeated string objects = 1 [
json_name = "objects",
(google.api.field_behavior) = REQUIRED,
(grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = {example: "[\"document:roadmap\",\"document:planning\"]"}
];
}
message ListUsersRequest {
string store_id = 1 [
json_name = "store_id",
(validate.rules).string = {pattern: "^[ABCDEFGHJKMNPQRSTVWXYZ0-9]{26}$"},
(grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = {example: "\"01YCP46JKYM8FJCQ37NMBYHE5X\""}
];
string authorization_model_id = 2 [
json_name = "authorization_model_id",
(validate.rules).string = {
pattern: "^[ABCDEFGHJKMNPQRSTVWXYZ0-9]{26}$",
ignore_empty: true
},
(grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = {example: "\"01G5JAVJ41T49E9TT3SKVS7X1J\""}
];
Object object = 3 [
json_name = "object",
(grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = {example: "\"document:example\""},
(validate.rules).message.required = true,
(google.api.field_behavior) = REQUIRED
];
string relation = 4 [
(validate.rules).string = {pattern: "^[^:#@\\s]{1,50}$"},
(google.api.field_behavior) = REQUIRED,
(grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = {example: "\"reader\""}
];
repeated UserTypeFilter user_filters = 5 [
json_name = "user_filters",
(google.api.field_behavior) = REQUIRED,
(validate.rules).repeated = {
min_items: 1,
max_items: 1
},
(grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = {
description: "The type of results returned. Only accepts exactly one value.",
example: "[{\"type\": \"user\"}, {\"type\": \"group\", \"relation\": \"member\"}]"
}
];
repeated TupleKey contextual_tuples = 6 [
json_name = "contextual_tuples",
(validate.rules).repeated.max_items = 20,
(grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = {maximum: 20}
];
// Additional request context that will be used to evaluate any ABAC conditions encountered
// in the query evaluation.
google.protobuf.Struct context = 7;
}
message ListUsersResponse {
repeated User users = 1 [
json_name = "users",
(google.api.field_behavior) = REQUIRED,
(grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = {example: ""}
];
}
message StreamedListObjectsRequest {
string store_id = 1 [
json_name = "store_id",
(validate.rules).string = {pattern: "^[ABCDEFGHJKMNPQRSTVWXYZ0-9]{26}$"},
(grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = {example: "\"01YCP46JKYM8FJCQ37NMBYHE5X\""}
];
string authorization_model_id = 2 [
json_name = "authorization_model_id",
(validate.rules).string = {
pattern: "^[ABCDEFGHJKMNPQRSTVWXYZ0-9]{26}$",
ignore_empty: true
},
(grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = {example: "\"01G5JAVJ41T49E9TT3SKVS7X1J\""}
];
string type = 3 [
json_name = "type",
(validate.rules).string = {pattern: "^[^:#@\\s]{1,254}$"},
(grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = {example: "\"document\""},
(google.api.field_behavior) = REQUIRED
];
string relation = 4 [
(validate.rules).string = {pattern: "^[^:#@\\s]{1,50}$"},
(google.api.field_behavior) = REQUIRED,
(grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = {example: "\"reader\""}
];
string user = 5 [
(validate.rules).string = {
min_bytes: 1,
max_bytes: 512
},
(grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = {
min_length: 1,
max_length: 512,
example: "\"user:anne\""
},
(google.api.field_behavior) = REQUIRED
];
openfga.v1.ContextualTupleKeys contextual_tuples = 6 [json_name = "contextual_tuples"];
// Additional request context that will be used to evaluate any ABAC conditions encountered
// in the query evaluation.
google.protobuf.Struct context = 7;
}
// The response for a StreamedListObjects RPC.
message StreamedListObjectsResponse {
string object = 1 [
json_name = "object",
(google.api.field_behavior) = REQUIRED,
(grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = {example: "\"document:roadmap\""}
];
}
// Note: store_id is a ULID using pattern ^[ABCDEFGHJKMNPQRSTVWXYZ0-9]{26}$
// which excludes I, L, O, and U
// because of https://github.com/ulid/spec#encoding
message ReadRequest {
string store_id = 1 [
json_name = "store_id",
(google.api.field_behavior) = REQUIRED,
(validate.rules).string = {pattern: "^[ABCDEFGHJKMNPQRSTVWXYZ0-9]{26}$"},
(grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = {example: "\"01YCP46JKYM8FJCQ37NMBYHE5X\""}
];
ReadRequestTupleKey tuple_key = 2 [json_name = "tuple_key"];
google.protobuf.Int32Value page_size = 3 [
json_name = "page_size",
(validate.rules).int32 = {
gte: 1,
lte: 100
},
(grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = {example: "50"}
];
string continuation_token = 4 [
json_name = "continuation_token",
(validate.rules).string.max_bytes = 5120,
(grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = {example: "\"eyJwayI6IkxBVEVTVF9OU0NPTkZJR19hdXRoMHN0b3JlIiwic2siOiIxem1qbXF3MWZLZExTcUoyN01MdTdqTjh0cWgifQ==\""}
];
}
message ReadRequestTupleKey {
string user = 1 [
(validate.rules).string = {max_bytes: 512},
(grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = {
max_length: 512,
example: "\"user:anne\""
}
];
string relation = 2 [
(validate.rules).string = {
pattern: "^[^:#@\\s]{1,50}$",
ignore_empty: true
},
(grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = {
max_length: 50,