Відділення (доступ)

Щоб налаштувати доступ співробітників до відділень, необхідно використовувати наступні методи. Ці методи призначені для встановлення та керування дозволами в системі Віддіелнь(Філій), гарантуючи, що працівникам надано відповідні рівні доступу відповідно до їхніх ролей і обов’язків у філії.

Створення дозволу ролі для доступу до відділення

Add role permission to branch access

post

Add role permission to branch access

Path parameters

counterparty_guidstringRequired

Counterparty GUID

Body

application/json

branch_guidstringOptional

branch's guid

permission_guidstringOptional

permission's guid for permission what you need to add to role

role_namestringOptional

role's name

Responses

200

OK

application/json

objectOptional

400

json with error msg

application/json

post

/counterparty/{counterparty_guid}/branches-access/permission

HTTPcURLJavaScriptPython

POST /api/v1/counterparty/{counterparty_guid}/branches-access/permission HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 66

{
  "branch_guid": "text",
  "permission_guid": "text",
  "role_name": "text"
}

{}

Видалення дозволу ролі з доступу до відділення

Remove role permission from branch access

delete

Remove role permission from branch access

Path parameters

counterparty_guidstringRequired

Counterparty GUID

Body

application/json

branch_guidstringOptional

branch's guid

permission_guidstringOptional

permission's guid for permission what you need to remove to role

role_namestringOptional

role's name

Responses

200

OK

application/json

objectOptional

400

json with error msg

application/json

delete

/counterparty/{counterparty_guid}/branches-access/permission

HTTPcURLJavaScriptPython

DELETE /api/v1/counterparty/{counterparty_guid}/branches-access/permission HTTP/1.1
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

Get roles with branch access permissions for table

Path parameters

counterparty_guidstringRequired

Counterparty GUID

Query parameters

branch_guidstringRequired

branch guid (uuid)

role_namesstring[]Optional

account kinds (string)

Responses

200

OK

application/json

rolesstring[]Optional

400

json with error msg

application/json

get

/counterparty/{counterparty_guid}/branches-access/permission/table

HTTPcURLJavaScriptPython

GET /api/v1/counterparty/{counterparty_guid}/branches-access/permission/table?branch_guid=text HTTP/1.1
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

post

Create role for branch access

Path parameters

counterparty_guidstringRequired

Counterparty GUID

Body

application/json

role_namestringOptional

role's name

Responses

200

OK

application/json

objectOptional

400

json with error msg

application/json

post

/counterparty/{counterparty_guid}/branches-access/role

HTTPcURLJavaScriptPython

POST /api/v1/counterparty/{counterparty_guid}/branches-access/role HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 20

{
  "role_name": "text"
}

{}

Видалиення ролі доступу до відділення

Delete role for branch access

delete

Delete role for branch access

Path parameters

counterparty_guidstringRequired

Counterparty GUID

Body

application/json

role_namestringOptional

role's name

Responses

200

OK

application/json

objectOptional

400

json with error msg

application/json

delete

/counterparty/{counterparty_guid}/branches-access/role

HTTPcURLJavaScriptPython

DELETE /api/v1/counterparty/{counterparty_guid}/branches-access/role HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 20

{
  "role_name": "text"
}

{}

Отримання доступу до відділеннь

Get branch access scopes

get

Get branch access scopes

Path parameters

counterparty_guidstringRequired

Counterparty GUID

Responses

200

OK

application/json

400

json with error msg

application/json

get

/counterparty/{counterparty_guid}/branches-access/scope

HTTPcURLJavaScriptPython

GET /api/v1/counterparty/{counterparty_guid}/branches-access/scope HTTP/1.1
Accept: */*

{
  "branches_access_list": [
    {
      "access": "text",
      "branch_guid": "text"
    }
  ]
}

Отримання списку користувачів

Get users list

get

Get users list

Path parameters

counterparty_guidstringRequired

Counterparty GUID

Query parameters

role_namestringOptional

role name (string)

limitstringOptional

limit (int64)

page_tokenstringOptional

page token (int64)

Responses

200

OK

application/json

page_tokenstringOptional

400

json with error msg

application/json

get

/counterparty/{counterparty_guid}/branches-access/user

HTTPcURLJavaScriptPython

GET /api/v1/counterparty/{counterparty_guid}/branches-access/user HTTP/1.1
Accept: */*

[
  {
    "page_token": "text",
    "users": [
      {
        "guid": "text",
        "role_name": "text"
      }
    ]
  }
]

Прив'язка користувача до ролі доступу до відділеннь

Add user to branch access role

post

Add user to branch access role

Path parameters

counterparty_guidstringRequired

Counterparty GUID

Body

application/json

role_namestringOptional

role's name

user_guidstringOptional

employee's guid

Responses

200

OK

application/json

objectOptional

400

json with error msg

application/json

post

/counterparty/{counterparty_guid}/branches-access/user

HTTPcURLJavaScriptPython

POST /api/v1/counterparty/{counterparty_guid}/branches-access/user HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 39

{
  "role_name": "text",
  "user_guid": "text"
}

{}

Видалення користувача з ролі доступу до відділення

Remove user from branch access role

delete

Remove user from branch access role

Path parameters

counterparty_guidstringRequired

Counterparty GUID

Body

application/json

role_namestringOptional

role's name

user_guidstringOptional

employee's guid

Responses

200

OK

application/json

objectOptional

400

json with error msg

application/json

delete

/counterparty/{counterparty_guid}/branches-access/user

HTTPcURLJavaScriptPython

DELETE /api/v1/counterparty/{counterparty_guid}/branches-access/user HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 39

{
  "role_name": "text",
  "user_guid": "text"
}

{}

Перевірка дозволу відділення для користувача

Check branch permission for user guid

post

Check branch permission for user guid

Body

application/json

counterparty_guidstringOptional

CounterpartyGUID specify counterparty

counterparty_jwtstringOptional

CounterpartyJWT

permissionstringOptional

Permission level of permission

user_guidstringOptional

UserGUID identity id

Responses

200

allowed

application/json

allowedbooleanOptional

Allowed "true" or "false" flag

400

json with error msg

application/json

403

not allowed

application/json

post

/access/branches

HTTPcURLJavaScriptPython

POST /api/v1/access/branches HTTP/1.1
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
}