Branch access
To configure employee access to branches, it is necessary to use these endpoints. These endpoints are designed to enable the establishment and management of permissions within the branch system, ensuring that employees are granted appropriate levels of access based on their branch roles and responsibilities.
Add role permission to branch access
Add role permission to branch access
Counterparty GUID
branch's guid
permission's guid for permission what you need to add to role
role's name
POST /api/v1/counterparty/{counterparty_guid}/branches-access/permission HTTP/1.1
Host: your_host
Content-Type: application/json
Accept: */*
Content-Length: 66
{
"branch_guid": "text",
"permission_guid": "text",
"role_name": "text"
}{}Remove role permission from branch access
Remove role permission from branch access
Counterparty GUID
branch's guid
permission's guid for permission what you need to remove to role
role's name
DELETE /api/v1/counterparty/{counterparty_guid}/branches-access/permission HTTP/1.1
Host: your_host
Content-Type: application/json
Accept: */*
Content-Length: 66
{
"branch_guid": "text",
"permission_guid": "text",
"role_name": "text"
}{}Get roles with branch access permissions for table
Get roles with branch access permissions for table
Counterparty GUID
branch guid (uuid)
account kinds (string)
GET /api/v1/counterparty/{counterparty_guid}/branch/{branch_guid}/permission/table HTTP/1.1
Host: your_host
Accept: */*
{
"roles": [
"text"
],
"rows": [
{
"group_lang_key": "text",
"group_name": "text",
"permissions": [
{
"guid": "text",
"name": "text",
"name_lang_key": "text",
"roles": [
{
"allowed": true,
"name": "text"
}
],
"sort_number": 1
}
],
"sort_number": 1
}
]
}Create role for branch access
Create role for branch access
Counterparty GUID
BranchGUID where should be created the role
role's name
POST /api/v1/counterparty/{counterparty_guid}/branches-access/role HTTP/1.1
Host: your_host
Content-Type: application/json
Accept: */*
Content-Length: 41
{
"branch_guid": "text",
"role_name": "text"
}{}Delete role for branch access
Delete role for branch access
Counterparty GUID
role's name
DELETE /api/v1/counterparty/{counterparty_guid}/branches-access/role HTTP/1.1
Host: your_host
Content-Type: application/json
Accept: */*
Content-Length: 20
{
"role_name": "text"
}{}Get branch access scopes
Get branch access scopes
Counterparty GUID
GET /api/v1/counterparty/{counterparty_guid}/branches-access/scope HTTP/1.1
Host: your_host
Accept: */*
{
"branches_access_list": [
{
"access": "text",
"branch_guid": "text"
}
]
}Get users list
Get users list
Counterparty GUID
role name (string)
limit (int64)
page token (int64)
GET /api/v1/counterparty/{counterparty_guid}/branches-access/user HTTP/1.1
Host: your_host
Accept: */*
[
{
"page_token": "text",
"users": [
{
"guid": "text",
"role_name": "text"
}
]
}
]Add user to branch access role
Add user to branch access role
Counterparty GUID
role's name
employee's guid
POST /api/v1/counterparty/{counterparty_guid}/branches-access/user HTTP/1.1
Host: your_host
Content-Type: application/json
Accept: */*
Content-Length: 39
{
"role_name": "text",
"user_guid": "text"
}{}Remove user from branch access role
Remove user from branch access role
Counterparty GUID
role's name
employee's guid
DELETE /api/v1/counterparty/{counterparty_guid}/branches-access/user HTTP/1.1
Host: your_host
Content-Type: application/json
Accept: */*
Content-Length: 39
{
"role_name": "text",
"user_guid": "text"
}{}Check branch permission for user guid
Check branch permission for user guid
BranchesAccess struct for host branch unique scope
CounterpartyGUID specify counterparty
CounterpartyJWT
Permission level of permission
UserGUID identity id
POST /api/v1/access/branches HTTP/1.1
Host: your_host
Content-Type: application/json
Accept: */*
Content-Length: 150
{
"branches_access": {
"access": "text",
"branch_guid": "text"
},
"counterparty_guid": "text",
"counterparty_jwt": "text",
"permission": "text",
"user_guid": "text"
}{
"allowed": true
}Last updated