client.remote_hosts.list_shares

A method of the Remote Hosts endpoint.

list_shares(id: int) → ListResponse

List users and groups permissioned on this object

API URL: GET /remote_hosts/{id}/shares

import civis
client = civis.APIClient()
response = client.remote_hosts.list_shares(...)

Parameters:

idint

The ID of the resource that is shared.

Returns:

civis.ListResponse

• readerscivis.Response

  • usersList[civis.Response]

    • id : int

    • name : str

  • groupsList[civis.Response]

    • id : int

    • name : str

• writerscivis.Response

  • usersList[civis.Response]

    • id : int

    • name : str

  • groupsList[civis.Response]

    • id : int

    • name : str

• ownerscivis.Response

  • usersList[civis.Response]

    • id : int

    • name : str

  • groupsList[civis.Response]

    • id : int

    • name : str

• total_user_sharesint

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

• total_group_sharesint

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