Where can I find the documentation about REST API more speci SpiceDB #spicedb

Where can I find the documentation about REST API,...

erickhgm

01/31/2023, 1:49 AM

Where can I find the documentation about REST API, more specific, how filters I can use in: http://localhost:8443/v1/relationships/read

erickhgm

01/31/2023, 1:52 AM

I would like something like this, get all users with a direct relation with a resource. Doesn't matter the role/permission. Example:

which users have access to resource:1

Joey

01/31/2023, 1:58 AM

https://buf.build/authzed/api/docs/main:authzed.api.v1#authzed.api.v1.PermissionsService.ReadRelationships

Joey

01/31/2023, 1:58 AM

as for which users have access directly OR indirectly

Joey

01/31/2023, 1:58 AM

https://buf.build/authzed/api/docs/main:authzed.api.v1#authzed.api.v1.PermissionsService.LookupSubjects

erickhgm

01/31/2023, 2:04 AM

Can I just translate this to JSON? **From**:

Copy code

message RelationshipFilter {
    string resource_type = 1;
    string optional_resource_id = 2;
    string optional_relation = 3;
    SubjectFilter optional_subject_filter = 4;
}

**To**:

Copy code

{
  "consistency": {
    "minimizeLatency": true
  },
  "relationshipFilter": {
    "resourceType": "document",
    "optionalResourceId": "",
    "optionalRelation": ""
  }
}

Joey

01/31/2023, 2:04 AM

more or less, yes

Joey

01/31/2023, 2:04 AM

I don't recall if it is

resourceType

resource_type

though

Joey

01/31/2023, 2:05 AM

so you might need to try both

erickhgm

01/31/2023, 2:05 AM

ok, no problem

erickhgm

01/31/2023, 2:05 AM

Thank you @Joey !

vroldanbet

01/31/2023, 10:38 AM

There should exists a Postman Workspace with examples for all APIs. @Sam do you have a link handy?

dsieczko

01/31/2023, 10:48 AM

Yes it’s in Postman - we’ll be exposing this better in our docs soon too @erickhgm - sorry for the trouble

dsieczko

01/31/2023, 10:48 AM

https://www.postman.com/authzed/workspace/spicedb/overview

erickhgm

01/31/2023, 12:13 PM

Yeah ... The picture that I sent was from this postman collection. I asked because in the example we don't have all the filters

vroldanbet

01/31/2023, 12:15 PM

oh woops, didn't realize that was postman, sorry!

dsieczko

01/31/2023, 12:21 PM

Ah - thanks @erickhgm - we’ll get them in there. Were you able to use them ok following Joey’s pointers?

erickhgm

01/31/2023, 12:24 PM

I haven't tried it yet, I'm just finishing reading the documentation https://openfga.dev/docs first

erickhgm

01/31/2023, 12:24 PM

But I will try ...

dsieczko

01/31/2023, 4:26 PM

Cool - let us know if you need help @erickhgm

Sam

01/31/2023, 5:10 PM

@erickhgm the generated json API format is documented under the API tab in the Postman workspace. Here's a link to the ReadRelationships call https://www.postman.com/authzed/workspace/spicedb/api/c7764854-8b04-4441-8360-a6b2f1d52064/request/21043612-4ab2a4b7-4117-4ec1-aaa4-f394b1c74db2?collection=21043612-1cae5125-a464-4846-bf9e-9a53237555de&version=f3d7a136-269a-4dc2-888a-3677565a7b83

erickhgm

01/31/2023, 5:43 PM

Great!

Previous Next