openbankproject_client.user module
User endpoints for the OpenBankProject API Client.
- class openbankproject_client.user.UserEndpoints(client)[source]
Bases:
objectUser-related API endpoints.
- __init__(client)[source]
Initialize the endpoint group.
- Parameters:
client – OpenBankProjectClient instance
- get_users(params: Dict | None = None) Dict[source]
Get all users.
- Parameters:
params – Optional query parameters like limit, offset, etc.
- Returns:
Dict containing user information
- get_user_by_id(user_id: str) Dict[source]
Get user by ID.
- Parameters:
user_id – User identifier
- Returns:
Dict containing user information
- get_current_user() Dict[source]
Get the current authenticated user.
- Returns:
Dict containing current user information
- create_user(data: Dict) Dict[source]
Create a new user.
- Parameters:
data – User data including username, email, password, etc.
- Returns:
Dict containing created user information
- update_user(user_id: str, data: Dict) Dict[source]
Update an existing user.
- Parameters:
user_id – User identifier
data – Updated user data
- Returns:
Dict containing updated user information
- delete_user(user_id: str) Dict[source]
Delete a user.
- Parameters:
user_id – User identifier
- Returns:
Dict containing deletion status
- get_user_attributes(user_id: str) Dict[source]
Get attributes for a user.
- Parameters:
user_id – User identifier
- Returns:
Dict containing user attribute information
- add_user_attribute(user_id: str, data: Dict) Dict[source]
Add an attribute to a user.
- Parameters:
user_id – User identifier
data – Attribute data
- Returns:
Dict containing added attribute information
- update_user_attribute(user_id: str, attribute_id: str, data: Dict) Dict[source]
Update an attribute of a user.
- Parameters:
user_id – User identifier
attribute_id – Attribute identifier
data – Updated attribute data
- Returns:
Dict containing updated attribute information
- delete_user_attribute(user_id: str, attribute_id: str) Dict[source]
Delete an attribute from a user.
- Parameters:
user_id – User identifier
attribute_id – Attribute identifier
- Returns:
Dict containing deletion status
- get_user_entitlements(user_id: str) Dict[source]
Get entitlements for a user.
- Parameters:
user_id – User identifier
- Returns:
Dict containing user entitlement information
- add_user_entitlement(user_id: str, data: Dict) Dict[source]
Add an entitlement to a user.
- Parameters:
user_id – User identifier
data – Entitlement data
- Returns:
Dict containing added entitlement information
- delete_user_entitlement(user_id: str, entitlement_id: str) Dict[source]
Delete an entitlement from a user.
- Parameters:
user_id – User identifier
entitlement_id – Entitlement identifier
- Returns:
Dict containing deletion status
- get_user_permissions(user_id: str) Dict[source]
Get permissions for a user.
- Parameters:
user_id – User identifier
- Returns:
Dict containing user permission information
- add_user_permission(user_id: str, data: Dict) Dict[source]
Add a permission to a user.
- Parameters:
user_id – User identifier
data – Permission data
- Returns:
Dict containing added permission information
- delete_user_permission(user_id: str, permission_id: str) Dict[source]
Delete a permission from a user.
- Parameters:
user_id – User identifier
permission_id – Permission identifier
- Returns:
Dict containing deletion status
- get_user_authentication_methods(user_id: str) Dict[source]
Get authentication methods for a user.
- Parameters:
user_id – User identifier
- Returns:
Dict containing user authentication method information
- add_user_authentication_method(user_id: str, data: Dict) Dict[source]
Add an authentication method to a user.
- Parameters:
user_id – User identifier
data – Authentication method data
- Returns:
Dict containing added authentication method information
- delete_user_authentication_method(user_id: str, method_id: str) Dict[source]
Delete an authentication method from a user.
- Parameters:
user_id – User identifier
method_id – Authentication method identifier
- Returns:
Dict containing deletion status
- get_user_customers(user_id: str) Dict[source]
Get customers linked to a user.
- Parameters:
user_id – User identifier
- Returns:
Dict containing user customer information
- get_user_customer_by_id(user_id: str, customer_id: str) Dict[source]
Get a specific customer linked to a user.
- Parameters:
user_id – User identifier
customer_id – Customer identifier
- Returns:
Dict containing user customer information
- create_user_customer(user_id: str, data: Dict) Dict[source]
Create a customer linked to a user.
- Parameters:
user_id – User identifier
data – Customer data
- Returns:
Dict containing created customer information
- update_user_customer(user_id: str, customer_id: str, data: Dict) Dict[source]
Update a customer linked to a user.
- Parameters:
user_id – User identifier
customer_id – Customer identifier
data – Updated customer data
- Returns:
Dict containing updated customer information
- delete_user_customer(user_id: str, customer_id: str) Dict[source]
Delete a customer linked to a user.
- Parameters:
user_id – User identifier
customer_id – Customer identifier
- Returns:
Dict containing deletion status
- get_user_customer_links(user_id: str) Dict[source]
Get customer links for a user.
- Parameters:
user_id – User identifier
- Returns:
Dict containing user customer link information
- create_user_customer_link(user_id: str, data: Dict) Dict[source]
Create a customer link for a user.
- Parameters:
user_id – User identifier
data – Customer link data
- Returns:
Dict containing created customer link information