@celigo/api-specs 0.2.119 → 0.2.121
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/dist/api.yml +4 -4
- package/dist/connection.yml +4 -4
- package/dist/enduser.yml +4 -4
- package/dist/export.yml +8 -8
- package/dist/flow.yml +8 -5
- package/dist/iclient.yml +16 -23
- package/dist/mcp-server.yml +4 -4
- package/dist/tool.yml +12 -12
- package/package.json +1 -1
- package/schemas.json +2 -2
package/dist/api.yml
CHANGED
|
@@ -5503,7 +5503,7 @@ components:
|
|
|
5503
5503
|
OAuth access token for Salesforce API calls (encrypted at rest; returned masked as
|
|
5504
5504
|
`"******"`). Auto-managed by the system during the OAuth flow; rarely set manually.
|
|
5505
5505
|
examples:
|
|
5506
|
-
-
|
|
5506
|
+
- <org-id>!<session-token>
|
|
5507
5507
|
x-celigo-ai-guidance:
|
|
5508
5508
|
- |-
|
|
5509
5509
|
OAuth access/bearer token (encrypted at rest).
|
|
@@ -5824,7 +5824,7 @@ components:
|
|
|
5824
5824
|
AWS access key ID for IAM authentication. From an IAM user or role with S3 permissions
|
|
5825
5825
|
(s3:GetObject, s3:PutObject, s3:ListBucket, etc.). Used when authType is `accesskey`.
|
|
5826
5826
|
examples:
|
|
5827
|
-
-
|
|
5827
|
+
- AKIA_EXAMPLE_KEY_ID
|
|
5828
5828
|
x-celigo-ui-override: The connection form marks accessKeyId required when Auth type is "Access key & secret" (`accesskey`) and removes it when Auth type is "IAM role" (`awsIam`). The API enforces it for authType `accesskey` (POST without it returns 422 missing_required_field) — encoded via the if/then/else rule below.
|
|
5829
5829
|
secretAccessKey:
|
|
5830
5830
|
type: string
|
|
@@ -7876,7 +7876,7 @@ components:
|
|
|
7876
7876
|
type: string
|
|
7877
7877
|
description: AWS access key ID for IAM authentication.
|
|
7878
7878
|
examples:
|
|
7879
|
-
-
|
|
7879
|
+
- AKIA_EXAMPLE_KEY_ID
|
|
7880
7880
|
secretAccessKey:
|
|
7881
7881
|
type: string
|
|
7882
7882
|
description: AWS secret access key (encrypted at rest).
|
|
@@ -9408,7 +9408,7 @@ components:
|
|
|
9408
9408
|
type: string
|
|
9409
9409
|
description: Access key ID of the IAM user or role whose policy grants the required DynamoDB actions.
|
|
9410
9410
|
examples:
|
|
9411
|
-
-
|
|
9411
|
+
- AKIA_EXAMPLE_KEY_ID
|
|
9412
9412
|
secretAccessKey:
|
|
9413
9413
|
type: string
|
|
9414
9414
|
description: Secret access key paired with `accessKeyId`. Encrypted at rest and returned masked as `"******"`.
|
package/dist/connection.yml
CHANGED
|
@@ -4614,7 +4614,7 @@ components:
|
|
|
4614
4614
|
OAuth access token for Salesforce API calls (encrypted at rest; returned masked as
|
|
4615
4615
|
`"******"`). Auto-managed by the system during the OAuth flow; rarely set manually.
|
|
4616
4616
|
examples:
|
|
4617
|
-
-
|
|
4617
|
+
- <org-id>!<session-token>
|
|
4618
4618
|
x-celigo-ai-guidance:
|
|
4619
4619
|
- |-
|
|
4620
4620
|
OAuth access/bearer token (encrypted at rest).
|
|
@@ -4935,7 +4935,7 @@ components:
|
|
|
4935
4935
|
AWS access key ID for IAM authentication. From an IAM user or role with S3 permissions
|
|
4936
4936
|
(s3:GetObject, s3:PutObject, s3:ListBucket, etc.). Used when authType is `accesskey`.
|
|
4937
4937
|
examples:
|
|
4938
|
-
-
|
|
4938
|
+
- AKIA_EXAMPLE_KEY_ID
|
|
4939
4939
|
x-celigo-ui-override: The connection form marks accessKeyId required when Auth type is "Access key & secret" (`accesskey`) and removes it when Auth type is "IAM role" (`awsIam`). The API enforces it for authType `accesskey` (POST without it returns 422 missing_required_field) — encoded via the if/then/else rule below.
|
|
4940
4940
|
secretAccessKey:
|
|
4941
4941
|
type: string
|
|
@@ -6987,7 +6987,7 @@ components:
|
|
|
6987
6987
|
type: string
|
|
6988
6988
|
description: AWS access key ID for IAM authentication.
|
|
6989
6989
|
examples:
|
|
6990
|
-
-
|
|
6990
|
+
- AKIA_EXAMPLE_KEY_ID
|
|
6991
6991
|
secretAccessKey:
|
|
6992
6992
|
type: string
|
|
6993
6993
|
description: AWS secret access key (encrypted at rest).
|
|
@@ -8519,7 +8519,7 @@ components:
|
|
|
8519
8519
|
type: string
|
|
8520
8520
|
description: Access key ID of the IAM user or role whose policy grants the required DynamoDB actions.
|
|
8521
8521
|
examples:
|
|
8522
|
-
-
|
|
8522
|
+
- AKIA_EXAMPLE_KEY_ID
|
|
8523
8523
|
secretAccessKey:
|
|
8524
8524
|
type: string
|
|
8525
8525
|
description: Secret access key paired with `accessKeyId`. Encrypted at rest and returned masked as `"******"`.
|
package/dist/enduser.yml
CHANGED
|
@@ -2715,7 +2715,7 @@ components:
|
|
|
2715
2715
|
OAuth access token for Salesforce API calls (encrypted at rest; returned masked as
|
|
2716
2716
|
`"******"`). Auto-managed by the system during the OAuth flow; rarely set manually.
|
|
2717
2717
|
examples:
|
|
2718
|
-
-
|
|
2718
|
+
- <org-id>!<session-token>
|
|
2719
2719
|
x-celigo-ai-guidance:
|
|
2720
2720
|
- |-
|
|
2721
2721
|
OAuth access/bearer token (encrypted at rest).
|
|
@@ -3036,7 +3036,7 @@ components:
|
|
|
3036
3036
|
AWS access key ID for IAM authentication. From an IAM user or role with S3 permissions
|
|
3037
3037
|
(s3:GetObject, s3:PutObject, s3:ListBucket, etc.). Used when authType is `accesskey`.
|
|
3038
3038
|
examples:
|
|
3039
|
-
-
|
|
3039
|
+
- AKIA_EXAMPLE_KEY_ID
|
|
3040
3040
|
x-celigo-ui-override: The connection form marks accessKeyId required when Auth type is "Access key & secret" (`accesskey`) and removes it when Auth type is "IAM role" (`awsIam`). The API enforces it for authType `accesskey` (POST without it returns 422 missing_required_field) — encoded via the if/then/else rule below.
|
|
3041
3041
|
secretAccessKey:
|
|
3042
3042
|
type: string
|
|
@@ -5088,7 +5088,7 @@ components:
|
|
|
5088
5088
|
type: string
|
|
5089
5089
|
description: AWS access key ID for IAM authentication.
|
|
5090
5090
|
examples:
|
|
5091
|
-
-
|
|
5091
|
+
- AKIA_EXAMPLE_KEY_ID
|
|
5092
5092
|
secretAccessKey:
|
|
5093
5093
|
type: string
|
|
5094
5094
|
description: AWS secret access key (encrypted at rest).
|
|
@@ -6620,7 +6620,7 @@ components:
|
|
|
6620
6620
|
type: string
|
|
6621
6621
|
description: Access key ID of the IAM user or role whose policy grants the required DynamoDB actions.
|
|
6622
6622
|
examples:
|
|
6623
|
-
-
|
|
6623
|
+
- AKIA_EXAMPLE_KEY_ID
|
|
6624
6624
|
secretAccessKey:
|
|
6625
6625
|
type: string
|
|
6626
6626
|
description: Secret access key paired with `accessKeyId`. Encrypted at rest and returned masked as `"******"`.
|
package/dist/export.yml
CHANGED
|
@@ -1714,11 +1714,11 @@ components:
|
|
|
1714
1714
|
### Common implementations
|
|
1715
1715
|
|
|
1716
1716
|
```
|
|
1717
|
-
"token": "
|
|
1717
|
+
"token": "<32+ random characters>"
|
|
1718
1718
|
```
|
|
1719
1719
|
|
|
1720
1720
|
```
|
|
1721
|
-
"token": "
|
|
1721
|
+
"token": "whsec_<signing secret from the sending system>"
|
|
1722
1722
|
```
|
|
1723
1723
|
|
|
1724
1724
|
IMPORTANT: Never share this token in public repositories or documentation.
|
|
@@ -1975,11 +1975,11 @@ components:
|
|
|
1975
1975
|
For tokens embedded in JSON payloads:
|
|
1976
1976
|
|
|
1977
1977
|
```
|
|
1978
|
-
"path": "meta.token" // For { "meta": { "token": "
|
|
1978
|
+
"path": "meta.token" // For { "meta": { "token": "<token>" } }
|
|
1979
1979
|
```
|
|
1980
1980
|
|
|
1981
1981
|
```
|
|
1982
|
-
"path": "verification.key" // For { "verification": { "key": "
|
|
1982
|
+
"path": "verification.key" // For { "verification": { "key": "<token>" } }
|
|
1983
1983
|
```
|
|
1984
1984
|
|
|
1985
1985
|
### Token at root level
|
|
@@ -1987,7 +1987,7 @@ components:
|
|
|
1987
1987
|
For tokens in the top level of the request:
|
|
1988
1988
|
|
|
1989
1989
|
```
|
|
1990
|
-
"path": "token" // For { "token": "
|
|
1990
|
+
"path": "token" // For { "token": "<token>", "data": {...} }
|
|
1991
1991
|
```
|
|
1992
1992
|
|
|
1993
1993
|
### Token in query parameters
|
|
@@ -1995,7 +1995,7 @@ components:
|
|
|
1995
1995
|
For tokens sent as URL query parameters, use the parameter name:
|
|
1996
1996
|
|
|
1997
1997
|
```
|
|
1998
|
-
"path": "verify_token" // For /webhook?verify_token
|
|
1998
|
+
"path": "verify_token" // For /webhook?verify_token=<token>
|
|
1999
1999
|
```
|
|
2000
2000
|
- |-
|
|
2001
2001
|
## VERIFICATION PROCESS
|
|
@@ -6888,7 +6888,7 @@ components:
|
|
|
6888
6888
|
"method": "token",
|
|
6889
6889
|
"path": "meta.nextToken",
|
|
6890
6890
|
"pathLocation": "body",
|
|
6891
|
-
"token": "
|
|
6891
|
+
"token": "<next-page-token>"
|
|
6892
6892
|
}
|
|
6893
6893
|
|
|
6894
6894
|
// For APIs requiring an initial token:
|
|
@@ -6931,7 +6931,7 @@ components:
|
|
|
6931
6931
|
|
|
6932
6932
|
Example header:
|
|
6933
6933
|
```
|
|
6934
|
-
X-Pagination-Token:
|
|
6934
|
+
X-Pagination-Token: <next-page-token>
|
|
6935
6935
|
```
|
|
6936
6936
|
Correct path: "X-Pagination-Token"
|
|
6937
6937
|
|
package/dist/flow.yml
CHANGED
|
@@ -5545,11 +5545,14 @@ components:
|
|
|
5545
5545
|
- array
|
|
5546
5546
|
- 'null'
|
|
5547
5547
|
description: |-
|
|
5548
|
-
Flow IDs to
|
|
5549
|
-
|
|
5550
|
-
that
|
|
5551
|
-
|
|
5552
|
-
|
|
5548
|
+
Flow IDs to start when a run of this flow completes — the flow's "Next integration flow"
|
|
5549
|
+
setting in the UI; a run that completes with record-level errors still starts them, a run
|
|
5550
|
+
that fails or is canceled does not. Accepts null as equivalent to an empty list (the server
|
|
5551
|
+
also serves null on documents saved that way). Each next flow starts from its own source
|
|
5552
|
+
steps and receives no records; a trigger that fires while the next flow is already queued
|
|
5553
|
+
or running is dropped, not queued, so several completions in quick succession start it
|
|
5554
|
+
once, and a flow listed here cannot be deleted while this flow still references it
|
|
5555
|
+
(422 `dependencies_not_deleted`).
|
|
5553
5556
|
items:
|
|
5554
5557
|
type: string
|
|
5555
5558
|
format: objectId
|
package/dist/iclient.yml
CHANGED
|
@@ -2326,8 +2326,7 @@ components:
|
|
|
2326
2326
|
- |-
|
|
2327
2327
|
## EXAMPLES:
|
|
2328
2328
|
- "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9..."
|
|
2329
|
-
-
|
|
2330
|
-
- "mF_9.B5f-4.1JqM"
|
|
2329
|
+
- An opaque string, such as the sample access token in RFC 6749
|
|
2331
2330
|
- |-
|
|
2332
2331
|
## IMPLEMENTATION GUIDANCE:
|
|
2333
2332
|
- Ensure the token is included in the Authorization header as "Bearer {token}".
|
|
@@ -2699,8 +2698,8 @@ components:
|
|
|
2699
2698
|
commonly application/x-www-form-urlencoded.
|
|
2700
2699
|
- |-
|
|
2701
2700
|
## EXAMPLES:
|
|
2702
|
-
- grant_type=refresh_token&refresh_token=
|
|
2703
|
-
- grant_type=refresh_token&refresh_token=
|
|
2701
|
+
- grant_type=refresh_token&refresh_token=REFRESH_TOKEN&client_id=CLIENT_ID&client_secret=CLIENT_SECRET
|
|
2702
|
+
- grant_type=refresh_token&refresh_token={{{iClient.oauth2.refreshToken}}}
|
|
2704
2703
|
- |-
|
|
2705
2704
|
## FIELD BEHAVIOR:
|
|
2706
2705
|
- Contains all necessary parameters to request a new access token using a refresh token.
|
|
@@ -2749,8 +2748,7 @@ components:
|
|
|
2749
2748
|
commonly application/x-www-form-urlencoded.
|
|
2750
2749
|
examples:
|
|
2751
2750
|
- grant_type=refresh_token&refresh_token={{{iClient.oauth2.refreshToken}}}
|
|
2752
|
-
- grant_type=refresh_token&refresh_token=
|
|
2753
|
-
- grant_type=refresh_token&refresh_token=def456
|
|
2751
|
+
- grant_type=refresh_token&refresh_token=REFRESH_TOKEN&client_id=CLIENT_ID&client_secret=CLIENT_SECRET
|
|
2754
2752
|
headers:
|
|
2755
2753
|
description: |-
|
|
2756
2754
|
Custom HTTP headers for the refresh token request.
|
|
@@ -2927,9 +2925,9 @@ components:
|
|
|
2927
2925
|
- Conforms to RFC 7009 (OAuth 2.0 Token Revocation)
|
|
2928
2926
|
- |-
|
|
2929
2927
|
## EXAMPLES:
|
|
2930
|
-
- token=
|
|
2931
|
-
- token=
|
|
2932
|
-
- token=
|
|
2928
|
+
- token={{{iClient.oauth2.accessToken}}}
|
|
2929
|
+
- token={{{iClient.oauth2.refreshToken}}}&token_type_hint=refresh_token
|
|
2930
|
+
- token=ACCESS_TOKEN&token_type_hint=access_token
|
|
2933
2931
|
- |-
|
|
2934
2932
|
## FIELD BEHAVIOR:
|
|
2935
2933
|
- Contains key-value pairs representing the token and optional token type hint.
|
|
@@ -2957,9 +2955,8 @@ components:
|
|
|
2957
2955
|
MIME type as per the OAuth 2.0 Token Revocation specification (RFC 7009).
|
|
2958
2956
|
examples:
|
|
2959
2957
|
- token={{{iClient.oauth2.accessToken}}}
|
|
2960
|
-
- token=
|
|
2961
|
-
- token=
|
|
2962
|
-
- token=abcdef123456&token_type_hint=access_token
|
|
2958
|
+
- token={{{iClient.oauth2.refreshToken}}}&token_type_hint=refresh_token
|
|
2959
|
+
- token=ACCESS_TOKEN&token_type_hint=access_token
|
|
2963
2960
|
headers:
|
|
2964
2961
|
description: |-
|
|
2965
2962
|
Custom HTTP headers for the revocation request.
|
|
@@ -3377,7 +3374,7 @@ components:
|
|
|
3377
3374
|
- Different Salesforce environments (sandbox vs production) may require different tokens.
|
|
3378
3375
|
- |-
|
|
3379
3376
|
## EXAMPLES:
|
|
3380
|
-
- A long
|
|
3377
|
+
- A long string that starts with the org ID, an exclamation mark, and then the session token
|
|
3381
3378
|
- OAuth access tokens obtained via Salesforce OAuth 2.0 flows.
|
|
3382
3379
|
- Tokens generated from Salesforce connected apps for API access.
|
|
3383
3380
|
- |-
|
|
@@ -3786,10 +3783,10 @@ components:
|
|
|
3786
3783
|
authorization, and interaction with various Amazon MWS endpoints.
|
|
3787
3784
|
- |-
|
|
3788
3785
|
## EXAMPLES:
|
|
3789
|
-
- Access Key ID:
|
|
3790
|
-
- Secret Access Key:
|
|
3791
|
-
- Seller ID:
|
|
3792
|
-
- MWS Auth Token:
|
|
3786
|
+
- Access Key ID: 20 characters, starting with AKIA
|
|
3787
|
+
- Secret Access Key: 40 characters, shown once when the key is created
|
|
3788
|
+
- Seller ID: the merchant ID from Seller Central, such as A1XEXAMPLE123
|
|
3789
|
+
- MWS Auth Token: a UUID with the amzn.mws. prefix, issued when the seller authorizes the developer
|
|
3793
3790
|
- |-
|
|
3794
3791
|
## FIELD BEHAVIOR:
|
|
3795
3792
|
- Contains all necessary authentication credentials such as Access Key ID, Secret Access Key, Seller ID, and MWS Auth Token.
|
|
@@ -3844,9 +3841,7 @@ components:
|
|
|
3844
3841
|
- Used alongside other credentials such as Seller ID and MWS Auth Token for full API access.
|
|
3845
3842
|
- |-
|
|
3846
3843
|
## EXAMPLES:
|
|
3847
|
-
- "
|
|
3848
|
-
- "ABCD1234EFGH5678IJKL"
|
|
3849
|
-
- "A1B2C3D4E5F6G7H8I9J0"
|
|
3844
|
+
- "AKIA_EXAMPLE_KEY_ID"
|
|
3850
3845
|
- |-
|
|
3851
3846
|
## IMPORTANT NOTES:
|
|
3852
3847
|
- The Access Key ID alone is insufficient for authentication; it must be paired with the Secret Access Key.
|
|
@@ -3893,9 +3888,7 @@ components:
|
|
|
3893
3888
|
enabling operations such as order retrieval, inventory management,
|
|
3894
3889
|
and report generation.
|
|
3895
3890
|
examples:
|
|
3896
|
-
-
|
|
3897
|
-
- ABCD1234EFGH5678IJKL
|
|
3898
|
-
- A1B2C3D4E5F6G7H8I9J0
|
|
3891
|
+
- AKIA_EXAMPLE_KEY_ID
|
|
3899
3892
|
secretKey:
|
|
3900
3893
|
type: string
|
|
3901
3894
|
description: |-
|
package/dist/mcp-server.yml
CHANGED
|
@@ -4540,7 +4540,7 @@ components:
|
|
|
4540
4540
|
OAuth access token for Salesforce API calls (encrypted at rest; returned masked as
|
|
4541
4541
|
`"******"`). Auto-managed by the system during the OAuth flow; rarely set manually.
|
|
4542
4542
|
examples:
|
|
4543
|
-
-
|
|
4543
|
+
- <org-id>!<session-token>
|
|
4544
4544
|
x-celigo-ai-guidance:
|
|
4545
4545
|
- |-
|
|
4546
4546
|
OAuth access/bearer token (encrypted at rest).
|
|
@@ -4861,7 +4861,7 @@ components:
|
|
|
4861
4861
|
AWS access key ID for IAM authentication. From an IAM user or role with S3 permissions
|
|
4862
4862
|
(s3:GetObject, s3:PutObject, s3:ListBucket, etc.). Used when authType is `accesskey`.
|
|
4863
4863
|
examples:
|
|
4864
|
-
-
|
|
4864
|
+
- AKIA_EXAMPLE_KEY_ID
|
|
4865
4865
|
x-celigo-ui-override: The connection form marks accessKeyId required when Auth type is "Access key & secret" (`accesskey`) and removes it when Auth type is "IAM role" (`awsIam`). The API enforces it for authType `accesskey` (POST without it returns 422 missing_required_field) — encoded via the if/then/else rule below.
|
|
4866
4866
|
secretAccessKey:
|
|
4867
4867
|
type: string
|
|
@@ -6913,7 +6913,7 @@ components:
|
|
|
6913
6913
|
type: string
|
|
6914
6914
|
description: AWS access key ID for IAM authentication.
|
|
6915
6915
|
examples:
|
|
6916
|
-
-
|
|
6916
|
+
- AKIA_EXAMPLE_KEY_ID
|
|
6917
6917
|
secretAccessKey:
|
|
6918
6918
|
type: string
|
|
6919
6919
|
description: AWS secret access key (encrypted at rest).
|
|
@@ -8445,7 +8445,7 @@ components:
|
|
|
8445
8445
|
type: string
|
|
8446
8446
|
description: Access key ID of the IAM user or role whose policy grants the required DynamoDB actions.
|
|
8447
8447
|
examples:
|
|
8448
|
-
-
|
|
8448
|
+
- AKIA_EXAMPLE_KEY_ID
|
|
8449
8449
|
secretAccessKey:
|
|
8450
8450
|
type: string
|
|
8451
8451
|
description: Secret access key paired with `accessKeyId`. Encrypted at rest and returned masked as `"******"`.
|
package/dist/tool.yml
CHANGED
|
@@ -7869,7 +7869,7 @@ components:
|
|
|
7869
7869
|
OAuth access token for Salesforce API calls (encrypted at rest; returned masked as
|
|
7870
7870
|
`"******"`). Auto-managed by the system during the OAuth flow; rarely set manually.
|
|
7871
7871
|
examples:
|
|
7872
|
-
-
|
|
7872
|
+
- <org-id>!<session-token>
|
|
7873
7873
|
x-celigo-ai-guidance:
|
|
7874
7874
|
- |-
|
|
7875
7875
|
OAuth access/bearer token (encrypted at rest).
|
|
@@ -8190,7 +8190,7 @@ components:
|
|
|
8190
8190
|
AWS access key ID for IAM authentication. From an IAM user or role with S3 permissions
|
|
8191
8191
|
(s3:GetObject, s3:PutObject, s3:ListBucket, etc.). Used when authType is `accesskey`.
|
|
8192
8192
|
examples:
|
|
8193
|
-
-
|
|
8193
|
+
- AKIA_EXAMPLE_KEY_ID
|
|
8194
8194
|
x-celigo-ui-override: The connection form marks accessKeyId required when Auth type is "Access key & secret" (`accesskey`) and removes it when Auth type is "IAM role" (`awsIam`). The API enforces it for authType `accesskey` (POST without it returns 422 missing_required_field) — encoded via the if/then/else rule below.
|
|
8195
8195
|
secretAccessKey:
|
|
8196
8196
|
type: string
|
|
@@ -10242,7 +10242,7 @@ components:
|
|
|
10242
10242
|
type: string
|
|
10243
10243
|
description: AWS access key ID for IAM authentication.
|
|
10244
10244
|
examples:
|
|
10245
|
-
-
|
|
10245
|
+
- AKIA_EXAMPLE_KEY_ID
|
|
10246
10246
|
secretAccessKey:
|
|
10247
10247
|
type: string
|
|
10248
10248
|
description: AWS secret access key (encrypted at rest).
|
|
@@ -11774,7 +11774,7 @@ components:
|
|
|
11774
11774
|
type: string
|
|
11775
11775
|
description: Access key ID of the IAM user or role whose policy grants the required DynamoDB actions.
|
|
11776
11776
|
examples:
|
|
11777
|
-
-
|
|
11777
|
+
- AKIA_EXAMPLE_KEY_ID
|
|
11778
11778
|
secretAccessKey:
|
|
11779
11779
|
type: string
|
|
11780
11780
|
description: Secret access key paired with `accessKeyId`. Encrypted at rest and returned masked as `"******"`.
|
|
@@ -26365,11 +26365,11 @@ components:
|
|
|
26365
26365
|
### Common implementations
|
|
26366
26366
|
|
|
26367
26367
|
```
|
|
26368
|
-
"token": "
|
|
26368
|
+
"token": "<32+ random characters>"
|
|
26369
26369
|
```
|
|
26370
26370
|
|
|
26371
26371
|
```
|
|
26372
|
-
"token": "
|
|
26372
|
+
"token": "whsec_<signing secret from the sending system>"
|
|
26373
26373
|
```
|
|
26374
26374
|
|
|
26375
26375
|
IMPORTANT: Never share this token in public repositories or documentation.
|
|
@@ -26626,11 +26626,11 @@ components:
|
|
|
26626
26626
|
For tokens embedded in JSON payloads:
|
|
26627
26627
|
|
|
26628
26628
|
```
|
|
26629
|
-
"path": "meta.token" // For { "meta": { "token": "
|
|
26629
|
+
"path": "meta.token" // For { "meta": { "token": "<token>" } }
|
|
26630
26630
|
```
|
|
26631
26631
|
|
|
26632
26632
|
```
|
|
26633
|
-
"path": "verification.key" // For { "verification": { "key": "
|
|
26633
|
+
"path": "verification.key" // For { "verification": { "key": "<token>" } }
|
|
26634
26634
|
```
|
|
26635
26635
|
|
|
26636
26636
|
### Token at root level
|
|
@@ -26638,7 +26638,7 @@ components:
|
|
|
26638
26638
|
For tokens in the top level of the request:
|
|
26639
26639
|
|
|
26640
26640
|
```
|
|
26641
|
-
"path": "token" // For { "token": "
|
|
26641
|
+
"path": "token" // For { "token": "<token>", "data": {...} }
|
|
26642
26642
|
```
|
|
26643
26643
|
|
|
26644
26644
|
### Token in query parameters
|
|
@@ -26646,7 +26646,7 @@ components:
|
|
|
26646
26646
|
For tokens sent as URL query parameters, use the parameter name:
|
|
26647
26647
|
|
|
26648
26648
|
```
|
|
26649
|
-
"path": "verify_token" // For /webhook?verify_token
|
|
26649
|
+
"path": "verify_token" // For /webhook?verify_token=<token>
|
|
26650
26650
|
```
|
|
26651
26651
|
- |-
|
|
26652
26652
|
## VERIFICATION PROCESS
|
|
@@ -31122,7 +31122,7 @@ components:
|
|
|
31122
31122
|
"method": "token",
|
|
31123
31123
|
"path": "meta.nextToken",
|
|
31124
31124
|
"pathLocation": "body",
|
|
31125
|
-
"token": "
|
|
31125
|
+
"token": "<next-page-token>"
|
|
31126
31126
|
}
|
|
31127
31127
|
|
|
31128
31128
|
// For APIs requiring an initial token:
|
|
@@ -31165,7 +31165,7 @@ components:
|
|
|
31165
31165
|
|
|
31166
31166
|
Example header:
|
|
31167
31167
|
```
|
|
31168
|
-
X-Pagination-Token:
|
|
31168
|
+
X-Pagination-Token: <next-page-token>
|
|
31169
31169
|
```
|
|
31170
31170
|
Correct path: "X-Pagination-Token"
|
|
31171
31171
|
|
package/package.json
CHANGED