#community-help

Querying About Scoped API Keys Usage in Typesense

TLDR Rajeev requested information about appropriate scoped API keys for a retrieve call on a collection in Typesense. Jason clarified that collections:get is the appropriate key needed.

15mo

Join the chat

Jul 20, 2022 (15 months ago)

Photo of md5-c528ac87727cc861bfd23bb8242ccfdd

Rajeev

04:20 PM

Hi ~,
Quick question regarding the scoped API keys, what is the scope that one needs to use if they want to do a retrieve call on a collection, I see as per the documentation for collections there are three scopes but none of them are read only. We are trying to do this to get schema related information of the collection and based on it do some custom rendering on the client side.

Photo of md5-8813087cccc512313602b6d9f9ece19f

Jason

04:22 PM

Here are more examples: https://typesense.org/docs/0.23.1/api/api-keys.html#sample-actions

You want to use collections:get

Rajeev

04:24 PM

Got it thanks for the prompt response, Saw the table and thought the things mentioned there are the exhaustive list, Is there any documentation to know the exhaustive list of actions that are available at different levels or all the actions are available at all the levels ??

Jason

04:26 PM

It’s closely tied to the API endpoint naming, which is why we haven’t documented it exhaustively.

If the last component of the API path is /XYZ then the resource name in permissions is XYZ:action where action can be get, delete, create

Rajeev

04:27 PM

Got it, Thanks

Typesense

Lightning-fast, open source search engine for everyone | Knowledge Base powered by Struct.AI

Indexed 2779 threads (79% resolved)

Join Our Community Manage subscription

Similar Threads

Resolving Issues with Scoped API Keys in Typesense with Golang

Suvarna had problems with generating and using scoped API keys in Typesense with Golang. Several bugs misleading the user were found and fixed by Kishore Nallan.

158

26mo

Correct API Key Generation and Usage on Cloud

Tom faced 401 errors while creating keys via the Cloud API. Kishore Nallan clarified the correct syntax and mechanics, and identified a header mislabeling on Tom's part that caused the issue. They also discussed using scoped API keys.

12mo

Issues with Generating Scope API Keys in Python

Danny had issues generating a valid scope API key in a Python GraphQL server. Jason suggested encoding changes and confirmed that the key length varies. Issue unresolved with Python, although JS library worked.

17mo