Skip to content

Commit

Permalink
clarifying correlation_id details
Browse files Browse the repository at this point in the history
  • Loading branch information
tylernix committed Nov 1, 2024
1 parent b69eb39 commit 1df6eea
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion docs/content/getting-started/perform-check.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -169,7 +169,7 @@ If you want to check multiple user-object-relationship combinations in a single

The Batch Check endpoint requires a `correlation_id` parameter for each check. The `correlation_id` is used to "correlate" the check respones with the checks sent in the request, since `tuple_keys` and `contextual_tuples` are not returned in the response to improve network latency. A `correlation_id` can be composed of any string of alphanumeric characters or dashes between 1-36 characters in length. This means you can use simple iterating integers `1,2,3,etc`, UUID `e5fe049b-f252-40b3-b795-fe485d588279`, ULID `01JBMD9YG0XH3B4GVA8A9D2PSN`, or something else, but they must be unique for the entire request.

If you are using one of our SDKs, the `correlation_id` is inserted for you by default.
If you are using one of our SDKs, the `correlation_id` is inserted for you by default and automatically correlates the `allowed` response with the proper `tuple_key`.

To check whether user `user:anne` has multiple relationships `can_edit, can_view` with object `document:Z`

Expand Down

0 comments on commit 1df6eea

Please sign in to comment.