File size: 36,083 Bytes
ab74ec2 | 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 | # application-endpoint-discovery
```yaml
---
openapi: 3.0.3
info:
title: Application Endpoint Discovery
version: wip
description: |
The Application Endpoint Discovery API returns the optimal application
endpoint(s) that a given end-user's device can connect to.
# Introduction
Operators often host multiple Edge Cloud Zones across various territories.
Connecting an application directly to the optimal application instance
endpoint in an Edge Cloud Zone may minimize latency.
The Application Endpoint Discovery API extends beyond the capabilities of
the Simple Edge Discovery API by not only locating the optimal
Edge Cloud Zone but also providing the direct link to the specified
application's endpoint within that Edge Cloud Zone. This approach ensures
that developers can instantly integrate this endpoint into their
applications, improving user experience.
After identifying the optimal application endpoint(s) through the API,
API consumers can:
* Connect their application client directly to the chosen application
endpoint(s), enhancing the responsiveness of the service.
* If no suitable endpoints are available, the developer can use other APIs
to instantiate new instance and/or register new application endpoints.
The optimal endpoint(s) are calculated by the Edge Cloud Provider based on
the following factor: shortest network path to the network-attached
device identified in the API request. Future releases of this API might
add other factors to obtain them.
# Relevant terms and definitions
- `Application Profile:` A profile which represents an application's
networking demands (latency, jitter, bandwidth rates).
- `Application Provider:` The provider of the application that is deployed
on the Edge Cloud.
- `Application Endpoint:` An application server IP address or FQDN, and
port exposed by an application instance to allow connections from clients.
- `Application Instance:` An instantiation of an Application running on
an Edge Cloud Zone. It is assumed that for each application, a maximum of
one logical instance can run per Edge Cloud Zone.
- `Device:` End-user equipment able to connect to a mobile network (i.e.
smartphone, IoT sensor/actuator).
- `Edge Cloud Zone:` Availability Zone in an Edge Cloud. It is the lowest
level of abstraction exposed to an Application Provider who wants to
deploy an Application on Edge Cloud. Availability Zones exist within
a Region.
# API Functionality
The API can be called either by an application client hosted on a device
attached to the operator network (i.e. phone, tablet), or by a server.
There is a single API service endpoint:
- `POST /retrieve-optimal-app-endpoints`
## Inputs
The endpoint request body is a JSON object with the following parameters:
- `device:` End-user equipment able to connect to a mobile network. The
developer can choose to provide the below specified device identifiers:
- `ipv4Address:` Public IP address (IPv4) of the user device, which can be
fetched via external IP discovery services.
- `ipv6Address:` Public IP address (IPv6) of the user device, which can be
fetched via external IP discovery services.
- `phoneNumber:` The device's phone number in international E.164 format.
- `networkAccessIdentifier:` A unique identifier provided by the network
operator (where supported).
- One of the following application identifiers:
- `appId:` A unique identifier for an application onboarded on the Edge
Cloud. It is used when the application has been onboarded using the Edge
Application Management API.
- `applicationEndpointsId:` A unique identifier for the registered
application endpoint(s). It is used when the application has not been onboarded
using the Edge Application Management API, and available endpoints have been
registered by the Edge Application Registration API. Every endpoint registered
under the same `applicationEndpointsId` identifier belongs to the same
application.
## Outputs
If successful, a `200 OK ` response code is returned with a JSON object
containing the following data:
- `applicationEndpoints:` An array containing at least one Application Endpoint
object. Each Application Endpoint object includes the following parameters:
- `port:` TCP or UDP port number exposed by the application instance.
- One of the following parameters which define the endpoint:
- `ipv4addresses:` Array of IPv4 addresses exposed by the application
instance.
- `ipv6addresses:` Array of IPv6 addresses exposed by the application
instance.
- `fqdn:` Fully Qualified Domain Name exposed by the application instance.
- `applicationEndpointDescription:` Optionally, a string that describes the
application endpoint.
- `edgeCloudZone:` Optionally, object that identifies the Edge Cloud Zone
the application endpoint belongs to, including: `edgeCloudZoneId`,
`edgeCloudZoneName`, `edgeCloudZoneStatus`, `edgeCloudRegion`, and
`edgeCloudProvider`.
- One of the following application identifiers (the one provided on the request)
- `appId:` A unique identifier for an application onboarded on the Edge
Cloud. It is used when the application has been onboarded using the Edge
Application Management API.
- `applicationEndpointsId:` A unique identifier for the registered
application endpoint(s). It is used when the application has not been onboarded
using the Edge Application Management API, and available endpoints have been
registered by the Edge Application Registration API. Every endpoint
registered under the same `applicationEndpointsId` identifier belongs to
the same application.
- `applicationServerProviderName:` Optionally, the Application Provider
identifier
- `applicationProfileId:` Optionally, the Application Profile identifier
- `device`: End-user equipment identifier used to obtain the optimal application
endpoint. It is only included when multiple device identifiers come in the
request.
- The `Device` object allows the API consumer to provide more than one device
identifier. No error will be returned when the supplied device identifiers
do not match with the same device. It is responsibility of the API consumer
to ensure that the identifiers they are using are associated with the same
device.
- Where an API consumer provides more than one device identifier, the
response will indicate which of these identifiers have been used to fulfil
the API, even if the identifiers do not match the same device. The
`DeviceResponse` object is defined for this purpose.
## Errors
- If the API call contains a formatting or other any other syntatic error,
a `400 INVALID_ARGUMENT` error is returned.
- If the API call cannot be authenticated due to missing, invalid, or
expired credentials, a `401 UNAUTHENTICATED` error is returned.
- If the API call has a valid access token that does not have the
required scope, then a `403 PERMISSION_DENIED` error is returned.
- If the API call has a valid access token that does not identify
a single device, then a `404 IDENTIFIER_NOT_FOUND` error is returned.
- If the API call has an `appId` that does not identify a valid
application on the Edge Cloud, a `404 NOT_FOUND` error is returned.
- If the API call has an `applicationEndpointsId` that does not identify
any registered endpoint on the Edge Cloud, a `404 NOT_FOUND` error
is returned.
### Additional CAMARA error responses
The list of error codes in this API specification is not exhaustive.
Therefore the API specification may not document some non-mandatory error
statuses as indicated in `CAMARA API Design Guide`.
Please refer to the `CAMARA_common.yaml` of the Commonalities Release
associated to this API version for a complete list of error responses.
The applicable Commonalities Release can be identified in the `API
Readiness Checklist` document associated to this API version.
As a specific rule, error `501 - NOT_IMPLEMENTED` can be only a possible
error response if it is explicitly documented in the API.
# Identifying the device from the access token
This API requires the API consumer to identify a device as the subject of
the API as follows:
- When the API is invoked using a two-legged access token, the subject will
be identified from the optional `device` object, which therefore MUST be
provided.
- When a three-legged access token is used however, this optional
identifier MUST NOT be provided, as the subject will be uniquely
identified from the access token.
This approach simplifies API usage for API consumers using a three-legged
access token to invoke the API by relying on the information that is
associated with the access token and was identified during the
authentication process.
## Error handling:
- If the subject cannot be identified from the access token and the
optional `device` object is not included in the request, then the server
will return an error with the `422 MISSING_IDENTIFIER` error code.
- If the subject can be identified from the access token and the optional
`device` object is also included in the request, then the server will
return an error with the `422 UNNECESSARY_IDENTIFIER` error code.
This will be the case even if the same device is identified by
these two methods, as the server is unable to make this comparison.
- If the subject cannot be identified from the access token and the
optional `device` object only includes device identifiers not supported
by the implementation, then the server will return an error with the
`422 UNSUPPORTED_IDENTIFIER` error code.
- If the service is not applicable for the subject that is identified
from the access token or the optional `device` object, then the server
will return an error code with the `422 SERVICE_NOT_APPLICABLE` error
code.
# Authorization and authentication
The "Camara Security and Interoperability Profile" provides details of how
an API consumer requests an access token. Please refer to
Identity and Consent Management
(https://github.com/camaraproject/IdentityAndConsentManagement/)
for the released version of the profile.
The specific authorization flows to be used will be agreed upon during the
onboarding process, happening between the API consumer and the
API provider, taking into account the declared purpose for accessing the
API, whilst also being subject to the prevailing legal framework dictated
by local legislation.
In cases where personal 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
three-legged access tokens is mandatory. This ensures that the API remains
in compliance with privacy regulations, upholding the principles of
transparency and user-centric privacy-by-design.
---
license:
name: Apache 2.0
url: https://www.apache.org/licenses/LICENSE-2.0.html
x-camara-commonalities: 0.6
externalDocs:
description: Product documentation at CAMARA
url: https://github.com/camaraproject/ApplicationEndpointDiscovery
servers:
- url: "{apiRoot}/application-endpoint-discovery/vwip"
variables:
apiRoot:
default: http://localhost:9091
description: |
API root, defined by the service provider, e.g. `api.example.com` or
`api.example.com/somepath`
tags:
- name: Application Endpoint Discovery
description: |
Find the optimal Application Instance Endpoint(s) to the user device.
paths:
/retrieve-optimal-app-endpoints:
post:
security:
- openId:
- application-endpoint-discovery:app-endpoints:read
operationId: getOptimalAppEndpoints
parameters:
- name: x-correlator
in: header
required: false
description: Correlation id for the different services
schema:
$ref: "#/components/schemas/XCorrelator"
requestBody:
content:
application/json:
schema:
$ref: "#/components/schemas/EndpointDiscoveryInfo"
examples:
Identify Device By 3-Legged Access Token and AppId:
$ref: '#/components/examples/IdentifyDeviceBy3LeggedTokenAppId'
Identify Device By Phone Number and AppId:
$ref: '#/components/examples/IdentifyDeviceByPhoneNumberAppId'
Identify Device By IP Address and ApplicationEndpointsId:
$ref: '#/components/examples/IdentifyDeviceByIPAddressAppEndpointsId'
Identify Device By Multiple Identifiers and AppId:
$ref: '#/components/examples/IdentifyDeviceByMultipleIdentifiersAppId'
responses:
"200":
description: |
Successful response, returning the optimal Application Instance
Endpoint(s) to the user device identified in the request body.
The response will include the endpoint(s) exposed by the Application
Instance(s) with the shortest network path to the end user device
identified in the request. There can be multiple application endpoints
returned in the response and the API consumer can choose the one that best
suits their needs.
headers:
x-correlator:
$ref: "#/components/headers/x-correlator"
content:
application/json:
schema:
$ref: "#/components/schemas/EndpointDiscoveryResult"
"400":
$ref: "#/components/responses/Generic400"
"401":
$ref: "#/components/responses/Generic401"
"403":
$ref: "#/components/responses/Generic403"
"404":
$ref: "#/components/responses/Generic404"
"422":
$ref: "#/components/responses/Generic422"
"429":
$ref: "#/components/responses/Generic429"
tags:
- Application Endpoint Discovery
summary: |
Returns the Endpoint(s) of the optimal Application Instance(s) to the user
device identified in the request.
description: |
On receiving this request, the network will return the endpoint(s)
of the Application Instance(s) with the shortest network path to the
end user device identified in the request.
components:
securitySchemes:
openId:
description: OpenID Provider Configuration Information.
type: openIdConnect
openIdConnectUrl: https://example.com/.well-known/openid-configuration
headers:
x-correlator:
description: Correlation id for the different services
required: false
schema:
$ref: "#/components/schemas/XCorrelator"
schemas:
Device:
description: |
End-user equipment able to connect to a mobile network. Examples of
devices include smartphones or IoT sensors/actuators.
The developer can choose to provide the below specified
device identifiers:
* `ipv4Address`
* `ipv6Address`
* `phoneNumber`
* `networkAccessIdentifier`
NOTE1: the network operator might support only a subset of these
options. The API invoker can provide multiple identifiers to be
compatible across different network operators. In this case the
identifiers MUST belong to the same device.
NOTE2: as for this Commonalities release, we are enforcing that
the networkAccessIdentifier is only part of the schema for
future-proofing, and CAMARA does not currently allow its use.
After the CAMARA meta-release work is concluded and the relevant
issues are resolved, its use will need to be explicitly documented
in the guidelines.
type: object
properties:
phoneNumber:
$ref: "#/components/schemas/PhoneNumber"
networkAccessIdentifier:
$ref: "#/components/schemas/NetworkAccessIdentifier"
ipv4Address:
$ref: "#/components/schemas/DeviceIpv4Addr"
ipv6Address:
$ref: "#/components/schemas/SingleIpv6Addr"
minProperties: 1
DeviceResponse:
description: |
An identifier for the end-user equipment able to connect to the
network that the response refers to. This parameter is only
returned when the API consumer includes the `device` parameter in
their request (i.e. they are using a two-legged access token), and
is relevant when more than one device identifier is specified, as
only one of those device identifiers is allowed in the response.
If the API consumer provides more than one device identifier in
their request, the API provider must return a single identifier
which is the one they are using to fulfil the request, even if the
identifiers do not match the same device. API provider does not
perform any logic to validate/correlate that the indicated device
identifiers match the same device. No error should be returned if
the identifiers are otherwise valid to prevent API consumers
correlating different identifiers with a given end user.
allOf:
- $ref: "#/components/schemas/Device"
- maxProperties: 1
PhoneNumber:
description: |
A public identifier addressing a telephone subscription. In mobile
networks it corresponds to the MSISDN (Mobile Station International
Subscriber Directory Number). In order to be globally unique it has
to be formatted in international format, according to E.164
standard, prefixed with '+'.
type: string
pattern: '^\+[1-9][0-9]{4,14}$'
example: "+123456789"
NetworkAccessIdentifier:
description: |
A public identifier addressing a subscription in a mobile network.
In 3GPP terminology, it corresponds to the GPSI formatted with the
External Identifier ({Local Identifier}@{Domain Identifier}). Unlike
the telephone number, the network access identifier is not subjected
to portability ruling in force, and is individually managed by each
operator.
type: string
example: "123456789@domain.com"
DeviceIpv4Addr:
type: object
description: |
The device should be identified by either the public (observed) IP
address and port as seen by the application server, or the private
(local) and any public (observed) IP addresses in use by the device
(this information can be obtained by various means, for example from
some DNS servers).
If the allocated and observed IP addresses are the same (i.e. NAT is
not in use) then the same address should be specified for both
publicAddress and privateAddress.
If NAT64 is in use, the device should be identified by its
publicAddress and publicPort, or separately by its allocated IPv6
address (field ipv6Address of the Device object)
In all cases, publicAddress must be specified, along with at least
one of either privateAddress or publicPort, dependent upon which is
known. In general, mobile devices cannot be identified by their
public IPv4 address alone.
properties:
publicAddress:
$ref: "#/components/schemas/SingleIpv4Addr"
privateAddress:
$ref: "#/components/schemas/SingleIpv4Addr"
publicPort:
$ref: "#/components/schemas/Port"
anyOf:
- required: [publicAddress, privateAddress]
- required: [publicAddress, publicPort]
example:
publicAddress: "84.125.93.10"
publicPort: 59765
SingleIpv4Addr:
description: A single IPv4 address with no subnet mask
type: string
format: ipv4
example: "84.125.93.10"
Port:
description: TCP or UDP port number
type: integer
minimum: 0
maximum: 65535
SingleIpv6Addr:
description: |
The device should be identified by the observed IPv6 address, or by
any single IPv6 address from within the subnet allocated to the
device (e.g. adding ::0 to the /64 prefix).
type: string
format: ipv6
example: 2001:db8:85a3:8d3:1319:8a2e:370:7344
XCorrelator:
description: Correlation id for the different services
type: string
pattern: ^[a-zA-Z0-9-_:;.\/<>{}]{0,256}$
example: "b4333c46-49c0-4f62-80d7-f0ef930f1c46"
EndpointDiscoveryInfo:
description: |
Element to retrieve the optimal application endpoint(s) for the
identified device.
type: object
anyOf:
- required: [applicationEndpointsId]
- required: [appId]
properties:
device:
$ref: "#/components/schemas/Device"
applicationEndpointsId:
$ref: "#/components/schemas/ApplicationEndpointsId"
appId:
$ref: "#/components/schemas/AppId"
ApplicationEndpointsId:
description: |
A system-defined string identifier representing
one or more registered Application Endpoints that belong
to the same application.
type: string
format: uuid
example: "4d596ac1-7822-4927-a3c5-d72e1f922c94"
AppId:
type: string
format: uuid
description: |
A globally unique identifier associated with the application.
This GUID will have been previously provided by the Edge Cloud Zone
provider.
example: "3fa85f64-5717-4562-b3fc-2c963f66afa6"
EndpointDiscoveryResult:
description: |
Endpoint Discovery result including optimal application endpoint(s)
for the requested identified device.
type: object
required:
- applicationEndpoints
anyOf:
- required: [applicationEndpointsId]
- required: [appId]
properties:
applicationEndpoints:
description: Array of Application Endpoints.
type: array
items:
$ref: "#/components/schemas/ApplicationEndpoint"
minItems: 1
appId:
$ref: "#/components/schemas/AppId"
applicationEndpointsId:
$ref: "#/components/schemas/ApplicationEndpointsId"
applicationServerProviderName:
type: string
description: Unique ID representing the Edge Application Provider
applicationProfileId:
$ref: "#/components/schemas/ApplicationProfileId"
device:
$ref: "#/components/schemas/DeviceResponse"
EdgeCloudZone:
type: object
description: |
An Edge Cloud Zone, uniquely identified by a
combination of the value of the Edge Cloud Zone Id object
and the value of the Edge Cloud Provider
object. This value is used to identify an Edge Cloud zone
between Edge Clouds from different Edge Cloud Providers.
required:
- edgeCloudZoneId
- edgeCloudZoneName
- edgeCloudProvider
properties:
edgeCloudZoneId:
$ref: "#/components/schemas/EdgeCloudZoneId"
edgeCloudZoneName:
$ref: "#/components/schemas/EdgeCloudZoneName"
edgeCloudZoneStatus:
$ref: "#/components/schemas/EdgeCloudZoneStatus"
edgeCloudProvider:
$ref: "#/components/schemas/EdgeCloudProvider"
edgeCloudRegion:
$ref: "#/components/schemas/EdgeCloudRegion"
EdgeCloudZoneId:
description: A unique identifier for the Edge Cloud Zone.
type: string
format: uuid
example: "123e4567-e89b-12d3-a456-426614174000"
EdgeCloudRegion:
description: |
The EdgeCloudProvider's name for the region where the Edge Cloud
Zone is located.
type: string
pattern: ^[A-Za-z0-9]([A-Za-z0-9-]{0,53}[A-Za-z0-9])?$
example: "us-west-1"
EdgeCloudZoneStatus:
description: Status of the Edge Cloud Zone (default is 'unknown')
type: string
enum:
- active
- inactive
- unknown
default: unknown
EdgeCloudProvider:
description: The provider of the Edge Cloud.
type: string
pattern: ^[A-Za-z0-9]([A-Za-z0-9-]{0,53}[A-Za-z0-9])?$
example: "ProviderA"
EdgeCloudZoneName:
description: The name of the Edge Cloud Zone.
type: string
pattern: ^[A-Za-z0-9]([A-Za-z0-9-]{0,53}[A-Za-z0-9])?$
example: "ZoneA"
ApplicationProfileId:
description: A unique identifier for the application profile.
type: string
format: uuid
example: "123e4567-e89b-12d3-a456-426614174000"
ApplicationEndpoint:
type: object
description: |
An application server IP address or FQDN with a port,
exposed by an application instance deployed on the Edge Cloud
provider.
required:
- port
anyOf:
- required: [fqdn]
- required: [ipv4Addresses]
- required: [ipv6Addresses]
properties:
fqdn:
$ref: "#/components/schemas/Fqdn"
ipv4Addresses:
description: Array of IPv4 addresses.
type: array
items:
$ref: "#/components/schemas/Ipv4Address"
minItems: 1
ipv6Addresses:
description: Array of IPv6 addresses.
type: array
items:
$ref: "#/components/schemas/Ipv6Address"
minItems: 1
port:
$ref: "#/components/schemas/Port"
edgeCloudZone:
$ref: "#/components/schemas/EdgeCloudZone"
applicationEndpointDescription:
type: string
description: Description of the application endpoint
Fqdn:
type: string
description: Fully Qualified Domain Name.
Ipv4Address:
type: string
description: |
A single IPv4 address specified in dotted-quad form like 1.2.3.4.
example: "198.51.100.1"
Ipv6Address:
type: string
description: |
A single IPv6 address, following IETF 5952 format like
2001:db8:85a3:8d3:1319:8a2e:370:7344.
example: "2001:db8:85a3::8a2e:370:7334"
ErrorInfo:
type: object
description: Error information
required:
- status
- code
- message
properties:
status:
type: integer
description: HTTP status code returned along with this error response
code:
type: string
description: Code given to this error
message:
type: string
description: Detailed error description
responses:
Generic400:
description: Bad Request
headers:
x-correlator:
$ref: "#/components/headers/x-correlator"
content:
application/json:
schema:
allOf:
- $ref: "#/components/schemas/ErrorInfo"
- type: object
properties:
status:
enum:
- 400
code:
enum:
- INVALID_ARGUMENT
- OUT_OF_RANGE
examples:
GENERIC_400_INVALID_ARGUMENT:
description: Invalid Argument. Generic Syntax Exception
value:
status: 400
code: INVALID_ARGUMENT
message: Client specified an invalid argument, request body or
query param.
GENERIC_400_OUT_OF_RANGE:
description: |
Out of Range. Specific Syntax Exception used when a
given field has a pre-defined range or a invalid filter criteria
combination is requested
value:
status: 400
code: OUT_OF_RANGE
message: Client specified an invalid range.
Generic401:
description: Unauthorized
headers:
x-correlator:
$ref: "#/components/headers/x-correlator"
content:
application/json:
schema:
allOf:
- $ref: "#/components/schemas/ErrorInfo"
- type: object
properties:
status:
enum:
- 401
code:
enum:
- UNAUTHENTICATED
examples:
GENERIC_401_UNAUTHENTICATED:
description: |
Request cannot be authenticated and a new authentication
is required
value:
status: 401
code: UNAUTHENTICATED
message: Request not authenticated due to missing, invalid,
or expired credentials. A new authentication is required.
Generic403:
description: Forbidden
headers:
x-correlator:
$ref: "#/components/headers/x-correlator"
content:
application/json:
schema:
allOf:
- $ref: "#/components/schemas/ErrorInfo"
- type: object
properties:
status:
enum:
- 403
code:
enum:
- PERMISSION_DENIED
- INVALID_TOKEN_CONTEXT
examples:
GENERIC_403_PERMISSION_DENIED:
description: |
Permission denied. OAuth2 token access does not have the
required scope or when the user fails operational security
value:
status: 403
code: PERMISSION_DENIED
message: Client does not have sufficient permissions to
perform this action.
GENERIC_403_INVALID_TOKEN_CONTEXT:
description: |
Reflect some inconsistency between information in
some field of the API and the related OAuth2 Token
value:
status: 403
code: INVALID_TOKEN_CONTEXT
message: "{{field}} is not consistent with access token."
Generic404:
description: Not found
headers:
x-correlator:
$ref: "#/components/headers/x-correlator"
content:
application/json:
schema:
allOf:
- $ref: "#/components/schemas/ErrorInfo"
- type: object
properties:
status:
enum:
- 404
code:
enum:
- NOT_FOUND
- IDENTIFIER_NOT_FOUND
examples:
GENERIC_404_NOT_FOUND:
description: Resource is not found
value:
status: 404
code: NOT_FOUND
message: The specified resource is not found.
GENERIC_404_IDENTIFIER_NOT_FOUND:
description: Some identifier cannot be matched to a device
value:
status: 404
code: IDENTIFIER_NOT_FOUND
message: Device identifier not found.
Generic422:
description: Unprocessable Content
headers:
x-correlator:
$ref: "#/components/headers/x-correlator"
content:
application/json:
schema:
allOf:
- $ref: "#/components/schemas/ErrorInfo"
- type: object
properties:
status:
enum:
- 422
code:
enum:
- SERVICE_NOT_APPLICABLE
- MISSING_IDENTIFIER
- UNSUPPORTED_IDENTIFIER
- UNNECESSARY_IDENTIFIER
examples:
GENERIC_422_SERVICE_NOT_APPLICABLE:
description: Service not applicable for the provided identifier
value:
status: 422
code: SERVICE_NOT_APPLICABLE
message: The service is not available for the provided identifier.
GENERIC_422_MISSING_IDENTIFIER:
description: |
An identifier is not included in the request and the device or phone
number identification cannot be derived from the 3-legged access
token
value:
status: 422
code: MISSING_IDENTIFIER
message: The device cannot be identified.
GENERIC_422_UNSUPPORTED_IDENTIFIER:
description: |
None of the provided identifiers is supported by the implementation
value:
status: 422
code: UNSUPPORTED_IDENTIFIER
message: The identifier provided is not supported.
GENERIC_422_UNNECESSARY_IDENTIFIER:
description: |
An explicit identifier is provided when a device or phone
number has already been identified from the access token
value:
status: 422
code: UNNECESSARY_IDENTIFIER
message: The device is already identified by the access token.
Generic429:
description: Too Many Requests
headers:
x-correlator:
$ref: "#/components/headers/x-correlator"
content:
application/json:
schema:
allOf:
- $ref: "#/components/schemas/ErrorInfo"
- type: object
properties:
status:
enum:
- 429
code:
enum:
- QUOTA_EXCEEDED
- TOO_MANY_REQUESTS
examples:
GENERIC_429_QUOTA_EXCEEDED:
description: Request is rejected due to exceeding a business quota limit
value:
status: 429
code: QUOTA_EXCEEDED
message: Out of resource quota.
GENERIC_429_TOO_MANY_REQUESTS:
description: |
Access to the API has been temporarily blocked due to rate or spike
arrest limits being reached
value:
status: 429
code: TOO_MANY_REQUESTS
message: Rate limit reached.
examples:
IdentifyDeviceBy3LeggedTokenAppId:
description: Empty JSON when device is identified by access token
value:
appId: "3fa85f64-5717-4562-b3fc-2c963f66afa6"
IdentifyDeviceByPhoneNumberAppId:
description: Identifying device by phone number
value:
device:
phoneNumber: "+123456789"
appId: "3fa85f64-5717-4562-b3fc-2c963f66afa6"
IdentifyDeviceByIPAddressAppEndpointsId:
description: Identifying device by IP address
value:
device:
ipv4Address:
publicAddress: "84.125.93.10"
publicPort: 59765
applicationEndpointsId: "4d596ac1-7822-4927-a3c5-d72e1f922c94"
IdentifyDeviceByMultipleIdentifiersAppId:
description: Identifying device by multiple device identifiers
value:
device:
phoneNumber: "+123456789"
ipv4Address:
publicAddress: "84.125.93.10"
publicPort: 59765
networkAccessIdentifier: "123456789@domain.com"
appId: "3fa85f64-5717-4562-b3fc-2c963f66afa6"
```
|