1
+ ---
1
2
openapi : 3.0.3
2
3
info :
3
4
title : Application Endpoints Registration
9
10
10
11
# Introduction
11
12
12
- The API registers the Edge Application Endpoints .
13
+ The API registers the Edge Application Endpoint .
13
14
This information can be used for various use cases like optimal endpoint
14
15
discovery to help end users connect to the most optimal instance of the
15
16
application which is distributed across various Edge Cloud Zones.
30
31
The API provides 4 operations:
31
32
- POST registerApplicationEndpoints: Registers the Application Endpoints
32
33
of a deployed application to a specified edge cloud zone.
33
- - GET getAllRegisteredApplicationEndpoints: Returns endpoint information
34
- for all registered Applications.
34
+ - GET getAllRegisteredApplicationEndpoints: Returns endpoint information for
35
+ all registered Applications.
35
36
- GET getApplicationEndpointsByID: Returns endpoint information for all
36
37
Applications registered to a specified applicationEndpointId.
37
38
- PUT updateApplicationEndpoint: Update registered application endpoint
64
65
65
66
[GSMA Mobile Connect Account Takeover Protection specification]
66
67
(https://www.gsma.com/identity/wp-content/uploads/2022/12/IDY.24-Mobile-
67
- Connect-Account-Takeover-Protection-Definition-and-Technical-Requirements-v2.0.pdf)
68
+ Connect-Account-Takeover-Protection-Definition-and-Technical-Requirements-
69
+ v2.0.pdf)
68
70
was used as source of input for this API. For more about Mobile Connect,
69
71
please see [Mobile Connect website](https://mobileconnect.io/).
70
72
@@ -483,8 +485,8 @@ components:
483
485
value :
484
486
status : 400
485
487
code : INVALID_ARGUMENT
486
- message : Client specified an invalid argument, request
487
- body or query param.
488
+ message : Client specified an invalid argument, request body or
489
+ query param.
488
490
Generic401 :
489
491
description : Unauthorized
490
492
headers :
@@ -500,8 +502,8 @@ components:
500
502
value :
501
503
status : 401
502
504
code : UNAUTHENTICATED
503
- message : Request not authenticated due to missing, invalid,
504
- or expired credentials.
505
+ message : Request not authenticated due to missing, invalid, or
506
+ expired credentials.
505
507
Generic403 :
506
508
description : Forbidden
507
509
headers :
@@ -513,22 +515,23 @@ components:
513
515
$ref : ' #/components/schemas/ErrorInfo'
514
516
examples :
515
517
GENERIC_403_PERMISSION_DENIED :
516
- description : Permission denied. OAuth2 token access does not
517
- have the required scope or when the user fails operational
518
- security
518
+ description : |
519
+ Permission denied. OAuth2 token access does not have the required
520
+ scope or when the user fails operational security
519
521
value :
520
522
status : 403
521
523
code : PERMISSION_DENIED
522
- message : Client does not have sufficient permissions to
523
- perform this action.
524
+ message : Client does not have sufficient permissions to perform
525
+ this action.
524
526
GENERIC_403_INVALID_TOKEN_CONTEXT :
525
- description : Reflect some inconsistency between information in
526
- some field of the API and the related OAuth2 Token
527
+ description : |
528
+ Reflect some inconsistency between information in some field
529
+ of the API and the related OAuth2 Token
527
530
value :
528
531
status : 403
529
532
code : INVALID_TOKEN_CONTEXT
530
- message : applicationProfileId is not consistent with access
531
- token
533
+ message : applicationProfileId is not consistent with
534
+ access token
532
535
Generic404 :
533
536
description : Not found
534
537
headers :
@@ -562,9 +565,10 @@ components:
562
565
code : NOT_SUPPORTED
563
566
message : Service not supported for this applicationProfileId
564
567
UNIDENTIFIABLE_APPLICATION_PROFILE :
565
- description : The Application Profile is not included in the
566
- request and the profile information cannot be derived from
567
- the 3-legged access token
568
+ description : |
569
+ The Application Profile is not included in the request
570
+ and the profile information cannot be derived
571
+ from the 3-legged access token
568
572
value :
569
573
status : 422
570
574
code : UNIDENTIFIABLE_APPLICATION_PROFILE
@@ -597,8 +601,8 @@ components:
597
601
examples :
598
602
GENERIC_503_UNAVAILABLE :
599
603
description : Service is not available.
600
- Temporary situation usually related to maintenance process
601
- in the server side
604
+ Temporary situation usually related to maintenance process in
605
+ the server side
602
606
value :
603
607
status : 503
604
608
code : UNAVAILABLE
0 commit comments