Aliases

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

Civis API /aliases endpoint.

Methods

delete(id)	Delete an alias
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
get(id)	Get an Alias
get_object_type(object_type, alias)	Get details about an alias within an FCO type
list(*[, object_type, limit, page_num, ...])	List Aliases
list_dependencies(id, *[, user_id])	List dependent objects for this object
list_shares(id)	List users and groups permissioned on this object
patch(id, *[, object_id, object_type, ...])	Update some attributes of this Alias
post(object_id, object_type, alias, *[, ...])	Create an Alias
put(id, object_id, object_type, alias, *[, ...])	Replace all attributes of this Alias
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
put_transfer(id, user_id, ...[, email_body, ...])	Transfer ownership of this object to another user