Skip to content

Commit 90b802c

Browse files
committed
chore: ISS-162615 Add object member documentation
https://app.devrev.ai/devrev/works/ISS-162615
1 parent fc51a43 commit 90b802c

File tree

2 files changed

+32
-1
lines changed

2 files changed

+32
-1
lines changed
Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
Object members define which users belong to which groups.
2+
3+
They consist of the following fields:
4+
- `id`: The unique identifier for the object member in the external system
5+
- `object_id`: The unique identifier for the group in the external system
6+
- `member_id`: The unique identifier for the user that should be added to the group
7+
- `add_member_ids`: The list of unique identifiers for the users that should be added to the group
8+
- `remove_member_ids`: The list of unique identifiers for the users that should be removed from the group
9+
10+
<Warning>
11+
If you set the `add_member_ids` field, the `member_id` field will be ignored!
12+
Always set either `add_member_ids` or `member_id`, but not both.
13+
</Warning>
14+
15+
<Info>
16+
`member_id` is a legacy field that, while still supported, should be avoided in favor of `add_member_ids`.
17+
If possible, provide one object member per group, with the list of users to be added to the group.
18+
Originally each object member was used to add a single user to a group, but that has since been
19+
extended to support bulk addition and removal of users from a group.
20+
</Info>
21+
22+
<Info>
23+
If the external system exposes a way to notify you of user removals from a group, set those users
24+
in the `remove_member_ids` field.
25+
</Info>

fern/versions/public.yml

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -286,4 +286,10 @@ navigation:
286286
path: ../docs/pages/airdrop/data-model/permissions.mdx
287287
- page: "Mapping reasons"
288288
slug: mapping-reasons
289-
path: ../docs/pages/airdrop/data-model/mapping-reasons.mdx
289+
path: ../docs/pages/airdrop/data-model/mapping-reasons.mdx
290+
- section: Object type specifics
291+
slug: object-types
292+
contents:
293+
- page: "Object members"
294+
slug: object-members
295+
path: ../docs/pages/airdrop/data-model/object-members.mdx

0 commit comments

Comments
 (0)