Skip to content

Users

User

Bases: object

Handles the users type methods

get_user(user_id)

Return a user data

Parameters:

Name Type Description Default
user_id int

USer ID to verify

required

Returns:

Type Description
ApiResponse

bool - Asset type ID matching provided asset type name

list_users()

Returns a list of the users with a restricted view so it can be called by unprivileged users.

Returns:

Type Description
ApiResponse

ApiResponse object

lookup_username(username)

Returns a user ID corresponding to the username, else None

Parameters:

Name Type Description Default
username str

User name to lookup

required

Returns:

Type Description
ApiResponse

ApiResponse

user_id_exists(user_id)

Returns True if the user ID exists, else false

Parameters:

Name Type Description Default
user_id int

User ID to verify

required

Returns:

Type Description
bool

bool - Asset type ID matching provided asset type name

username_exists(username)

Returns True if the username (login) exists, else false. This is equivalent to calling lookup_username() and getting the results.

Parameters:

Name Type Description Default
username str

User name (login) to lookup

required

Returns:

Type Description
bool

True if exists else false


Last update: 2022-03-20
Back to top