User Risk Profiles
- class py42.clients.userriskprofile.UserRiskProfileClient(user_risk_profile_service)
Bases:
object
A client to expose the user risk profile API.
- add_cloud_aliases(user_id, cloud_alias)
Add cloud aliases to a user risk profile.
- Parameters
user_id (str) – The user UID.
cloud_alias (str or list(str)) – The alias(es) to add to the user risk profile. Each user starts with a default alias of their code42 username and can have one additional cloud alias.
- Returns
- delete_cloud_aliases(user_id, cloud_aliases)
Delete cloud aliases from a user risk profile.
- Parameters
user_id (str) – The user UID.
cloud_aliases (str or list(str)) – The alias(es) to remove from the user risk profile. Each user starts with a default alias of their code42 username and can have one additional cloud alias.
- Returns
- get_all(manager_id=None, title=None, division=None, department=None, employment_type=None, country=None, region=None, locality=None, active=None, deleted=None, support_user=None)
Get all user risk profiles.
- Parameters
manager_id (str, optional) – Matches users whose manager has the given Code42 user UID. Defaults to None
title (str, optional) – Matches users with the given job title. Defaults to None
division (str, optional) – Matches users in the given division. Defaults to None
department (str, optional) – Matches users in the given department. Defaults to None
employment_type (str, optional) – Matches users with the given employment type. Defaults to None
country (str, optional) – Matches users in the given country. Defaults to None
region (str, optional) – Matches users the given region (state). Defaults to None
locality (str, optional) – Matches users in the given locality (city). Defaults to None
active (boolean, optional) – Matches users by whether the user is active. Defaults to None
deleted (boolean, optional) – Matches users by whether the user is deleted. Defaults to None
support_user (boolean, optional) – Matches users by whether the user is a support user. Defaults to None
- Returns
An object that iterates over
py42.response.Py42Response
objects that each contain a page of user risk profiles.- Return type
generator
- get_by_id(user_id)
Get a user risk profile by a user UID.
- Parameters
user_id (str) – A unique user UID.
- Returns
- get_by_username(username)
Get a user risk profile by username.
- Parameters
username (str) – A username.
- Returns
- get_page(page_num=1, page_size=None, manager_id=None, title=None, division=None, department=None, employment_type=None, country=None, region=None, locality=None, active=None, deleted=None, support_user=None)
Get a page of user risk profiles.
- Parameters
page_num (integer, optional) – The desired page of user risk profile results to retrieve. Defaults to None
page_size (integer, optional) – The desired number of results per page. Defaults to None
manager_id (str, optional) – Matches users whose manager has the given Code42 user UID. Defaults to None
title (str, optional) – Matches users with the given job title. Defaults to None
division (str, optional) – Matches users in the given division. Defaults to None
department (str, optional) – Matches users in the given department. Defaults to None
employment_type (str, optional) – Matches users with the given employment type. Defaults to None
country (str, optional) – Matches users in the given country. Defaults to None
region (str, optional) – Matches users the given region (state). Defaults to None
locality (str, optional) – Matches users in the given locality (city). Defaults to None
active (boolean, optional) – Matches users by whether the user is active. Defaults to None
deleted (boolean, optional) – Matches users by whether the user is deleted. Defaults to None
support_user (boolean, optional) – Matches users by whether the user is a support user. Defaults to None
- Returns
- update(user_id, start_date=None, end_date=None, notes=None)
Update a user risk profile.
For each arg, if None is provided, the value will not be updated. Pass an empty string if you want to clear that value from the profile.
- Parameters
user_id (str) – The UID of the user to update.
start_date (str or datetime, optional) – The start date of the user risk profile to be updated. Expects format of ‘YYYY-MM-DD’ or instance of datetime. Defaults to None.
end_date (str or datetime, optional) – The departure date of the user risk profile to be updated. Expects format of ‘YYYY-MM-DD’ or instance of datetime. Defaults to None.
notes (str, optional) – The notes field of the user risk profile to be updated. Defaults to None
- Returns