groups_put_members: Add a user to a group

In civisanalytics/civis-r: R Client for the 'Civis Platform API'

Description

Add a user to a group

Usage

groups_put_members(id, user_id)

Arguments

id	integer required. The ID of the group.
user_id	integer required. The ID of the user.

Value

A list containing the following elements:

id	integer, The ID of this group.
name	string, This group's name.
createdAt	string, The date and time when this group was created.
description	string, The description of the group.
slug	string, The slug for this group.
organizationId	integer, The ID of the organization this group belongs to.
organizationName	string, The name of the organization this group belongs to.
memberCount	integer, The total number of members in this group.
mustAgreeToEula	boolean, Whether or not members of this group must sign the EULA.
defaultOtpRequiredForLogin	boolean, The two factor authentication requirement for this group.
roleIds	array, An array of ids of all the roles this group has.
defaultTimeZone	string, The default time zone of this group.
defaultJobsLabel	string, The default partition label for jobs of this group. Only available if custom_partitions feature flag is set. Do not use this attribute as it may break in the future.
defaultNotebooksLabel	string, The default partition label for notebooks of this group. Only available if custom_partitions feature flag is set. Do not use this attribute as it may break in the future.
defaultServicesLabel	string, The default partition label for services of this group. Only available if custom_partitions feature flag is set. Do not use this attribute as it may break in the future.
members	array, An array containing the following fields: id integer, The ID of this user. name string, This user's name. username string, This user's username. initials string, This user's initials. online boolean, Whether this user is online.

civisanalytics/civis-r documentation built on June 27, 2020, 7:25 a.m.