credentials_put_shares_users {civis}

Set the permissions users have on this object

Description

Set the permissions users have on this object

Usage

credentials_put_shares_users(
  id,
  user_ids,
  permission_level,
  share_email_body = NULL,
  send_shared_email = NULL
)

Arguments

id

integer required. The ID of the resource that is shared.

user_ids

array required. An array of one or more user IDs.

permission_level

string required. Options are: "read", "write", or "manage".

share_email_body

string optional. Custom body text for e-mail sent on a share.

send_shared_email

boolean optional. Send email to the recipients of a share.

Value

A list containing the following elements:

readers

list, A list containing the following elements:

• users array,

• groups array,

writers

list, A list containing the following elements:

• users array,

• groups array,

owners

list, A list containing the following elements:

• users array,

• groups array,

totalUserShares

integer, For owners, the number of total users shared. For writers and readers, the number of visible users shared.

totalGroupShares

integer, For owners, the number of total groups shared. For writers and readers, the number of visible groups shared.