Pool Members
The people who manage a pool. A membership has no ID of its own. It is
identified by the pool and the user, so adding someone and changing their role
are the same request: a POST to the pool's members with their userId.
List pool members
Lists everyone with access to the pool. That includes people with a role assigned on this pool and people who inherit one from an ancestor pool.
path Parameters
bucketIdThe bucket ID (bckt_…). Everything in a bucket is addressed under it.
poolIdThe pool ID (config_…).
query Parameters
limitThe maximum number of items to return.
offsetThe number of items to skip before the first item returned.
List pool members › Responses
A page of pool members.
The pool members on this page.
limitThe page size that was applied.
offsetThe number of items skipped before this page.
totalThe number of items in the whole collection.
hasMoreWhether there are more items after this page.
nextThe relative URL of the next page, or null on the last page.
Add or update a pool member
Gives an account member a role on the pool. If they already have a role on
the pool, it is changed instead, so sending the same request again changes
nothing. Returns 201 when the person was added and 200 when their role
was updated.
userId has to be an account member, invited or active; any other userId
is a 400. Add someone who is not in the account yet with
POST /v4/accounts/{accountId}/members first, and use the userId it
returns right away: they can use the pool once they become active.
A person without access to the pool's project gets it too, as a project
member (admin without role-based access control). Granting it takes the
right to manage the project's members, so a pool admin who is not a project
admin gets 403 when the person has no access to the project yet. Without
role-based access control every account member is an admin, so role
must be admin; member is a 400.
path Parameters
bucketIdThe bucket ID (bckt_…). Everything in a bucket is addressed under it.
poolIdThe pool ID (config_…).
Add or update a pool member › Request Body
userIdA person, identified by their Zuplo user ID (user_…). Zuplo assigns it when
the person is first added to an account, before they ever sign in, and it
never changes. Every userId and ownerId in v4 is one.
roleA role on a pool. admin manages the pool, its apps and members; member can view the pool and use its apps. Neither creates, links, changes or rolls the consumers of the pool's apps, which people who manage the bucket's consumers do; both read them.
Add or update a pool member › Responses
The member's role was updated.
poolIdThe pool.
userIdA person, identified by their Zuplo user ID (user_…). Zuplo assigns it when
the person is first added to an account, before they ever sign in, and it
never changes. Every userId and ownerId in v4 is one.
emailThe person's email address.
nameThe person's display name, if they set one.
roleThe role assigned on this pool, or null if the person only inherits access.
inheritedRoleThe highest role inherited from an ancestor pool, or null.
effectiveRoleA role on a pool. admin manages the pool, its apps and members; member can view the pool and use its apps. Neither creates, links, changes or rolls the consumers of the pool's apps, which people who manage the bucket's consumers do; both read them.
Get a pool member
Returns one person's direct, inherited and effective role in the pool.
path Parameters
bucketIdThe bucket ID (bckt_…). Everything in a bucket is addressed under it.
poolIdThe pool ID (config_…).
userIdThe user ID of an account member (user_…).
A person, identified by their Zuplo user ID (user_…). Zuplo assigns it when
the person is first added to an account, before they ever sign in, and it
never changes. Every userId and ownerId in v4 is one.
Get a pool member › Responses
The pool member.
poolIdThe pool.
userIdA person, identified by their Zuplo user ID (user_…). Zuplo assigns it when
the person is first added to an account, before they ever sign in, and it
never changes. Every userId and ownerId in v4 is one.
emailThe person's email address.
nameThe person's display name, if they set one.
roleThe role assigned on this pool, or null if the person only inherits access.
inheritedRoleThe highest role inherited from an ancestor pool, or null.
effectiveRoleA role on a pool. admin manages the pool, its apps and members; member can view the pool and use its apps. Neither creates, links, changes or rolls the consumers of the pool's apps, which people who manage the bucket's consumers do; both read them.
Remove a pool member
Removes the role assigned directly on this pool. Access inherited from an
ancestor pool is unaffected. A repeated delete returns 404, which clients
should treat as success.
path Parameters
bucketIdThe bucket ID (bckt_…). Everything in a bucket is addressed under it.
poolIdThe pool ID (config_…).
userIdThe user ID of an account member (user_…).
A person, identified by their Zuplo user ID (user_…). Zuplo assigns it when
the person is first added to an account, before they ever sign in, and it
never changes. Every userId and ownerId in v4 is one.
Remove a pool member › Responses
The member was removed.