Member

class Member

Members on Redivis represent individuals who interface with an organization, including both data administrators and researchers applying to and using that organization's data. You must be an administrator of the respective organization in order to view and edit members.

Constructors

Organization.member(name)	Construct a new member instance based on the member's username.
Organization.list_members([max_results, ....])	Returns a list of members within the organization.

Examples

Basics

my_org = redivis.organization("some_organization")

# List all members
members = my_org.list_members()
for member in members:
   # ... do something with the member

# Get a specific member
a_member = my_org.member("jane_doe")
# Will throw an error if the member doesn't exists
# Can first call member.exists() to check for existence
a_member.get()

print(a_member.properties)

Filter members

my_org = redivis.organization("some_organization")

# List all pending members with a given label
pending_humanities_members = my_org.list_members(
    status=["pending"], 
    labels=["school:humanities"]
)
for member in members:
   # ... do something with the member

Update members

my_org = redivis.organization("some_organization")
members = my_org.list_members(...)

for member in members:
   # E.g., call an internal API to validate that member
   status = validate_member_against_internal_systems(member)
   member.update(status=status)

Attributes

organization	A reference to the Organization instance that constructed this member.
properties	A dict containing the API resource representation of the member. This will be fully populated after calling get(). This will also be partially populated for datasets returned via the Organization.list_members method.
user	A reference to the User instance associated with this member.

Methods

Member.add_labels(labels)	Add labels to a member.
Member.exists()	Check whether the member exists.
Member.get()	Get the member, populating the properties attribute on the current instance.
Member.remove_labels(labels)	Remove labels from a member.
Member.update([*, status, labels, ...])	Update certain attributes on the member.