Saml_Service_Providers

class Saml_Service_Providers(session_kwargs, client, return_type='raw')

Examples

>>> import civis
>>> client = civis.APIClient()
>>> client.saml_service_providers.list_shares(...)

Methods

delete_shares_groups(id, group_id)	Revoke the permissions a group has on this object
delete_shares_users(id, user_id)	Revoke the permissions a user has on this object
list_shares(id)	List users and groups permissioned on this object
put_shares_groups(id, group_ids, ...[, ...])	Set the permissions groups has on this object
put_shares_users(id, user_ids, ...[, ...])	Set the permissions users have on this object

delete_shares_groups(id: int, group_id: int)

Revoke the permissions a group has on this object

Parameters:

idint

The ID of the resource that is shared.

group_idint

The ID of the group.

Returns:

None

Response code 204: success

delete_shares_users(id: int, user_id: int)

Revoke the permissions a user has on this object

Parameters:

idint

The ID of the resource that is shared.

user_idint

The ID of the user.

Returns:

None

Response code 204: success

list_shares(id: int)

List users and groups permissioned on this object

Parameters:

idint

The ID of the resource that is shared.

Returns:

civis.response.Response

• readersdict

  • userslist[dict]

    • id : int

    • name : str

  • groupslist[dict]

    • id : int

    • name : str

• writersdict

  • userslist[dict]

    • id : int

    • name : str

  • groupslist[dict]

    • id : int

    • name : str

• ownersdict

  • userslist[dict]

    • id : int

    • name : str

  • groupslist[dict]

    • 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.

put_shares_groups(id: int, group_ids: list[int], permission_level: str, *, share_email_body: str = None, send_shared_email: bool = None)

Set the permissions groups has on this object

Parameters:

idint

The ID of the resource that is shared.

group_idslist[int]

An array of one or more group IDs.

permission_levelstr

Options are: “read”, “write”, or “manage”.

share_email_bodystr, optional

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

send_shared_emailbool, optional

Send email to the recipients of a share.

Returns:

civis.response.Response

• readersdict

  • userslist[dict]

    • id : int

    • name : str

  • groupslist[dict]

    • id : int

    • name : str

• writersdict

  • userslist[dict]

    • id : int

    • name : str

  • groupslist[dict]

    • id : int

    • name : str

• ownersdict

  • userslist[dict]

    • id : int

    • name : str

  • groupslist[dict]

    • 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.

put_shares_users(id: int, user_ids: list[int], permission_level: str, *, share_email_body: str = None, send_shared_email: bool = None)

Set the permissions users have on this object

Parameters:

idint

The ID of the resource that is shared.

user_idslist[int]

An array of one or more user IDs.

permission_levelstr

Options are: “read”, “write”, or “manage”.

share_email_bodystr, optional

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

send_shared_emailbool, optional

Send email to the recipients of a share.

Returns:

civis.response.Response

• readersdict

  • userslist[dict]

    • id : int

    • name : str

  • groupslist[dict]

    • id : int

    • name : str

• writersdict

  • userslist[dict]

    • id : int

    • name : str

  • groupslist[dict]

    • id : int

    • name : str

• ownersdict

  • userslist[dict]

    • id : int

    • name : str

  • groupslist[dict]

    • 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.