@portpowered/reference-data 0.4.0 → 0.4.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/generated/openapi.json +375 -25
- package/generated/public/docs/for-ai/operations/addEndpointGroupMembers.md +2 -0
- package/generated/public/docs/for-ai/operations/authorizeDevice.md +16 -0
- package/generated/public/docs/for-ai/operations/completeOAuthConsent.md +5 -0
- package/generated/public/docs/for-ai/operations/createFlowNode.md +2 -0
- package/generated/public/docs/for-ai/operations/createOAuthClient.md +5 -0
- package/generated/public/docs/for-ai/operations/createToken.md +4 -0
- package/generated/public/docs/for-ai/operations/createView.md +6 -0
- package/generated/public/docs/for-ai/operations/deleteEndpoint.md +1 -1
- package/generated/public/docs/for-ai/operations/deleteFlowNode.md +2 -0
- package/generated/public/docs/for-ai/operations/deleteRoute.md +1 -1
- package/generated/public/docs/for-ai/operations/deviceAuthorize.md +21 -6
- package/generated/public/docs/for-ai/operations/enumerateEndpoints.md +14 -4
- package/generated/public/docs/for-ai/operations/establishAuthLink.md +2 -0
- package/generated/public/docs/for-ai/operations/establishPlugin.md +5 -0
- package/generated/public/docs/for-ai/operations/evaluateAccessControlRule.md +2 -0
- package/generated/public/docs/for-ai/operations/generateOAuthCode.md +6 -0
- package/generated/public/docs/for-ai/operations/generateToken.md +1 -1
- package/generated/public/docs/for-ai/operations/generateTuyaQrCode.md +3 -0
- package/generated/public/docs/for-ai/operations/getAccessControlRules.md +2 -0
- package/generated/public/docs/for-ai/operations/getEndpointGroup.md +8 -0
- package/generated/public/docs/for-ai/operations/getOAuthAuthorizationServerMetadata.md +19 -1
- package/generated/public/docs/for-ai/operations/getOAuthClient.md +3 -0
- package/generated/public/docs/for-ai/operations/getOpenIDConfiguration.md +12 -1
- package/generated/public/docs/for-ai/operations/getPendingOAuthConsent.md +6 -0
- package/generated/public/docs/for-ai/operations/getView.md +2 -0
- package/generated/public/docs/for-ai/operations/handleGoogleCloudSchedulerWebhook.md +3 -0
- package/generated/public/docs/for-ai/operations/handleOAuthCallback.md +7 -0
- package/generated/public/docs/for-ai/operations/index.md +1 -1
- package/generated/public/docs/for-ai/operations/invalidateToken.md +2 -0
- package/generated/public/docs/for-ai/operations/pluginAuthCodeExchange.md +4 -0
- package/generated/public/docs/for-ai/operations/pluginAuthMultifactorExchange.md +4 -0
- package/generated/public/docs/for-ai/operations/pushToMessageGateway.md +2 -0
- package/generated/public/docs/for-ai/operations/raiseAnonymousPrincipal.md +17 -0
- package/generated/public/docs/for-ai/operations/refreshAuthLinkToken.md +2 -0
- package/generated/public/docs/for-ai/operations/registerDynamicOAuthClient.md +9 -0
- package/generated/public/docs/for-ai/operations/removeEndpointGroupMembers.md +2 -0
- package/generated/public/docs/for-ai/operations/revokeOAuthGrant.md +3 -0
- package/generated/public/docs/for-ai/operations/setEndpointGroupName.md +4 -0
- package/generated/public/docs/for-ai/operations/synchronizeRoutes.md +2 -0
- package/generated/public/docs/for-ai/operations/updateOAuthClient.md +2 -0
- package/generated/public/docs/for-ai/operations/updateView.md +6 -0
- package/generated/public/docs/for-ai/operations/upsertAccessControlRule.md +5 -0
- package/generated/public/docs/for-ai/operations/upsertAuthLink.md +6 -0
- package/generated/public/docs/for-ai/operations/upsertEndpoint.md +6 -0
- package/generated/public/docs/for-ai/operations/upsertPluginRequest.md +2 -0
- package/generated/public/docs/for-ai/operations/upsertPrincipal.md +2 -0
- package/generated/public/docs/for-ai/operations/upsertRoute.md +4 -0
- package/generated/public/docs/for-ai/operations/upsertSecret.md +6 -0
- package/generated/public/docs/for-ai/operations/upsertSimulator.md +4 -0
- package/generated/public/docs/for-ai/operations/validateOAuthRequest.md +6 -0
- package/generated/public/docs/for-ai/operations/validateTuyaLoginCode.md +4 -0
- package/generated/public/docs/for-ai/operations/verifyDevice.md +11 -0
- package/generated/public/docs/references/authorization.json +2 -2
- package/generated/public/docs/references/authorization.yaml +2 -2
- package/generated/public/docs/references/manifest.json +108 -108
- package/generated/public/docs/references/openapi.yaml +282 -23
- package/package.json +1 -1
package/generated/openapi.json
CHANGED
|
@@ -332,7 +332,22 @@
|
|
|
332
332
|
}
|
|
333
333
|
},
|
|
334
334
|
"example": {
|
|
335
|
-
"
|
|
335
|
+
"issuer": "https://portos-pilot-api-685761720421.us-west1.run.app",
|
|
336
|
+
"jwks_uri": "https://portos-pilot-api-685761720421.us-west1.run.app/.well-known/jwks.json",
|
|
337
|
+
"token_endpoint": "https://portos-pilot-api-685761720421.us-west1.run.app/auth/token",
|
|
338
|
+
"response_types_supported": [
|
|
339
|
+
"code"
|
|
340
|
+
],
|
|
341
|
+
"subject_types_supported": [
|
|
342
|
+
"public"
|
|
343
|
+
],
|
|
344
|
+
"id_token_signing_alg_values_supported": [
|
|
345
|
+
"RS256"
|
|
346
|
+
],
|
|
347
|
+
"grant_types_supported": [
|
|
348
|
+
"authorization_code",
|
|
349
|
+
"refresh_token"
|
|
350
|
+
]
|
|
336
351
|
}
|
|
337
352
|
}
|
|
338
353
|
}
|
|
@@ -364,7 +379,6 @@
|
|
|
364
379
|
"issuer",
|
|
365
380
|
"authorization_endpoint",
|
|
366
381
|
"token_endpoint",
|
|
367
|
-
"registration_endpoint",
|
|
368
382
|
"revocation_endpoint",
|
|
369
383
|
"scopes_supported"
|
|
370
384
|
],
|
|
@@ -383,7 +397,8 @@
|
|
|
383
397
|
},
|
|
384
398
|
"registration_endpoint": {
|
|
385
399
|
"type": "string",
|
|
386
|
-
"format": "uri"
|
|
400
|
+
"format": "uri",
|
|
401
|
+
"description": "Advertised when new anonymous registration is enabled; omitted when disabled."
|
|
387
402
|
},
|
|
388
403
|
"revocation_endpoint": {
|
|
389
404
|
"type": "string",
|
|
@@ -421,6 +436,28 @@
|
|
|
421
436
|
"type": "boolean"
|
|
422
437
|
}
|
|
423
438
|
}
|
|
439
|
+
},
|
|
440
|
+
"example": {
|
|
441
|
+
"issuer": "https://portos-pilot-api-685761720421.us-west1.run.app",
|
|
442
|
+
"authorization_endpoint": "https://portos-pilot-api-685761720421.us-west1.run.app/oauth/authorize",
|
|
443
|
+
"token_endpoint": "https://portos-pilot-api-685761720421.us-west1.run.app/auth/token",
|
|
444
|
+
"revocation_endpoint": "https://portos-pilot-api-685761720421.us-west1.run.app/auth/revoke",
|
|
445
|
+
"scopes_supported": [
|
|
446
|
+
"endpoint:read",
|
|
447
|
+
"message:send"
|
|
448
|
+
],
|
|
449
|
+
"registration_endpoint": "https://portos-pilot-api-685761720421.us-west1.run.app/oauth/register",
|
|
450
|
+
"jwks_uri": "https://portos-pilot-api-685761720421.us-west1.run.app/.well-known/jwks.json",
|
|
451
|
+
"code_challenge_methods_supported": [
|
|
452
|
+
"S256"
|
|
453
|
+
],
|
|
454
|
+
"token_endpoint_auth_methods_supported": [
|
|
455
|
+
"none",
|
|
456
|
+
"client_secret_post",
|
|
457
|
+
"client_secret_basic"
|
|
458
|
+
],
|
|
459
|
+
"client_id_metadata_document_supported": true,
|
|
460
|
+
"authorization_response_iss_parameter_supported": true
|
|
424
461
|
}
|
|
425
462
|
}
|
|
426
463
|
}
|
|
@@ -661,7 +698,7 @@
|
|
|
661
698
|
"value": "~caller"
|
|
662
699
|
},
|
|
663
700
|
"check-id": {
|
|
664
|
-
"value": "port1/
|
|
701
|
+
"value": "port1/principals/example"
|
|
665
702
|
}
|
|
666
703
|
}
|
|
667
704
|
},
|
|
@@ -675,7 +712,7 @@
|
|
|
675
712
|
},
|
|
676
713
|
"examples": {
|
|
677
714
|
"endpoint-id": {
|
|
678
|
-
"value": "port1/
|
|
715
|
+
"value": "port1/principals/example/endpoints/light-1"
|
|
679
716
|
}
|
|
680
717
|
}
|
|
681
718
|
},
|
|
@@ -689,7 +726,7 @@
|
|
|
689
726
|
},
|
|
690
727
|
"examples": {
|
|
691
728
|
"type-filter": {
|
|
692
|
-
"value": "
|
|
729
|
+
"value": "LIGHT"
|
|
693
730
|
}
|
|
694
731
|
}
|
|
695
732
|
},
|
|
@@ -717,7 +754,7 @@
|
|
|
717
754
|
},
|
|
718
755
|
"examples": {
|
|
719
756
|
"next-token": {
|
|
720
|
-
"value": "
|
|
757
|
+
"value": "OPAQUE_TOKEN_FROM_PREVIOUS_RESPONSE"
|
|
721
758
|
}
|
|
722
759
|
}
|
|
723
760
|
},
|
|
@@ -777,7 +814,22 @@
|
|
|
777
814
|
"schema": {
|
|
778
815
|
"$ref": "#/components/schemas/EndpointQueryResponse"
|
|
779
816
|
},
|
|
780
|
-
"examples": {}
|
|
817
|
+
"examples": {},
|
|
818
|
+
"example": {
|
|
819
|
+
"results": [
|
|
820
|
+
{
|
|
821
|
+
"id": "port1/principals/example/endpoints/light-1",
|
|
822
|
+
"name": {
|
|
823
|
+
"type": "PLAIN",
|
|
824
|
+
"value": "Office light"
|
|
825
|
+
},
|
|
826
|
+
"type": "LIGHT",
|
|
827
|
+
"interfaces": [],
|
|
828
|
+
"ownerId": "port1/principals/example",
|
|
829
|
+
"enablement": "ENABLED"
|
|
830
|
+
}
|
|
831
|
+
]
|
|
832
|
+
}
|
|
781
833
|
}
|
|
782
834
|
}
|
|
783
835
|
},
|
|
@@ -855,6 +907,14 @@
|
|
|
855
907
|
"application/json": {
|
|
856
908
|
"schema": {
|
|
857
909
|
"$ref": "#/components/schemas/UpsertEndpointRequest"
|
|
910
|
+
},
|
|
911
|
+
"example": {
|
|
912
|
+
"id": "port1/principals/example/endpoints/light-1",
|
|
913
|
+
"name": {
|
|
914
|
+
"type": "PLAIN",
|
|
915
|
+
"value": "Office light"
|
|
916
|
+
},
|
|
917
|
+
"type": "LIGHT"
|
|
858
918
|
}
|
|
859
919
|
}
|
|
860
920
|
}
|
|
@@ -958,7 +1018,7 @@
|
|
|
958
1018
|
"$ref": "#/components/schemas/DeleteEndpointRequest"
|
|
959
1019
|
},
|
|
960
1020
|
"example": {
|
|
961
|
-
"id": "port1/principals/
|
|
1021
|
+
"id": "port1/principals/example/endpoints/light-1"
|
|
962
1022
|
}
|
|
963
1023
|
}
|
|
964
1024
|
}
|
|
@@ -2135,6 +2195,11 @@
|
|
|
2135
2195
|
"application/json": {
|
|
2136
2196
|
"schema": {
|
|
2137
2197
|
"$ref": "#/components/schemas/Simulator"
|
|
2198
|
+
},
|
|
2199
|
+
"example": {
|
|
2200
|
+
"device_type": "light",
|
|
2201
|
+
"id": "port1.simulator.example",
|
|
2202
|
+
"name": "Example device"
|
|
2138
2203
|
}
|
|
2139
2204
|
},
|
|
2140
2205
|
"application/vnd.portos.simulator.v2+json": {
|
|
@@ -2677,7 +2742,7 @@
|
|
|
2677
2742
|
"$ref": "#/components/schemas/DeleteRouteRequest"
|
|
2678
2743
|
},
|
|
2679
2744
|
"example": {
|
|
2680
|
-
"id": "port1/principals/
|
|
2745
|
+
"id": "port1/principals/example/routes/light-route"
|
|
2681
2746
|
}
|
|
2682
2747
|
}
|
|
2683
2748
|
}
|
|
@@ -2718,6 +2783,11 @@
|
|
|
2718
2783
|
"application/json": {
|
|
2719
2784
|
"schema": {
|
|
2720
2785
|
"$ref": "#/components/schemas/UpsertRouteRequest"
|
|
2786
|
+
},
|
|
2787
|
+
"example": {
|
|
2788
|
+
"id": "port1/principals/example/routes/light-route",
|
|
2789
|
+
"endpointId": "port1/principals/example/endpoints/light-1",
|
|
2790
|
+
"pluginId": "port1/systems/zero/plugins/example"
|
|
2721
2791
|
}
|
|
2722
2792
|
}
|
|
2723
2793
|
}
|
|
@@ -2766,6 +2836,9 @@
|
|
|
2766
2836
|
"application/json": {
|
|
2767
2837
|
"schema": {
|
|
2768
2838
|
"$ref": "#/components/schemas/SynchronizationRequest"
|
|
2839
|
+
},
|
|
2840
|
+
"example": {
|
|
2841
|
+
"routes": []
|
|
2769
2842
|
}
|
|
2770
2843
|
}
|
|
2771
2844
|
}
|
|
@@ -2981,6 +3054,9 @@
|
|
|
2981
3054
|
"application/json": {
|
|
2982
3055
|
"schema": {
|
|
2983
3056
|
"$ref": "#/components/schemas/UpsertPluginResponse"
|
|
3057
|
+
},
|
|
3058
|
+
"example": {
|
|
3059
|
+
"id": "port1/principals/example/plugins/example"
|
|
2984
3060
|
}
|
|
2985
3061
|
}
|
|
2986
3062
|
}
|
|
@@ -3064,6 +3140,11 @@
|
|
|
3064
3140
|
"application/json": {
|
|
3065
3141
|
"schema": {
|
|
3066
3142
|
"$ref": "#/components/schemas/EstablishPluginRequest"
|
|
3143
|
+
},
|
|
3144
|
+
"example": {
|
|
3145
|
+
"plugin": {
|
|
3146
|
+
"type": "LIGHT"
|
|
3147
|
+
}
|
|
3067
3148
|
}
|
|
3068
3149
|
}
|
|
3069
3150
|
}
|
|
@@ -3075,6 +3156,9 @@
|
|
|
3075
3156
|
"application/json": {
|
|
3076
3157
|
"schema": {
|
|
3077
3158
|
"$ref": "#/components/schemas/EstablishPluginResponse"
|
|
3159
|
+
},
|
|
3160
|
+
"example": {
|
|
3161
|
+
"pluginId": "port1/principals/example"
|
|
3078
3162
|
}
|
|
3079
3163
|
}
|
|
3080
3164
|
}
|
|
@@ -3227,6 +3311,17 @@
|
|
|
3227
3311
|
"application/json": {
|
|
3228
3312
|
"schema": {
|
|
3229
3313
|
"$ref": "#/components/schemas/UpsertAuthLinkRequest"
|
|
3314
|
+
},
|
|
3315
|
+
"example": {
|
|
3316
|
+
"authLink": {
|
|
3317
|
+
"associatedPrincipalId": "port1/principals/example",
|
|
3318
|
+
"associatedPluginId": "port1/systems/zero/plugins/example",
|
|
3319
|
+
"associatedSecrets": [
|
|
3320
|
+
{
|
|
3321
|
+
"id": "port1/principals/example/secrets/plugin-credential"
|
|
3322
|
+
}
|
|
3323
|
+
]
|
|
3324
|
+
}
|
|
3230
3325
|
}
|
|
3231
3326
|
}
|
|
3232
3327
|
}
|
|
@@ -3324,6 +3419,9 @@
|
|
|
3324
3419
|
"application/json": {
|
|
3325
3420
|
"schema": {
|
|
3326
3421
|
"$ref": "#/components/schemas/EstablishAuthLinkRequest"
|
|
3422
|
+
},
|
|
3423
|
+
"example": {
|
|
3424
|
+
"pluginId": "port1/principals/example"
|
|
3327
3425
|
}
|
|
3328
3426
|
}
|
|
3329
3427
|
}
|
|
@@ -3431,6 +3529,9 @@
|
|
|
3431
3529
|
"description": "The ID of the auth link to refresh tokens for"
|
|
3432
3530
|
}
|
|
3433
3531
|
}
|
|
3532
|
+
},
|
|
3533
|
+
"example": {
|
|
3534
|
+
"authLinkId": "port1/principals/example"
|
|
3434
3535
|
}
|
|
3435
3536
|
}
|
|
3436
3537
|
}
|
|
@@ -3463,6 +3564,11 @@
|
|
|
3463
3564
|
"application/json": {
|
|
3464
3565
|
"schema": {
|
|
3465
3566
|
"$ref": "#/components/schemas/PluginAuthMultifactorExchangeRequest"
|
|
3567
|
+
},
|
|
3568
|
+
"example": {
|
|
3569
|
+
"pluginId": "port1/principals/example",
|
|
3570
|
+
"principalId": "port1/principals/example",
|
|
3571
|
+
"pluginAuthenticationData": {}
|
|
3466
3572
|
}
|
|
3467
3573
|
}
|
|
3468
3574
|
}
|
|
@@ -3503,6 +3609,11 @@
|
|
|
3503
3609
|
"application/json": {
|
|
3504
3610
|
"schema": {
|
|
3505
3611
|
"$ref": "#/components/schemas/PluginAuthCodeExchangeRequest"
|
|
3612
|
+
},
|
|
3613
|
+
"example": {
|
|
3614
|
+
"pluginId": "port1/principals/example",
|
|
3615
|
+
"principalId": "port1/principals/example",
|
|
3616
|
+
"pluginAuthenticationData": {}
|
|
3506
3617
|
}
|
|
3507
3618
|
}
|
|
3508
3619
|
}
|
|
@@ -4364,6 +4475,12 @@
|
|
|
4364
4475
|
"application/json": {
|
|
4365
4476
|
"schema": {
|
|
4366
4477
|
"$ref": "#/components/schemas/SetEndpointGroupNameRequest"
|
|
4478
|
+
},
|
|
4479
|
+
"example": {
|
|
4480
|
+
"name": {
|
|
4481
|
+
"type": "LIGHT",
|
|
4482
|
+
"value": "port1/principals/example"
|
|
4483
|
+
}
|
|
4367
4484
|
}
|
|
4368
4485
|
}
|
|
4369
4486
|
}
|
|
@@ -4590,6 +4707,16 @@
|
|
|
4590
4707
|
"application/json": {
|
|
4591
4708
|
"schema": {
|
|
4592
4709
|
"$ref": "#/components/schemas/EndpointGroup"
|
|
4710
|
+
},
|
|
4711
|
+
"example": {
|
|
4712
|
+
"id": "port1/principals/example/endpoint-groups/living-room",
|
|
4713
|
+
"name": {
|
|
4714
|
+
"type": "LIGHT",
|
|
4715
|
+
"value": "port1/principals/example"
|
|
4716
|
+
},
|
|
4717
|
+
"ownerId": "port1/principals/example",
|
|
4718
|
+
"interfaces": [],
|
|
4719
|
+
"etag": "\"12\""
|
|
4593
4720
|
}
|
|
4594
4721
|
}
|
|
4595
4722
|
}
|
|
@@ -4900,6 +5027,9 @@
|
|
|
4900
5027
|
"application/json": {
|
|
4901
5028
|
"schema": {
|
|
4902
5029
|
"$ref": "#/components/schemas/AddEndpointGroupMembersRequest"
|
|
5030
|
+
},
|
|
5031
|
+
"example": {
|
|
5032
|
+
"memberEndpointIds": []
|
|
4903
5033
|
}
|
|
4904
5034
|
}
|
|
4905
5035
|
}
|
|
@@ -5083,6 +5213,9 @@
|
|
|
5083
5213
|
"application/json": {
|
|
5084
5214
|
"schema": {
|
|
5085
5215
|
"$ref": "#/components/schemas/RemoveEndpointGroupMembersRequest"
|
|
5216
|
+
},
|
|
5217
|
+
"example": {
|
|
5218
|
+
"memberEndpointIds": []
|
|
5086
5219
|
}
|
|
5087
5220
|
}
|
|
5088
5221
|
}
|
|
@@ -5513,6 +5646,12 @@
|
|
|
5513
5646
|
"application/json": {
|
|
5514
5647
|
"schema": {
|
|
5515
5648
|
"$ref": "#/components/schemas/UpsertAccessControlRuleRequest"
|
|
5649
|
+
},
|
|
5650
|
+
"example": {
|
|
5651
|
+
"operation": "port1/principals/example",
|
|
5652
|
+
"resource": "port1/users/alice/endpoints/thermostat-zero",
|
|
5653
|
+
"identity": "port1/account/john/users/alice",
|
|
5654
|
+
"effect": "ALLOW"
|
|
5516
5655
|
}
|
|
5517
5656
|
}
|
|
5518
5657
|
}
|
|
@@ -5643,6 +5782,9 @@
|
|
|
5643
5782
|
"application/json": {
|
|
5644
5783
|
"schema": {
|
|
5645
5784
|
"$ref": "#/components/schemas/GetAccessControlRulesResponse"
|
|
5785
|
+
},
|
|
5786
|
+
"example": {
|
|
5787
|
+
"results": []
|
|
5646
5788
|
}
|
|
5647
5789
|
}
|
|
5648
5790
|
}
|
|
@@ -5689,6 +5831,9 @@
|
|
|
5689
5831
|
"application/json": {
|
|
5690
5832
|
"schema": {
|
|
5691
5833
|
"$ref": "#/components/schemas/EvaluateAccessControlRuleRequest"
|
|
5834
|
+
},
|
|
5835
|
+
"example": {
|
|
5836
|
+
"requests": "port1/principals/example"
|
|
5692
5837
|
}
|
|
5693
5838
|
}
|
|
5694
5839
|
}
|
|
@@ -5917,6 +6062,14 @@
|
|
|
5917
6062
|
"application/json": {
|
|
5918
6063
|
"schema": {
|
|
5919
6064
|
"$ref": "#/components/schemas/UpsertSecretRequest"
|
|
6065
|
+
},
|
|
6066
|
+
"example": {
|
|
6067
|
+
"secret": {
|
|
6068
|
+
"id": "port1/principals/example",
|
|
6069
|
+
"type": "LIGHT",
|
|
6070
|
+
"clientId": "port1/principals/example",
|
|
6071
|
+
"clientSecret": "port1/principals/example"
|
|
6072
|
+
}
|
|
5920
6073
|
}
|
|
5921
6074
|
}
|
|
5922
6075
|
}
|
|
@@ -6128,6 +6281,9 @@
|
|
|
6128
6281
|
"application/json": {
|
|
6129
6282
|
"schema": {
|
|
6130
6283
|
"$ref": "#/components/schemas/UpsertPrincipalRequest"
|
|
6284
|
+
},
|
|
6285
|
+
"example": {
|
|
6286
|
+
"items": "port1/principals/example"
|
|
6131
6287
|
}
|
|
6132
6288
|
}
|
|
6133
6289
|
}
|
|
@@ -6242,7 +6398,7 @@
|
|
|
6242
6398
|
"redirect_uri": "http://127.0.0.1:8765/callback",
|
|
6243
6399
|
"code": "CALLBACK_CODE",
|
|
6244
6400
|
"code_verifier": "ORIGINAL_RANDOM_PKCE_VERIFIER",
|
|
6245
|
-
"resource": "https://api.
|
|
6401
|
+
"resource": "https://portos-pilot-api-685761720421.us-west1.run.app"
|
|
6246
6402
|
}
|
|
6247
6403
|
}
|
|
6248
6404
|
}
|
|
@@ -6306,6 +6462,10 @@
|
|
|
6306
6462
|
"type": "string"
|
|
6307
6463
|
}
|
|
6308
6464
|
}
|
|
6465
|
+
},
|
|
6466
|
+
"example": {
|
|
6467
|
+
"token": "port1/principals/example",
|
|
6468
|
+
"client_id": "dcr_example"
|
|
6309
6469
|
}
|
|
6310
6470
|
}
|
|
6311
6471
|
}
|
|
@@ -6493,6 +6653,11 @@
|
|
|
6493
6653
|
"application/json": {
|
|
6494
6654
|
"schema": {
|
|
6495
6655
|
"$ref": "#/components/schemas/CreateTokenResponse"
|
|
6656
|
+
},
|
|
6657
|
+
"example": {
|
|
6658
|
+
"id": "port1/principals/example",
|
|
6659
|
+
"token": "port1/principals/example",
|
|
6660
|
+
"expires_at": "2026-10-08T12:00:00Z"
|
|
6496
6661
|
}
|
|
6497
6662
|
}
|
|
6498
6663
|
}
|
|
@@ -6574,6 +6739,9 @@
|
|
|
6574
6739
|
"application/json": {
|
|
6575
6740
|
"schema": {
|
|
6576
6741
|
"$ref": "#/components/schemas/InvalidateTokenResponse"
|
|
6742
|
+
},
|
|
6743
|
+
"example": {
|
|
6744
|
+
"message": "The request could not be completed. Check the supplied parameters and try again."
|
|
6577
6745
|
}
|
|
6578
6746
|
}
|
|
6579
6747
|
}
|
|
@@ -6637,6 +6805,11 @@
|
|
|
6637
6805
|
"description": "Token type identifier. Must be urn:ietf:params:oauth:token-type:id_token\n"
|
|
6638
6806
|
}
|
|
6639
6807
|
}
|
|
6808
|
+
},
|
|
6809
|
+
"example": {
|
|
6810
|
+
"anonymous_refresh_token": "port1/principals/example",
|
|
6811
|
+
"subject_token": "port1/principals/example",
|
|
6812
|
+
"subject_token_type": "port1/principals/example"
|
|
6640
6813
|
}
|
|
6641
6814
|
}
|
|
6642
6815
|
}
|
|
@@ -6648,6 +6821,11 @@
|
|
|
6648
6821
|
"application/json": {
|
|
6649
6822
|
"schema": {
|
|
6650
6823
|
"$ref": "#/components/schemas/GenerateTokenResponse"
|
|
6824
|
+
},
|
|
6825
|
+
"example": {
|
|
6826
|
+
"access_token": "port1/principals/example",
|
|
6827
|
+
"token_type": "port1/principals/example",
|
|
6828
|
+
"expires_in": 1
|
|
6651
6829
|
}
|
|
6652
6830
|
}
|
|
6653
6831
|
}
|
|
@@ -6658,6 +6836,10 @@
|
|
|
6658
6836
|
"application/json": {
|
|
6659
6837
|
"schema": {
|
|
6660
6838
|
"$ref": "#/components/schemas/OAuthErrorResponse"
|
|
6839
|
+
},
|
|
6840
|
+
"example": {
|
|
6841
|
+
"error": "invalid_request",
|
|
6842
|
+
"error_description": "user_code is required"
|
|
6661
6843
|
}
|
|
6662
6844
|
}
|
|
6663
6845
|
}
|
|
@@ -6668,6 +6850,10 @@
|
|
|
6668
6850
|
"application/json": {
|
|
6669
6851
|
"schema": {
|
|
6670
6852
|
"$ref": "#/components/schemas/OAuthErrorResponse"
|
|
6853
|
+
},
|
|
6854
|
+
"example": {
|
|
6855
|
+
"error": "invalid_request",
|
|
6856
|
+
"error_description": "user_code is required"
|
|
6671
6857
|
}
|
|
6672
6858
|
}
|
|
6673
6859
|
}
|
|
@@ -6678,6 +6864,10 @@
|
|
|
6678
6864
|
"application/json": {
|
|
6679
6865
|
"schema": {
|
|
6680
6866
|
"$ref": "#/components/schemas/OAuthErrorResponse"
|
|
6867
|
+
},
|
|
6868
|
+
"example": {
|
|
6869
|
+
"error": "invalid_request",
|
|
6870
|
+
"error_description": "user_code is required"
|
|
6681
6871
|
}
|
|
6682
6872
|
}
|
|
6683
6873
|
}
|
|
@@ -6734,6 +6924,11 @@
|
|
|
6734
6924
|
"application/json": {
|
|
6735
6925
|
"schema": {
|
|
6736
6926
|
"$ref": "#/components/schemas/GenerateTokenResponse"
|
|
6927
|
+
},
|
|
6928
|
+
"example": {
|
|
6929
|
+
"access_token": "port1/principals/example",
|
|
6930
|
+
"token_type": "port1/principals/example",
|
|
6931
|
+
"expires_in": 1
|
|
6737
6932
|
}
|
|
6738
6933
|
}
|
|
6739
6934
|
}
|
|
@@ -6744,6 +6939,10 @@
|
|
|
6744
6939
|
"application/json": {
|
|
6745
6940
|
"schema": {
|
|
6746
6941
|
"$ref": "#/components/schemas/OAuthErrorResponse"
|
|
6942
|
+
},
|
|
6943
|
+
"example": {
|
|
6944
|
+
"error": "invalid_request",
|
|
6945
|
+
"error_description": "user_code is required"
|
|
6747
6946
|
}
|
|
6748
6947
|
}
|
|
6749
6948
|
}
|
|
@@ -6753,13 +6952,13 @@
|
|
|
6753
6952
|
"x-portos-resource-permission": false
|
|
6754
6953
|
}
|
|
6755
6954
|
},
|
|
6756
|
-
"/auth/
|
|
6955
|
+
"/auth/device-authorization": {
|
|
6757
6956
|
"post": {
|
|
6758
6957
|
"tags": [
|
|
6759
6958
|
"Auth"
|
|
6760
6959
|
],
|
|
6761
6960
|
"summary": "OAuth2 Device Authorization",
|
|
6762
|
-
"description": "This API is used by your device to obtain authorization from the resource owner via a device code or QR code that your device can scan.\n\nSee the [OAuth device authorization docs for more](https://datatracker.ietf.org/doc/html/rfc8628).\n\n\nUses the existing managed-client device flow. This endpoint is public, but validates its client and supported device grant; anonymous DCR clients support authorization_code and optional refresh_token, and cannot start the device flow.",
|
|
6961
|
+
"description": "This API is used by your device to obtain authorization from the resource owner via a device code or QR code that your device can scan.\n\nSee the [OAuth device authorization docs for more](https://datatracker.ietf.org/doc/html/rfc8628).\n\n\nUses the existing managed-client device flow. This endpoint is public, but validates its client and supported device grant; anonymous DCR clients support authorization_code and optional refresh_token, and cannot start the device flow. The legacy /auth/device_authorization path remains a compatibility alias.",
|
|
6763
6962
|
"operationId": "deviceAuthorize",
|
|
6764
6963
|
"security": [
|
|
6765
6964
|
{}
|
|
@@ -6770,6 +6969,9 @@
|
|
|
6770
6969
|
"application/x-www-form-urlencoded": {
|
|
6771
6970
|
"schema": {
|
|
6772
6971
|
"$ref": "#/components/schemas/DeviceAuthorizationRequest"
|
|
6972
|
+
},
|
|
6973
|
+
"example": {
|
|
6974
|
+
"client_id": "dcr_example"
|
|
6773
6975
|
}
|
|
6774
6976
|
}
|
|
6775
6977
|
}
|
|
@@ -6781,6 +6983,13 @@
|
|
|
6781
6983
|
"application/json": {
|
|
6782
6984
|
"schema": {
|
|
6783
6985
|
"$ref": "#/components/schemas/DeviceAuthorizationResponse"
|
|
6986
|
+
},
|
|
6987
|
+
"example": {
|
|
6988
|
+
"device_code": "port1/principals/example",
|
|
6989
|
+
"user_code": "port1/principals/example",
|
|
6990
|
+
"verification_uri": "https://portpowered.com/oauth/device/verify",
|
|
6991
|
+
"expires_in": 1800,
|
|
6992
|
+
"interval": 5
|
|
6784
6993
|
}
|
|
6785
6994
|
}
|
|
6786
6995
|
}
|
|
@@ -6791,6 +7000,10 @@
|
|
|
6791
7000
|
"application/json": {
|
|
6792
7001
|
"schema": {
|
|
6793
7002
|
"$ref": "#/components/schemas/OAuthErrorResponse"
|
|
7003
|
+
},
|
|
7004
|
+
"example": {
|
|
7005
|
+
"error": "invalid_request",
|
|
7006
|
+
"error_description": "user_code is required"
|
|
6794
7007
|
}
|
|
6795
7008
|
}
|
|
6796
7009
|
}
|
|
@@ -6801,6 +7014,10 @@
|
|
|
6801
7014
|
"application/json": {
|
|
6802
7015
|
"schema": {
|
|
6803
7016
|
"$ref": "#/components/schemas/OAuthErrorResponse"
|
|
7017
|
+
},
|
|
7018
|
+
"example": {
|
|
7019
|
+
"error": "invalid_request",
|
|
7020
|
+
"error_description": "user_code is required"
|
|
6804
7021
|
}
|
|
6805
7022
|
}
|
|
6806
7023
|
}
|
|
@@ -6947,6 +7164,9 @@
|
|
|
6947
7164
|
"application/json": {
|
|
6948
7165
|
"schema": {
|
|
6949
7166
|
"$ref": "#/components/schemas/OAuthClientRegistrationRequest"
|
|
7167
|
+
},
|
|
7168
|
+
"example": {
|
|
7169
|
+
"clientName": "port1/principals/example"
|
|
6950
7170
|
}
|
|
6951
7171
|
}
|
|
6952
7172
|
}
|
|
@@ -6958,6 +7178,10 @@
|
|
|
6958
7178
|
"application/json": {
|
|
6959
7179
|
"schema": {
|
|
6960
7180
|
"$ref": "#/components/schemas/CreateOAuthClientResponse"
|
|
7181
|
+
},
|
|
7182
|
+
"example": {
|
|
7183
|
+
"clientId": "port1/principals/example",
|
|
7184
|
+
"clientSecret": "port1/principals/example"
|
|
6961
7185
|
}
|
|
6962
7186
|
}
|
|
6963
7187
|
}
|
|
@@ -7048,6 +7272,10 @@
|
|
|
7048
7272
|
"application/json": {
|
|
7049
7273
|
"schema": {
|
|
7050
7274
|
"$ref": "#/components/schemas/OAuthClient"
|
|
7275
|
+
},
|
|
7276
|
+
"example": {
|
|
7277
|
+
"clientId": "port1/systems/zero/oauth-clients/1234567890",
|
|
7278
|
+
"clientName": "port1/principals/example"
|
|
7051
7279
|
}
|
|
7052
7280
|
}
|
|
7053
7281
|
}
|
|
@@ -7186,6 +7414,9 @@
|
|
|
7186
7414
|
"application/json": {
|
|
7187
7415
|
"schema": {
|
|
7188
7416
|
"$ref": "#/components/schemas/UpdateOAuthClientResponse"
|
|
7417
|
+
},
|
|
7418
|
+
"example": {
|
|
7419
|
+
"clientId": "port1/principals/example"
|
|
7189
7420
|
}
|
|
7190
7421
|
}
|
|
7191
7422
|
}
|
|
@@ -7292,6 +7523,10 @@
|
|
|
7292
7523
|
"application/json": {
|
|
7293
7524
|
"schema": {
|
|
7294
7525
|
"$ref": "#/components/schemas/GenerateOAuthCodeRequest"
|
|
7526
|
+
},
|
|
7527
|
+
"example": {
|
|
7528
|
+
"client_id": "port1/principals/user123/oauth-clients/my-client",
|
|
7529
|
+
"redirect_uri": "https://myapp.com/callback"
|
|
7295
7530
|
}
|
|
7296
7531
|
}
|
|
7297
7532
|
}
|
|
@@ -7303,6 +7538,10 @@
|
|
|
7303
7538
|
"application/json": {
|
|
7304
7539
|
"schema": {
|
|
7305
7540
|
"$ref": "#/components/schemas/GenerateOAuthCodeResponse"
|
|
7541
|
+
},
|
|
7542
|
+
"example": {
|
|
7543
|
+
"code": "abc123def456ghi789",
|
|
7544
|
+
"expiryInSeconds": 600
|
|
7306
7545
|
}
|
|
7307
7546
|
}
|
|
7308
7547
|
}
|
|
@@ -7389,6 +7628,14 @@
|
|
|
7389
7628
|
}
|
|
7390
7629
|
}
|
|
7391
7630
|
]
|
|
7631
|
+
},
|
|
7632
|
+
"example": {
|
|
7633
|
+
"redirect_uris": [
|
|
7634
|
+
"http://127.0.0.1:8765/callback"
|
|
7635
|
+
],
|
|
7636
|
+
"token_endpoint_auth_method": "none",
|
|
7637
|
+
"client_id": "dcr_example",
|
|
7638
|
+
"client_id_issued_at": 1791504000
|
|
7392
7639
|
}
|
|
7393
7640
|
}
|
|
7394
7641
|
}
|
|
@@ -7399,6 +7646,10 @@
|
|
|
7399
7646
|
"application/json": {
|
|
7400
7647
|
"schema": {
|
|
7401
7648
|
"$ref": "#/components/schemas/OAuthProtocolError"
|
|
7649
|
+
},
|
|
7650
|
+
"example": {
|
|
7651
|
+
"error": "invalid_client_metadata",
|
|
7652
|
+
"error_description": "Use HTTPS callbacks or an entirely local callback set."
|
|
7402
7653
|
}
|
|
7403
7654
|
}
|
|
7404
7655
|
}
|
|
@@ -7559,6 +7810,10 @@
|
|
|
7559
7810
|
"type": "string"
|
|
7560
7811
|
}
|
|
7561
7812
|
}
|
|
7813
|
+
},
|
|
7814
|
+
"example": {
|
|
7815
|
+
"request_id": "SERVER_ISSUED_PENDING_REQUEST_ID",
|
|
7816
|
+
"approved": true
|
|
7562
7817
|
}
|
|
7563
7818
|
}
|
|
7564
7819
|
}
|
|
@@ -7579,6 +7834,9 @@
|
|
|
7579
7834
|
"format": "uri"
|
|
7580
7835
|
}
|
|
7581
7836
|
}
|
|
7837
|
+
},
|
|
7838
|
+
"example": {
|
|
7839
|
+
"redirect_url": "http://127.0.0.1:8765/callback?code=SERVER_ISSUED_CODE&state=ORIGINAL_STATE"
|
|
7582
7840
|
}
|
|
7583
7841
|
}
|
|
7584
7842
|
}
|
|
@@ -7654,6 +7912,13 @@
|
|
|
7654
7912
|
}
|
|
7655
7913
|
}
|
|
7656
7914
|
}
|
|
7915
|
+
},
|
|
7916
|
+
"example": {
|
|
7917
|
+
"client_id": "dcr_example",
|
|
7918
|
+
"client_name": "Example agent",
|
|
7919
|
+
"redirect_uri": "http://127.0.0.1:8765/callback",
|
|
7920
|
+
"resource": "https://portos-pilot-api-685761720421.us-west1.run.app",
|
|
7921
|
+
"scopes": []
|
|
7657
7922
|
}
|
|
7658
7923
|
}
|
|
7659
7924
|
}
|
|
@@ -7686,6 +7951,10 @@
|
|
|
7686
7951
|
"application/json": {
|
|
7687
7952
|
"schema": {
|
|
7688
7953
|
"$ref": "#/components/schemas/ValidateOAuthRequestRequest"
|
|
7954
|
+
},
|
|
7955
|
+
"example": {
|
|
7956
|
+
"client_id": "port1/principals/user123/oauth-clients/my-client",
|
|
7957
|
+
"redirect_uri": "https://myapp.com/callback"
|
|
7689
7958
|
}
|
|
7690
7959
|
}
|
|
7691
7960
|
}
|
|
@@ -7697,6 +7966,10 @@
|
|
|
7697
7966
|
"application/json": {
|
|
7698
7967
|
"schema": {
|
|
7699
7968
|
"$ref": "#/components/schemas/ValidateOAuthRequestResponse"
|
|
7969
|
+
},
|
|
7970
|
+
"example": {
|
|
7971
|
+
"clientName": "My OAuth Application",
|
|
7972
|
+
"scopes": []
|
|
7700
7973
|
}
|
|
7701
7974
|
}
|
|
7702
7975
|
}
|
|
@@ -7740,6 +8013,12 @@
|
|
|
7740
8013
|
"application/json": {
|
|
7741
8014
|
"schema": {
|
|
7742
8015
|
"$ref": "#/components/schemas/VerifyDeviceResponse"
|
|
8016
|
+
},
|
|
8017
|
+
"example": {
|
|
8018
|
+
"deviceauth_id": "da_1234567890abcdef",
|
|
8019
|
+
"client_name": "My OAuth Application",
|
|
8020
|
+
"client_id": "port1/principals/user123/oauth-clients/my-client",
|
|
8021
|
+
"status": "pending"
|
|
7743
8022
|
}
|
|
7744
8023
|
}
|
|
7745
8024
|
}
|
|
@@ -7750,6 +8029,10 @@
|
|
|
7750
8029
|
"application/json": {
|
|
7751
8030
|
"schema": {
|
|
7752
8031
|
"$ref": "#/components/schemas/OAuthErrorResponse"
|
|
8032
|
+
},
|
|
8033
|
+
"example": {
|
|
8034
|
+
"error": "invalid_request",
|
|
8035
|
+
"error_description": "user_code is required"
|
|
7753
8036
|
}
|
|
7754
8037
|
}
|
|
7755
8038
|
}
|
|
@@ -7760,6 +8043,10 @@
|
|
|
7760
8043
|
"application/json": {
|
|
7761
8044
|
"schema": {
|
|
7762
8045
|
"$ref": "#/components/schemas/OAuthErrorResponse"
|
|
8046
|
+
},
|
|
8047
|
+
"example": {
|
|
8048
|
+
"error": "invalid_request",
|
|
8049
|
+
"error_description": "user_code is required"
|
|
7763
8050
|
}
|
|
7764
8051
|
}
|
|
7765
8052
|
}
|
|
@@ -7783,6 +8070,13 @@
|
|
|
7783
8070
|
"application/json": {
|
|
7784
8071
|
"schema": {
|
|
7785
8072
|
"$ref": "#/components/schemas/AuthorizeDeviceRequest"
|
|
8073
|
+
},
|
|
8074
|
+
"example": {
|
|
8075
|
+
"user_code": "ABCD-EFGH",
|
|
8076
|
+
"scopes": [
|
|
8077
|
+
"endpoint:read",
|
|
8078
|
+
"endpoint:write"
|
|
8079
|
+
]
|
|
7786
8080
|
}
|
|
7787
8081
|
}
|
|
7788
8082
|
}
|
|
@@ -7794,6 +8088,9 @@
|
|
|
7794
8088
|
"application/json": {
|
|
7795
8089
|
"schema": {
|
|
7796
8090
|
"$ref": "#/components/schemas/AuthorizeDeviceResponse"
|
|
8091
|
+
},
|
|
8092
|
+
"example": {
|
|
8093
|
+
"success": true
|
|
7797
8094
|
}
|
|
7798
8095
|
}
|
|
7799
8096
|
}
|
|
@@ -7804,6 +8101,10 @@
|
|
|
7804
8101
|
"application/json": {
|
|
7805
8102
|
"schema": {
|
|
7806
8103
|
"$ref": "#/components/schemas/OAuthErrorResponse"
|
|
8104
|
+
},
|
|
8105
|
+
"example": {
|
|
8106
|
+
"error": "invalid_request",
|
|
8107
|
+
"error_description": "user_code is required"
|
|
7807
8108
|
}
|
|
7808
8109
|
}
|
|
7809
8110
|
}
|
|
@@ -7814,6 +8115,10 @@
|
|
|
7814
8115
|
"application/json": {
|
|
7815
8116
|
"schema": {
|
|
7816
8117
|
"$ref": "#/components/schemas/OAuthErrorResponse"
|
|
8118
|
+
},
|
|
8119
|
+
"example": {
|
|
8120
|
+
"error": "invalid_request",
|
|
8121
|
+
"error_description": "user_code is required"
|
|
7817
8122
|
}
|
|
7818
8123
|
}
|
|
7819
8124
|
}
|
|
@@ -7824,6 +8129,10 @@
|
|
|
7824
8129
|
"application/json": {
|
|
7825
8130
|
"schema": {
|
|
7826
8131
|
"$ref": "#/components/schemas/OAuthErrorResponse"
|
|
8132
|
+
},
|
|
8133
|
+
"example": {
|
|
8134
|
+
"error": "invalid_request",
|
|
8135
|
+
"error_description": "user_code is required"
|
|
7827
8136
|
}
|
|
7828
8137
|
}
|
|
7829
8138
|
}
|
|
@@ -9094,6 +9403,9 @@
|
|
|
9094
9403
|
"application/json": {
|
|
9095
9404
|
"schema": {
|
|
9096
9405
|
"$ref": "#/components/schemas/FlowNode"
|
|
9406
|
+
},
|
|
9407
|
+
"example": {
|
|
9408
|
+
"id": "port1/principals/example"
|
|
9097
9409
|
}
|
|
9098
9410
|
}
|
|
9099
9411
|
}
|
|
@@ -9185,6 +9497,9 @@
|
|
|
9185
9497
|
"description": "The ID of the flow node to delete."
|
|
9186
9498
|
}
|
|
9187
9499
|
}
|
|
9500
|
+
},
|
|
9501
|
+
"example": {
|
|
9502
|
+
"id": "port1/principals/example"
|
|
9188
9503
|
}
|
|
9189
9504
|
}
|
|
9190
9505
|
}
|
|
@@ -9945,6 +10260,9 @@
|
|
|
9945
10260
|
"application/json": {
|
|
9946
10261
|
"schema": {
|
|
9947
10262
|
"$ref": "#/components/schemas/Message"
|
|
10263
|
+
},
|
|
10264
|
+
"example": {
|
|
10265
|
+
"body": {}
|
|
9948
10266
|
}
|
|
9949
10267
|
}
|
|
9950
10268
|
}
|
|
@@ -10717,6 +11035,14 @@
|
|
|
10717
11035
|
"application/json": {
|
|
10718
11036
|
"schema": {
|
|
10719
11037
|
"$ref": "#/components/schemas/UpsertViewRequest"
|
|
11038
|
+
},
|
|
11039
|
+
"example": {
|
|
11040
|
+
"title": {
|
|
11041
|
+
"type": "LIGHT",
|
|
11042
|
+
"value": "port1/principals/example"
|
|
11043
|
+
},
|
|
11044
|
+
"positions": [],
|
|
11045
|
+
"widgets": []
|
|
10720
11046
|
}
|
|
10721
11047
|
}
|
|
10722
11048
|
}
|
|
@@ -10849,6 +11175,9 @@
|
|
|
10849
11175
|
"application/json": {
|
|
10850
11176
|
"schema": {
|
|
10851
11177
|
"$ref": "#/components/schemas/View"
|
|
11178
|
+
},
|
|
11179
|
+
"example": {
|
|
11180
|
+
"id": "port1/principals/example"
|
|
10852
11181
|
}
|
|
10853
11182
|
}
|
|
10854
11183
|
}
|
|
@@ -10957,6 +11286,14 @@
|
|
|
10957
11286
|
"application/json": {
|
|
10958
11287
|
"schema": {
|
|
10959
11288
|
"$ref": "#/components/schemas/UpsertViewRequest"
|
|
11289
|
+
},
|
|
11290
|
+
"example": {
|
|
11291
|
+
"title": {
|
|
11292
|
+
"type": "LIGHT",
|
|
11293
|
+
"value": "port1/principals/example"
|
|
11294
|
+
},
|
|
11295
|
+
"positions": [],
|
|
11296
|
+
"widgets": []
|
|
10960
11297
|
}
|
|
10961
11298
|
}
|
|
10962
11299
|
}
|
|
@@ -11277,6 +11614,10 @@
|
|
|
11277
11614
|
"description": "The Port OS identifier of the flow node to execute"
|
|
11278
11615
|
}
|
|
11279
11616
|
}
|
|
11617
|
+
},
|
|
11618
|
+
"example": {
|
|
11619
|
+
"flow_id": "port1/principals/example",
|
|
11620
|
+
"node_id": "port1/principals/example"
|
|
11280
11621
|
}
|
|
11281
11622
|
}
|
|
11282
11623
|
}
|
|
@@ -11355,6 +11696,10 @@
|
|
|
11355
11696
|
"description": "Optional override for the Tuya authentication API endpoint. Defaults to https://apigw.iotbing.com if not provided.\n"
|
|
11356
11697
|
}
|
|
11357
11698
|
}
|
|
11699
|
+
},
|
|
11700
|
+
"example": {
|
|
11701
|
+
"accessCode": "port1/principals/example",
|
|
11702
|
+
"clientId": "port1/principals/example"
|
|
11358
11703
|
}
|
|
11359
11704
|
}
|
|
11360
11705
|
}
|
|
@@ -11454,6 +11799,11 @@
|
|
|
11454
11799
|
"description": "Optional override for the Tuya authentication API endpoint. Defaults to https://apigw.iotbing.com if not provided.\n"
|
|
11455
11800
|
}
|
|
11456
11801
|
}
|
|
11802
|
+
},
|
|
11803
|
+
"example": {
|
|
11804
|
+
"loginCode": "port1/principals/example",
|
|
11805
|
+
"userCode": "port1/principals/example",
|
|
11806
|
+
"clientId": "port1/principals/example"
|
|
11457
11807
|
}
|
|
11458
11808
|
}
|
|
11459
11809
|
}
|
|
@@ -18837,8 +19187,8 @@
|
|
|
18837
19187
|
"id": {
|
|
18838
19188
|
"type": "string",
|
|
18839
19189
|
"description": "The unique identifier for the endpoint group",
|
|
18840
|
-
"pattern": "^port1
|
|
18841
|
-
"example": "port1/principals/
|
|
19190
|
+
"pattern": "^port1/[^/]+/[^/]+/endpoint-groups/[^/]+$",
|
|
19191
|
+
"example": "port1/principals/example/endpoint-groups/living-room"
|
|
18842
19192
|
},
|
|
18843
19193
|
"name": {
|
|
18844
19194
|
"$ref": "#/components/schemas/TypeValue",
|
|
@@ -18914,13 +19264,13 @@
|
|
|
18914
19264
|
"id": {
|
|
18915
19265
|
"type": "string",
|
|
18916
19266
|
"description": "The unique identifier for the group route",
|
|
18917
|
-
"pattern": "^port1
|
|
18918
|
-
"example": "port1/principals/
|
|
19267
|
+
"pattern": "^port1/[^/]+/[^/]+/endpoint-group-routes/[^/]+$",
|
|
19268
|
+
"example": "port1/principals/example/endpoint-group-routes/living-room"
|
|
18919
19269
|
},
|
|
18920
19270
|
"associatedGroupId": {
|
|
18921
19271
|
"type": "string",
|
|
18922
19272
|
"description": "The ID of the associated endpoint group",
|
|
18923
|
-
"pattern": "^port1
|
|
19273
|
+
"pattern": "^port1/[^/]+/[^/]+/endpoint-groups/[^/]+$"
|
|
18924
19274
|
},
|
|
18925
19275
|
"associatedPluginId": {
|
|
18926
19276
|
"type": "string",
|
|
@@ -22358,7 +22708,7 @@
|
|
|
22358
22708
|
"id": {
|
|
22359
22709
|
"type": "string",
|
|
22360
22710
|
"description": "The unique identifier for the principal",
|
|
22361
|
-
"pattern": "^port1
|
|
22711
|
+
"pattern": "^port1/[^/]+/[^/]+$"
|
|
22362
22712
|
},
|
|
22363
22713
|
"ownerId": {
|
|
22364
22714
|
"type": "string",
|
|
@@ -22564,7 +22914,7 @@
|
|
|
22564
22914
|
"id": {
|
|
22565
22915
|
"type": "string",
|
|
22566
22916
|
"description": "The persisted Port OS route identifier. Synchronized routes can receive a backend-generated, owner-scoped value here even when the discovery payload supplied an explicit route `id`; do not use this field as the stable plugin-owned route identity unless the synchronizing implementation explicitly documents preservation.\n",
|
|
22567
|
-
"pattern": "^port1
|
|
22917
|
+
"pattern": "^port1/[^/]+/[^/]+/routes/[^/]+$"
|
|
22568
22918
|
},
|
|
22569
22919
|
"associatedPluginId": {
|
|
22570
22920
|
"type": "string",
|
|
@@ -22685,8 +23035,8 @@
|
|
|
22685
23035
|
"id": {
|
|
22686
23036
|
"type": "string",
|
|
22687
23037
|
"description": "The unique identifier for the endpoint",
|
|
22688
|
-
"pattern": "^port1
|
|
22689
|
-
"example": "port1
|
|
23038
|
+
"pattern": "^port1/[^/]+/[^/]+/endpoints/[^/]+$",
|
|
23039
|
+
"example": "port1/principals/example/endpoints/light-1"
|
|
22690
23040
|
},
|
|
22691
23041
|
"name": {
|
|
22692
23042
|
"$ref": "#/components/schemas/TypeValue",
|
|
@@ -23616,7 +23966,7 @@
|
|
|
23616
23966
|
"id": {
|
|
23617
23967
|
"type": "string",
|
|
23618
23968
|
"description": "The created plugin ID",
|
|
23619
|
-
"pattern": "^port1
|
|
23969
|
+
"pattern": "^port1/[^/]+/[^/]+/plugins/[^/]+$"
|
|
23620
23970
|
}
|
|
23621
23971
|
}
|
|
23622
23972
|
},
|
|
@@ -23721,7 +24071,7 @@
|
|
|
23721
24071
|
"id": {
|
|
23722
24072
|
"type": "string",
|
|
23723
24073
|
"description": "The unique identifier for the auth link",
|
|
23724
|
-
"pattern": "^port1
|
|
24074
|
+
"pattern": "^port1/[^/]+/[^/]+/auth-links/[^/]+$"
|
|
23725
24075
|
},
|
|
23726
24076
|
"ownerId": {
|
|
23727
24077
|
"type": "string",
|
|
@@ -23778,7 +24128,7 @@
|
|
|
23778
24128
|
"type": "object",
|
|
23779
24129
|
"description": "A request denoting the creation of an auth link between a principal and a plugin",
|
|
23780
24130
|
"required": [
|
|
23781
|
-
"
|
|
24131
|
+
"authLink"
|
|
23782
24132
|
],
|
|
23783
24133
|
"properties": {
|
|
23784
24134
|
"authLink": {
|