From 5c61f798d22f885a4c1120cfa49c9cfd39136335 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=C3=81kos=20Hunyadi?= <67875049+akoshunyadi@users.noreply.github.com> Date: Wed, 30 Oct 2024 17:57:22 +0100 Subject: [PATCH] Update device-roaming-status.yaml --- code/API_definitions/device-roaming-status.yaml | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/code/API_definitions/device-roaming-status.yaml b/code/API_definitions/device-roaming-status.yaml index 0d486ac..ca219fc 100644 --- a/code/API_definitions/device-roaming-status.yaml +++ b/code/API_definitions/device-roaming-status.yaml @@ -2,7 +2,7 @@ openapi: 3.0.3 info: title: Device Roaming Status description: | - This API provides the customer with the ability to query device roaming Status + This API provides the API consumer with the ability to query device roaming Status # Introduction @@ -21,7 +21,7 @@ info: ## Relevant terms and definitions * **Device**: A device refers to any physical entity that can connect to a network and participate in network communication. - At least one identifier for the device (user equipment) out of four options: IPv4 address, IPv6 address, Phone number, or Network Access Identifier assigned by the mobile network operator for the device. + At least one identifier for the device (user equipment) out of four options: IPv4 address, IPv6 address, Phone number, or Network Access Identifier (not supported for this API version) assigned by the mobile network operator for the device. * **Roaming** : Roaming status - `true`, if device is in roaming situation - `false` else. @@ -37,14 +37,14 @@ info: The endpoint `POST /retrieve` allows to get roaming status and country information (if device in roaming situation) synchronously. - # Authorization and authentication + ### Authorization and authentication - [Camara Security and Interoperability Profile](https://github.com/camaraproject/IdentityAndConsentManagement/blob/main/documentation/CAMARA-Security-Interoperability.md) provides details on how a client requests an access token. + The "Camara Security and Interoperability Profile" provides details on how a client requests an access token. Please refer to Identify and Consent Management (https://github.com/camaraproject/IdentityAndConsentManagement/) for the released version of the Profile. Which specific authorization flows are to be used will be determined during onboarding process, happening between the API Client and the Telco Operator exposing the API, taking into account the declared purpose for accessing the API, while also being subject to the prevailing legal framework dictated by local legislation. It is important to remark that in cases where personal user data is processed by the API, and users can exercise their rights through mechanisms such as opt-in and/or opt-out, the use of 3-legged access tokens becomes mandatory. This measure ensures that the API remains in strict compliance with user privacy preferences and regulatory obligations, upholding the principles of transparency and user-centric data control. - + # Identifying a device from the access token This specification defines the `device` object field as optional in API requests, specifically in cases where the API is accessed using a 3-legged access token, and the device can be uniquely identified by the token. This approach simplifies API usage for API consumers by relying on the device information associated with the access token used to invoke the API. @@ -76,7 +76,7 @@ info: license: name: Apache 2.0 url: https://www.apache.org/licenses/LICENSE-2.0.html - version: 0.6.0 + version: 0.6.1 x-camara-commonalities: 0.4.0 externalDocs: description: Product documentation at CAMARA