ЕСОЗ - публічна документація

[DRAFT] List Roles [API-009-001-003-0330]

Owned by Serhii Boldin (SoE eHealth) (Unlicensed)
Last updated: Dec 13, 2024 by Anzhela Kovalenko (SoE eHealth)
1 min read

Сторінка знаходиться в процесі розробки. Інформація на ній може бути застарілою.

 

https://e-health-ua.atlassian.net/wiki/spaces/EN/pages/17591304241 (remove the link block before publishing the document)

Properties of a REST API method document

Document type

Метод REST API

Document title

[DRAFT] List Roles [API-009-001-003-0330]

Guideline ID

GUI-0011

Author

@

Document version

1

Document status

DRAFT

Date of creation

ХХ.ХХ.ХХХХ (дата фінальної версії документа – RC або PROD)

Date of update

ХХ.ХХ.ХХХХ (дата зміни версії)

Method API ID

API-009-001-003-0330

Microservices (namespace)

Mithril

Component

Mithril

Component ID

COM-009-001

Link на API-специфікацію

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

Resource

{{host}}/admin/roles

Scope

role:read

Protocol type

REST

Request type

GET

Sync/Async

Sync

Public/Private

Public

Purpose

This method allows to get a list of scopes corresponding to the role by role name.

Logic

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

Configuration parameters

N/A

Dictionaries

N/A

Input parameters

Input parameter

Mandatory

Type

Description

Example

Input parameter

Mandatory

Type

Description

Example

1

 

 

 

 

 

2

 

 

 

 

 

Request structure

See on API-specification

Headers

Headers

Request data validation

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

Processing

N/A

Response structure examples

See on API-specification

{ "meta": { "code": 200, "url": "https://example.com/resource", "type": "object", "request_id": "6617aeec-15e2-4d6f-b9bd-53559c358f97#17810" }, "data": [ { "name": "Doctor", "scope": "notebooks:read notebooks:create patients:read", "id": "role-1380df72-275a-11e7-93ae-92361f002671" } ], "paging": { "limit": 20, "cursors": { "starting_after": "56c31536a60ad644060041af", "ending_before": "56c31536a60ad644060041aa" }, "size": 50, "has_more": false } }

HTTP status codes

Response code

HTTP Status code

Message

Internal name

Description

Response code

HTTP Status code

Message

Internal name

Description

1

Базові

2

 

200

 Response

 

 

3

Специфічні

4

 

 

 

 

 

Post-processing processes

N/A

Technical modules where the method is used

 

ЕСОЗ - публічна документація