openbankproject_client.role module
Role endpoints for the OpenBankProject API Client.
- class openbankproject_client.role.RoleEndpoints(client)[source]
Bases:
objectRole-related API endpoints.
- __init__(client)[source]
Initialize the endpoint group.
- Parameters:
client – OpenBankProjectClient instance
- add_entitlement_for_user(bank_id: str, user_id: str, role_name: str) Dict[source]
Add Entitlement for a User.
- Parameters:
bank_id – Bank identifier
user_id – User identifier
role_name – Role name
- Returns:
Dict containing entitlement information
- create_user_with_roles(bank_id: str, data: Dict) Dict[source]
Create (DAuth) User with Roles.
- Parameters:
bank_id – Bank identifier
data – User and roles data
- Returns:
Dict containing created user information
- create_entitlement_request_for_current_user(bank_id: str, data: Dict) Dict[source]
Create Entitlement Request for current User.
- Parameters:
bank_id – Bank identifier
data – Entitlement request data
- Returns:
Dict containing created entitlement request information
- delete_entitlement(bank_id: str, user_id: str, role_name: str) Dict[source]
Delete Entitlement.
- Parameters:
bank_id – Bank identifier
user_id – User identifier
role_name – Role name
- Returns:
Dict containing deletion status
- delete_entitlement_request(entitlement_request_id: str) Dict[source]
Delete Entitlement Request.
- Parameters:
entitlement_request_id – Entitlement request identifier
- Returns:
Dict containing deletion status
- get_entitlement_requests_for_user(user_id: str) Dict[source]
Get Entitlement Requests for a User.
- Parameters:
user_id – User identifier
- Returns:
Dict containing entitlement requests information
- get_entitlement_requests_for_current_user() Dict[source]
Get Entitlement Requests for the current User.
- Returns:
Dict containing entitlement requests information
- get_entitlements_and_permissions_for_user(user_id: str) Dict[source]
Get Entitlements and Permissions for a User.
- Parameters:
user_id – User identifier
- Returns:
Dict containing entitlements and permissions information
- get_entitlements_for_one_bank(bank_id: str) Dict[source]
Get Entitlements for One Bank.
- Parameters:
bank_id – Bank identifier
- Returns:
Dict containing entitlements information
- get_entitlements_for_user(user_id: str) Dict[source]
Get Entitlements for User.
- Parameters:
user_id – User identifier
- Returns:
Dict containing entitlements information
- get_entitlements_for_user_at_bank(bank_id: str, user_id: str) Dict[source]
Get Entitlements for User at Bank.
- Parameters:
bank_id – Bank identifier
user_id – User identifier
- Returns:
Dict containing entitlements information
- get_entitlements_for_current_user() Dict[source]
Get Entitlements for the current User.
- Returns:
Dict containing entitlements information