/
[DRAFT] Refresh client secret - Deprecated [API-009-001-002-0329]

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

[DRAFT] Refresh client secret - Deprecated [API-009-001-002-0329]

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] Refresh client secret - Deprecated [API-009-001-002-0329]

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-002-0329

Microservices (namespace)

Mithril

Component

Mithril

Component ID

COM-009-001

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

GENERAL MIS API · Apiary

Resource

{{host}}/admin/clients/{{id}}/refresh_secret

Scope

secret:refresh

Protocol type

REST

Request type

PATCH

Sync/Async

Sync

Public/Private

Public

Purpose

Refresh client secret for existing client (legal entity)

Logic

This method is used to refresh client secret for existing client (legal entity). Only legal entity owner can request new client secret for his own legal entity

Configuration parameters

N/A

Dictionaries

N/A

Input parameters

Input parameter

Mandatory

Type

Description

Example

Input parameter

Mandatory

Type

Description

Example

1

id

 

string

Composition object ID

role-1380df72-275a-11e7-93ae-92361f002671

Request structure

See on API-specification

Headers

Headers

Request data validation

N/A

Processing

N/A

Response structure examples

See on API-specification

{ "meta": { "code": 200, "url": "https://example.com/resource", "type": "object", "request_id": "req-adasdoijasdojsda" }, "data": { "id": "df9f70ee-4b12-4740-b0f5-bb5aea116863", "name": "Аптека 199", "secret": "ZlFOaHBTR0d3Q0hQcDEraHVYdXBVZz09", "redirect_uri": "https://example2.com", "settings": {}, "priv_settings": {} } }

HTTP status codes

Response code

HTTP Status code

Message

Internal name

Description

Response code

HTTP Status code

Message

Internal name

Description

1

Базові

2

 

 200

 

 

 

3

 

 

 

 

 

4

Специфічні

5

 

 

 

 

 

Post-processing processes

N/A

Technical modules where the method is used

 

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