Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Table of Contents

Purpose

API paragraph not foundThis method allows to get a list of scopes corresponding to the role by role name.

Specification

Page Properties
idAPI_Specification

Link

https://ehealthmisapi1.docs.apiary.io/#reference/public.-medical-service-provider-integration-layer/roles/list-roles

Посилання на Apiary або Swagger

Resource

/admin/roles

Посилання на ресурс, наприклад: /api/persons/create

Scope

role:read

Scope для доступу

Components

Scopes Model

Зазначається перелік бізнес компонентів, які використовують цей метод, наприклад: ePrescription

Microservices

API paragraph not found

Перелік мікросервісів, які використовує метод API, наприклад: Auth, ABAC

Protocol type

REST

Тип протоколу, який використовується запитом, наприклад: SOAP | REST

Request type

GET

Тип запиту API, наприклад: GET, POST, PATCH…

Sync/Async

Sync

Метод є синхронним чи асинхронним?

Public/Private/Internal

Public

Потрібно зазначити тип методу за ступенем доступності

Preconditions

Logic

API paragraph not foundThis method returns list of roles with id/name/scopes from mithril.roles. Can be used with or without search params.

Global and configuration parameters

...

Filters

See on Apiary

Authorize

...

  1. Verify the validity of access token

    1. in case error return 401 Unauthorized

  2. Check users scopes (role:read) to perform this action

    1. in case error return 403 - forbidden

Headers

Content-Type:application/json

...

Page Properties
idAPI_HTTP status codes

HTTP status code

Message

What caused the error

 200

 Response

 

401

Unauthorized

invalid token

Backward compatibility

API paragraph not found