civis (version 3.0.0)

projects_list_shares: List users and groups permissioned on this object

Description

List users and groups permissioned on this object

Usage

projects_list_shares(id)

Value

An array containing the following fields:

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.

Arguments

id

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