@celigo/api-specs 0.2.118 → 0.2.120

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 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
- - 00D4P000000zT1P!ARsAQ[fake-access-token]
5506
+ - <org-id>!<session-token>
5507
5507
  x-celigo-ai-guidance:
5508
5508
  - |-
5509
5509
  OAuth access/bearer token (encrypted at rest).
@@ -5642,12 +5642,12 @@ components:
5642
5642
  description: |-
5643
5643
  SSH private key for SFTP key-based authentication (encrypted at rest; returned masked as `"******"`).
5644
5644
  Only used when type is "sftp"; can be used alone or alongside a password. Must be an RSA (SSH-2) key
5645
- in PEM format, supplied whole from its BEGIN line to its END line — OpenSSH-format keys (first line
5646
- `-----BEGIN OPENSSH PRIVATE KEY-----`), passphrase-protected keys, SSH-1 keys and PuTTY `.ppk` files
5645
+ in PEM format, supplied whole from its BEGIN line to its END line — OpenSSH-format keys (a first
5646
+ line that names an OPENSSH PRIVATE KEY), passphrase-protected keys, SSH-1 keys and PuTTY `.ppk` files
5647
5647
  are not supported and must be converted to an unencrypted PEM key first.
5648
5648
  x-celigo-ai-guidance:
5649
5649
  - Never take the key through chat; write a placeholder the user replaces in the connection editor. The matching public key must be in the server's authorized_keys for the username — Celigo holds only the private half.
5650
- - A key whose first line is `-----BEGIN OPENSSH PRIVATE KEY-----`, or one that asks for a passphrase, is outside the supported format per the Help Center; `ssh-keygen -p -m PEM -f <key>` rewrites it as PEM (`-N ""` also removes the passphrase).
5650
+ - A key whose first line names an OPENSSH PRIVATE KEY, or one that asks for a passphrase, is outside the supported format per the Help Center; `ssh-keygen -p -m PEM -f <key>` rewrites it as PEM (`-N ""` also removes the passphrase).
5651
5651
  writeOnly: true
5652
5652
  usePassiveMode:
5653
5653
  type: boolean
@@ -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
- - AKIAIOSFODNN7EXAMPLE
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
@@ -6303,7 +6303,7 @@ components:
6303
6303
  Pre-generated static JWT to use instead of building one from payload (encrypted at rest).
6304
6304
  Use only when the API issues a long-lived JWT that does not need regeneration.
6305
6305
  examples:
6306
- - eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJpc3MiOiJzdmMifQ.EXAMPLEsignature
6306
+ - eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.EXAMPLEpayload.EXAMPLEsignature
6307
6307
  x-celigo-ai-guidance:
6308
6308
  - |-
6309
6309
  Pre-generated JWT token value (encrypted at rest).
@@ -6795,7 +6795,7 @@ components:
6795
6795
  The API key or bearer token value (encrypted at rest); returned masked as `"******"`.
6796
6796
  Required unless automatic token refresh is configured.
6797
6797
  examples:
6798
- - sk_live_abc123EXAMPLE456token
6798
+ - my-api-token-EXAMPLE
6799
6799
  location:
6800
6800
  type: string
6801
6801
  enum:
@@ -7876,7 +7876,7 @@ components:
7876
7876
  type: string
7877
7877
  description: AWS access key ID for IAM authentication.
7878
7878
  examples:
7879
- - AKIAIOSFODNN7EXAMPLE
7879
+ - AKIA_EXAMPLE_KEY_ID
7880
7880
  secretAccessKey:
7881
7881
  type: string
7882
7882
  description: AWS secret access key (encrypted at rest).
@@ -8999,7 +8999,7 @@ components:
8999
8999
  The API key or bearer token value (encrypted at rest); returned masked as `"******"`.
9000
9000
  Required unless automatic token refresh is configured.
9001
9001
  examples:
9002
- - sk_live_abc123EXAMPLE456token
9002
+ - my-api-token-EXAMPLE
9003
9003
  location:
9004
9004
  type: string
9005
9005
  enum:
@@ -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
- - AKIAIOSFODNN7EXAMPLE
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 `"******"`.
@@ -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
- - 00D4P000000zT1P!ARsAQ[fake-access-token]
4617
+ - <org-id>!<session-token>
4618
4618
  x-celigo-ai-guidance:
4619
4619
  - |-
4620
4620
  OAuth access/bearer token (encrypted at rest).
@@ -4753,12 +4753,12 @@ components:
4753
4753
  description: |-
4754
4754
  SSH private key for SFTP key-based authentication (encrypted at rest; returned masked as `"******"`).
4755
4755
  Only used when type is "sftp"; can be used alone or alongside a password. Must be an RSA (SSH-2) key
4756
- in PEM format, supplied whole from its BEGIN line to its END line — OpenSSH-format keys (first line
4757
- `-----BEGIN OPENSSH PRIVATE KEY-----`), passphrase-protected keys, SSH-1 keys and PuTTY `.ppk` files
4756
+ in PEM format, supplied whole from its BEGIN line to its END line — OpenSSH-format keys (a first
4757
+ line that names an OPENSSH PRIVATE KEY), passphrase-protected keys, SSH-1 keys and PuTTY `.ppk` files
4758
4758
  are not supported and must be converted to an unencrypted PEM key first.
4759
4759
  x-celigo-ai-guidance:
4760
4760
  - Never take the key through chat; write a placeholder the user replaces in the connection editor. The matching public key must be in the server's authorized_keys for the username — Celigo holds only the private half.
4761
- - A key whose first line is `-----BEGIN OPENSSH PRIVATE KEY-----`, or one that asks for a passphrase, is outside the supported format per the Help Center; `ssh-keygen -p -m PEM -f <key>` rewrites it as PEM (`-N ""` also removes the passphrase).
4761
+ - A key whose first line names an OPENSSH PRIVATE KEY, or one that asks for a passphrase, is outside the supported format per the Help Center; `ssh-keygen -p -m PEM -f <key>` rewrites it as PEM (`-N ""` also removes the passphrase).
4762
4762
  writeOnly: true
4763
4763
  usePassiveMode:
4764
4764
  type: boolean
@@ -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
- - AKIAIOSFODNN7EXAMPLE
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
@@ -5414,7 +5414,7 @@ components:
5414
5414
  Pre-generated static JWT to use instead of building one from payload (encrypted at rest).
5415
5415
  Use only when the API issues a long-lived JWT that does not need regeneration.
5416
5416
  examples:
5417
- - eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJpc3MiOiJzdmMifQ.EXAMPLEsignature
5417
+ - eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.EXAMPLEpayload.EXAMPLEsignature
5418
5418
  x-celigo-ai-guidance:
5419
5419
  - |-
5420
5420
  Pre-generated JWT token value (encrypted at rest).
@@ -5906,7 +5906,7 @@ components:
5906
5906
  The API key or bearer token value (encrypted at rest); returned masked as `"******"`.
5907
5907
  Required unless automatic token refresh is configured.
5908
5908
  examples:
5909
- - sk_live_abc123EXAMPLE456token
5909
+ - my-api-token-EXAMPLE
5910
5910
  location:
5911
5911
  type: string
5912
5912
  enum:
@@ -6987,7 +6987,7 @@ components:
6987
6987
  type: string
6988
6988
  description: AWS access key ID for IAM authentication.
6989
6989
  examples:
6990
- - AKIAIOSFODNN7EXAMPLE
6990
+ - AKIA_EXAMPLE_KEY_ID
6991
6991
  secretAccessKey:
6992
6992
  type: string
6993
6993
  description: AWS secret access key (encrypted at rest).
@@ -8110,7 +8110,7 @@ components:
8110
8110
  The API key or bearer token value (encrypted at rest); returned masked as `"******"`.
8111
8111
  Required unless automatic token refresh is configured.
8112
8112
  examples:
8113
- - sk_live_abc123EXAMPLE456token
8113
+ - my-api-token-EXAMPLE
8114
8114
  location:
8115
8115
  type: string
8116
8116
  enum:
@@ -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
- - AKIAIOSFODNN7EXAMPLE
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
- - 00D4P000000zT1P!ARsAQ[fake-access-token]
2718
+ - <org-id>!<session-token>
2719
2719
  x-celigo-ai-guidance:
2720
2720
  - |-
2721
2721
  OAuth access/bearer token (encrypted at rest).
@@ -2854,12 +2854,12 @@ components:
2854
2854
  description: |-
2855
2855
  SSH private key for SFTP key-based authentication (encrypted at rest; returned masked as `"******"`).
2856
2856
  Only used when type is "sftp"; can be used alone or alongside a password. Must be an RSA (SSH-2) key
2857
- in PEM format, supplied whole from its BEGIN line to its END line — OpenSSH-format keys (first line
2858
- `-----BEGIN OPENSSH PRIVATE KEY-----`), passphrase-protected keys, SSH-1 keys and PuTTY `.ppk` files
2857
+ in PEM format, supplied whole from its BEGIN line to its END line — OpenSSH-format keys (a first
2858
+ line that names an OPENSSH PRIVATE KEY), passphrase-protected keys, SSH-1 keys and PuTTY `.ppk` files
2859
2859
  are not supported and must be converted to an unencrypted PEM key first.
2860
2860
  x-celigo-ai-guidance:
2861
2861
  - Never take the key through chat; write a placeholder the user replaces in the connection editor. The matching public key must be in the server's authorized_keys for the username — Celigo holds only the private half.
2862
- - A key whose first line is `-----BEGIN OPENSSH PRIVATE KEY-----`, or one that asks for a passphrase, is outside the supported format per the Help Center; `ssh-keygen -p -m PEM -f <key>` rewrites it as PEM (`-N ""` also removes the passphrase).
2862
+ - A key whose first line names an OPENSSH PRIVATE KEY, or one that asks for a passphrase, is outside the supported format per the Help Center; `ssh-keygen -p -m PEM -f <key>` rewrites it as PEM (`-N ""` also removes the passphrase).
2863
2863
  writeOnly: true
2864
2864
  usePassiveMode:
2865
2865
  type: boolean
@@ -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
- - AKIAIOSFODNN7EXAMPLE
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
@@ -3515,7 +3515,7 @@ components:
3515
3515
  Pre-generated static JWT to use instead of building one from payload (encrypted at rest).
3516
3516
  Use only when the API issues a long-lived JWT that does not need regeneration.
3517
3517
  examples:
3518
- - eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJpc3MiOiJzdmMifQ.EXAMPLEsignature
3518
+ - eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.EXAMPLEpayload.EXAMPLEsignature
3519
3519
  x-celigo-ai-guidance:
3520
3520
  - |-
3521
3521
  Pre-generated JWT token value (encrypted at rest).
@@ -4007,7 +4007,7 @@ components:
4007
4007
  The API key or bearer token value (encrypted at rest); returned masked as `"******"`.
4008
4008
  Required unless automatic token refresh is configured.
4009
4009
  examples:
4010
- - sk_live_abc123EXAMPLE456token
4010
+ - my-api-token-EXAMPLE
4011
4011
  location:
4012
4012
  type: string
4013
4013
  enum:
@@ -5088,7 +5088,7 @@ components:
5088
5088
  type: string
5089
5089
  description: AWS access key ID for IAM authentication.
5090
5090
  examples:
5091
- - AKIAIOSFODNN7EXAMPLE
5091
+ - AKIA_EXAMPLE_KEY_ID
5092
5092
  secretAccessKey:
5093
5093
  type: string
5094
5094
  description: AWS secret access key (encrypted at rest).
@@ -6211,7 +6211,7 @@ components:
6211
6211
  The API key or bearer token value (encrypted at rest); returned masked as `"******"`.
6212
6212
  Required unless automatic token refresh is configured.
6213
6213
  examples:
6214
- - sk_live_abc123EXAMPLE456token
6214
+ - my-api-token-EXAMPLE
6215
6215
  location:
6216
6216
  type: string
6217
6217
  enum:
@@ -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
- - AKIAIOSFODNN7EXAMPLE
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": "3a7c4f8b2e9d1a5c6b3e7d9fEXAMPLE"
1717
+ "token": "<32+ random characters>"
1718
1718
  ```
1719
1719
 
1720
1720
  ```
1721
- "token": "whsec_8fb2e91a5c6b3e7dEXAMPLE"
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": "xyz123" } }
1978
+ "path": "meta.token" // For { "meta": { "token": "<token>" } }
1979
1979
  ```
1980
1980
 
1981
1981
  ```
1982
- "path": "verification.key" // For { "verification": { "key": "xyz123" } }
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": "xyz123", "data": {...} }
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=xyz123
1998
+ "path": "verify_token" // For /webhook?verify_token=<token>
1999
1999
  ```
2000
2000
  - |-
2001
2001
  ## VERIFICATION PROCESS
@@ -5806,7 +5806,7 @@ components:
5806
5806
  - eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...
5807
5807
  - sk-1234567890abcdef
5808
5808
  examples:
5809
- - bearerToken: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c
5809
+ - bearerToken: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.EXAMPLEpayload.EXAMPLEsignature
5810
5810
  Cdc:
5811
5811
  type: object
5812
5812
  description: |-
@@ -6888,7 +6888,7 @@ components:
6888
6888
  "method": "token",
6889
6889
  "path": "meta.nextToken",
6890
6890
  "pathLocation": "body",
6891
- "token": "eyJwYWdlIjozfQ=="
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: abc123
6934
+ X-Pagination-Token: <next-page-token>
6935
6935
  ```
6936
6936
  Correct path: "X-Pagination-Token"
6937
6937
 
package/dist/iclient.yml CHANGED
@@ -98,7 +98,7 @@ paths:
98
98
  enableIClientReferences: false
99
99
  formType: assistant
100
100
  oauth2:
101
- clientId: 1096775564568-cucr5sv44tgfec4kkqsufi5k975d8orv.apps.googleusercontent.com
101
+ clientId: 123456789012-EXAMPLE.apps.googleusercontent.com
102
102
  clientSecret: '******'
103
103
  scope: []
104
104
  scopeDelimiter: ' '
@@ -299,7 +299,7 @@ paths:
299
299
  enableIClientReferences: false
300
300
  formType: assistant
301
301
  oauth2:
302
- clientId: 1096775564568-cucr5sv44tgfec4kkqsufi5k975d8orv.apps.googleusercontent.com
302
+ clientId: 123456789012-EXAMPLE.apps.googleusercontent.com
303
303
  clientSecret: '******'
304
304
  scope: []
305
305
  scopeDelimiter: ' '
@@ -1156,7 +1156,7 @@ components:
1156
1156
  It is a public value that is included in authorization requests and token
1157
1157
  exchanges to associate the requests with the registered client.
1158
1158
  examples:
1159
- - 1096775564568-cucr5sv44tgfec4kkqsufi5k975d8orv.apps.googleusercontent.com
1159
+ - 123456789012-EXAMPLE.apps.googleusercontent.com
1160
1160
  - abc123xyz
1161
1161
  - myapp-client-001
1162
1162
  - 1234567890abcdef
@@ -2326,8 +2326,7 @@ components:
2326
2326
  - |-
2327
2327
  ## EXAMPLES:
2328
2328
  - "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9..."
2329
- - "2YotnFZFEjr1zCsicMWpAA"
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=xyz123&client_id=abc&client_secret=secret
2703
- - grant_type=refresh_token&refresh_token=def456
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=xyz123&client_id=abc&client_secret=secret
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=SlAV32hkKG
2931
- - token=34xkj23j4k23&token_type_hint=refresh_token
2932
- - token=abcdef123456&token_type_hint=access_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=SlAV32hkKG
2961
- - token=34xkj23j4k23&token_type_hint=refresh_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.
@@ -3072,8 +3069,8 @@ components:
3072
3069
  x-celigo-ai-guidance:
3073
3070
  - |-
3074
3071
  ## EXAMPLES:
3075
- - `{"password":"my-password-EXAMPLE"}`
3076
- - `{"token":"x7if4nkovhgr63ghp"}`
3072
+ - `{"password":"<password>"}`
3073
+ - `{"token":"<api-token>"}`
3077
3074
  - |-
3078
3075
  ## IMPORTANT NOTES:
3079
3076
  - Use this for secrets (passwords, tokens, keys).
@@ -3297,8 +3294,7 @@ components:
3297
3294
  of the client application.
3298
3295
  - |-
3299
3296
  ## EXAMPLES:
3300
- - "3MVG9d6T2QxX9z5l7Y8P0qR1sT2uVwXyZAbCdEfGhIjKlMnOpQrStUvWxYz123456"
3301
- - "1234567890abcdef1234567890abcdef1234567890abcdef1234567890abcdef"
3297
+ - "3MVG9-EXAMPLE-consumer-key"
3302
3298
  - |-
3303
3299
  ## IMPORTANT NOTES:
3304
3300
  - The clientId alone does not grant access; it must be paired with appropriate credentials and tokens.
@@ -3330,9 +3326,7 @@ components:
3330
3326
  It is essential for enabling authorized access to Salesforce resources on behalf
3331
3327
  of the client application.
3332
3328
  examples:
3333
- - 3MVG9pRzvMkjMb6kkUMc3nVfDlF1H9V8sV0kZ8wQ7nC2x
3334
- - 3MVG9d6T2QxX9z5l7Y8P0qR1sT2uVwXyZAbCdEfGhIjKlMnOpQrStUvWxYz123456
3335
- - 1234567890abcdef1234567890abcdef1234567890abcdef1234567890abcdef
3329
+ - 3MVG9-EXAMPLE-consumer-key
3336
3330
  clientSecret:
3337
3331
  type: string
3338
3332
  description: |-
@@ -3380,7 +3374,7 @@ components:
3380
3374
  - Different Salesforce environments (sandbox vs production) may require different tokens.
3381
3375
  - |-
3382
3376
  ## EXAMPLES:
3383
- - A long alphanumeric string like "00Dxx0000001gPFEAY!AQ0AQJ..."
3377
+ - A long string that starts with the org ID, an exclamation mark, and then the session token
3384
3378
  - OAuth access tokens obtained via Salesforce OAuth 2.0 flows.
3385
3379
  - Tokens generated from Salesforce connected apps for API access.
3386
3380
  - |-
@@ -3789,10 +3783,10 @@ components:
3789
3783
  authorization, and interaction with various Amazon MWS endpoints.
3790
3784
  - |-
3791
3785
  ## EXAMPLES:
3792
- - Access Key ID: "AKIAIOSFODNN7EXAMPLE"
3793
- - Secret Access Key: "1234567890abcdef1234567890abcdef12345678"
3794
- - Seller ID: "A1XEXAMPLE123"
3795
- - MWS Auth Token: "amzn.mws.4ea38b7b-f563-7709-4bae-87aeaEXAMPLE"
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
3796
3790
  - |-
3797
3791
  ## FIELD BEHAVIOR:
3798
3792
  - Contains all necessary authentication credentials such as Access Key ID, Secret Access Key, Seller ID, and MWS Auth Token.
@@ -3847,9 +3841,7 @@ components:
3847
3841
  - Used alongside other credentials such as Seller ID and MWS Auth Token for full API access.
3848
3842
  - |-
3849
3843
  ## EXAMPLES:
3850
- - "AKIAIOSFODNN7EXAMPLE"
3851
- - "ABCD1234EFGH5678IJKL"
3852
- - "A1B2C3D4E5F6G7H8I9J0"
3844
+ - "AKIA_EXAMPLE_KEY_ID"
3853
3845
  - |-
3854
3846
  ## IMPORTANT NOTES:
3855
3847
  - The Access Key ID alone is insufficient for authentication; it must be paired with the Secret Access Key.
@@ -3896,9 +3888,7 @@ components:
3896
3888
  enabling operations such as order retrieval, inventory management,
3897
3889
  and report generation.
3898
3890
  examples:
3899
- - AKIAIOSFODNN7EXAMPLE
3900
- - ABCD1234EFGH5678IJKL
3901
- - A1B2C3D4E5F6G7H8I9J0
3891
+ - AKIA_EXAMPLE_KEY_ID
3902
3892
  secretKey:
3903
3893
  type: string
3904
3894
  description: |-
@@ -3997,9 +3987,9 @@ components:
3997
3987
  if it is unencrypted, sending certificatePassword is rejected.
3998
3988
  - |-
3999
3989
  The save does not check that the PEM is a usable credential — a placeholder PEM
4000
- carrying the BEGIN CERTIFICATE and BEGIN PRIVATE KEY blocks saves (live-verified
4001
- 201). Enter the real PEM in the iClient editor before testing a connection that
4002
- uses the iClient.
3990
+ carrying a certificate block and a private-key block saves (live-verified 201).
3991
+ Enter the real PEM in the iClient editor before testing a connection that uses
3992
+ the iClient.
4003
3993
  certificatePassword:
4004
3994
  type: string
4005
3995
  description: |-
@@ -4026,11 +4016,10 @@ components:
4026
4016
  description: |-
4027
4017
  Google service-account key file, sent as a JSON string. The save
4028
4018
  reads `project_id`, `client_email`, and a `private_key` that
4029
- includes its PEM armor (`-----BEGIN PRIVATE KEY-----` through
4030
- `-----END PRIVATE KEY-----`). Missing, empty, or incomplete JSON
4031
- fails with 422 `invalid_json_key`. Send the full key on every
4032
- create and every update — omitting it or sending `"******"`
4033
- fails the same way.
4019
+ includes its PEM armor (its BEGIN and END PRIVATE KEY lines).
4020
+ Missing, empty, or incomplete JSON fails with 422
4021
+ `invalid_json_key`. Send the full key on every create and every
4022
+ update — omitting it or sending `"******"` fails the same way.
4034
4023
  x-celigo-ai-guidance:
4035
4024
  - |-
4036
4025
  A placeholder body inside the PEM armor is accepted on create.
@@ -4135,8 +4124,8 @@ components:
4135
4124
  - Be aware of token expiration and implement proper handling for expired tokens.
4136
4125
  - |-
4137
4126
  ## EXAMPLES:
4138
- - eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c
4139
- - eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJpc3MiOiJleGFtcGxlLmNvbSIsInN1YiI6IjEyMzQ1Njc4OTAiLCJleHAiOjE2MjQ2MjQwMDB9.EXAMPLEsignature
4127
+ - eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.EXAMPLEpayload.EXAMPLEsignature
4128
+ - eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.EXAMPLEpayload.EXAMPLEsignature
4140
4129
  - |-
4141
4130
  ## DEPENDENCY CHAIN:
4142
4131
  - Depends on the authentication mechanism generating the JWT.
@@ -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
- - 00D4P000000zT1P!ARsAQ[fake-access-token]
4543
+ - <org-id>!<session-token>
4544
4544
  x-celigo-ai-guidance:
4545
4545
  - |-
4546
4546
  OAuth access/bearer token (encrypted at rest).
@@ -4679,12 +4679,12 @@ components:
4679
4679
  description: |-
4680
4680
  SSH private key for SFTP key-based authentication (encrypted at rest; returned masked as `"******"`).
4681
4681
  Only used when type is "sftp"; can be used alone or alongside a password. Must be an RSA (SSH-2) key
4682
- in PEM format, supplied whole from its BEGIN line to its END line — OpenSSH-format keys (first line
4683
- `-----BEGIN OPENSSH PRIVATE KEY-----`), passphrase-protected keys, SSH-1 keys and PuTTY `.ppk` files
4682
+ in PEM format, supplied whole from its BEGIN line to its END line — OpenSSH-format keys (a first
4683
+ line that names an OPENSSH PRIVATE KEY), passphrase-protected keys, SSH-1 keys and PuTTY `.ppk` files
4684
4684
  are not supported and must be converted to an unencrypted PEM key first.
4685
4685
  x-celigo-ai-guidance:
4686
4686
  - Never take the key through chat; write a placeholder the user replaces in the connection editor. The matching public key must be in the server's authorized_keys for the username — Celigo holds only the private half.
4687
- - A key whose first line is `-----BEGIN OPENSSH PRIVATE KEY-----`, or one that asks for a passphrase, is outside the supported format per the Help Center; `ssh-keygen -p -m PEM -f <key>` rewrites it as PEM (`-N ""` also removes the passphrase).
4687
+ - A key whose first line names an OPENSSH PRIVATE KEY, or one that asks for a passphrase, is outside the supported format per the Help Center; `ssh-keygen -p -m PEM -f <key>` rewrites it as PEM (`-N ""` also removes the passphrase).
4688
4688
  writeOnly: true
4689
4689
  usePassiveMode:
4690
4690
  type: boolean
@@ -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
- - AKIAIOSFODNN7EXAMPLE
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
@@ -5340,7 +5340,7 @@ components:
5340
5340
  Pre-generated static JWT to use instead of building one from payload (encrypted at rest).
5341
5341
  Use only when the API issues a long-lived JWT that does not need regeneration.
5342
5342
  examples:
5343
- - eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJpc3MiOiJzdmMifQ.EXAMPLEsignature
5343
+ - eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.EXAMPLEpayload.EXAMPLEsignature
5344
5344
  x-celigo-ai-guidance:
5345
5345
  - |-
5346
5346
  Pre-generated JWT token value (encrypted at rest).
@@ -5832,7 +5832,7 @@ components:
5832
5832
  The API key or bearer token value (encrypted at rest); returned masked as `"******"`.
5833
5833
  Required unless automatic token refresh is configured.
5834
5834
  examples:
5835
- - sk_live_abc123EXAMPLE456token
5835
+ - my-api-token-EXAMPLE
5836
5836
  location:
5837
5837
  type: string
5838
5838
  enum:
@@ -6913,7 +6913,7 @@ components:
6913
6913
  type: string
6914
6914
  description: AWS access key ID for IAM authentication.
6915
6915
  examples:
6916
- - AKIAIOSFODNN7EXAMPLE
6916
+ - AKIA_EXAMPLE_KEY_ID
6917
6917
  secretAccessKey:
6918
6918
  type: string
6919
6919
  description: AWS secret access key (encrypted at rest).
@@ -8036,7 +8036,7 @@ components:
8036
8036
  The API key or bearer token value (encrypted at rest); returned masked as `"******"`.
8037
8037
  Required unless automatic token refresh is configured.
8038
8038
  examples:
8039
- - sk_live_abc123EXAMPLE456token
8039
+ - my-api-token-EXAMPLE
8040
8040
  location:
8041
8041
  type: string
8042
8042
  enum:
@@ -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
- - AKIAIOSFODNN7EXAMPLE
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
- - 00D4P000000zT1P!ARsAQ[fake-access-token]
7872
+ - <org-id>!<session-token>
7873
7873
  x-celigo-ai-guidance:
7874
7874
  - |-
7875
7875
  OAuth access/bearer token (encrypted at rest).
@@ -8008,12 +8008,12 @@ components:
8008
8008
  description: |-
8009
8009
  SSH private key for SFTP key-based authentication (encrypted at rest; returned masked as `"******"`).
8010
8010
  Only used when type is "sftp"; can be used alone or alongside a password. Must be an RSA (SSH-2) key
8011
- in PEM format, supplied whole from its BEGIN line to its END line — OpenSSH-format keys (first line
8012
- `-----BEGIN OPENSSH PRIVATE KEY-----`), passphrase-protected keys, SSH-1 keys and PuTTY `.ppk` files
8011
+ in PEM format, supplied whole from its BEGIN line to its END line — OpenSSH-format keys (a first
8012
+ line that names an OPENSSH PRIVATE KEY), passphrase-protected keys, SSH-1 keys and PuTTY `.ppk` files
8013
8013
  are not supported and must be converted to an unencrypted PEM key first.
8014
8014
  x-celigo-ai-guidance:
8015
8015
  - Never take the key through chat; write a placeholder the user replaces in the connection editor. The matching public key must be in the server's authorized_keys for the username — Celigo holds only the private half.
8016
- - A key whose first line is `-----BEGIN OPENSSH PRIVATE KEY-----`, or one that asks for a passphrase, is outside the supported format per the Help Center; `ssh-keygen -p -m PEM -f <key>` rewrites it as PEM (`-N ""` also removes the passphrase).
8016
+ - A key whose first line names an OPENSSH PRIVATE KEY, or one that asks for a passphrase, is outside the supported format per the Help Center; `ssh-keygen -p -m PEM -f <key>` rewrites it as PEM (`-N ""` also removes the passphrase).
8017
8017
  writeOnly: true
8018
8018
  usePassiveMode:
8019
8019
  type: boolean
@@ -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
- - AKIAIOSFODNN7EXAMPLE
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
@@ -8669,7 +8669,7 @@ components:
8669
8669
  Pre-generated static JWT to use instead of building one from payload (encrypted at rest).
8670
8670
  Use only when the API issues a long-lived JWT that does not need regeneration.
8671
8671
  examples:
8672
- - eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJpc3MiOiJzdmMifQ.EXAMPLEsignature
8672
+ - eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.EXAMPLEpayload.EXAMPLEsignature
8673
8673
  x-celigo-ai-guidance:
8674
8674
  - |-
8675
8675
  Pre-generated JWT token value (encrypted at rest).
@@ -9161,7 +9161,7 @@ components:
9161
9161
  The API key or bearer token value (encrypted at rest); returned masked as `"******"`.
9162
9162
  Required unless automatic token refresh is configured.
9163
9163
  examples:
9164
- - sk_live_abc123EXAMPLE456token
9164
+ - my-api-token-EXAMPLE
9165
9165
  location:
9166
9166
  type: string
9167
9167
  enum:
@@ -10242,7 +10242,7 @@ components:
10242
10242
  type: string
10243
10243
  description: AWS access key ID for IAM authentication.
10244
10244
  examples:
10245
- - AKIAIOSFODNN7EXAMPLE
10245
+ - AKIA_EXAMPLE_KEY_ID
10246
10246
  secretAccessKey:
10247
10247
  type: string
10248
10248
  description: AWS secret access key (encrypted at rest).
@@ -11365,7 +11365,7 @@ components:
11365
11365
  The API key or bearer token value (encrypted at rest); returned masked as `"******"`.
11366
11366
  Required unless automatic token refresh is configured.
11367
11367
  examples:
11368
- - sk_live_abc123EXAMPLE456token
11368
+ - my-api-token-EXAMPLE
11369
11369
  location:
11370
11370
  type: string
11371
11371
  enum:
@@ -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
- - AKIAIOSFODNN7EXAMPLE
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": "3a7c4f8b2e9d1a5c6b3e7d9fEXAMPLE"
26368
+ "token": "<32+ random characters>"
26369
26369
  ```
26370
26370
 
26371
26371
  ```
26372
- "token": "whsec_8fb2e91a5c6b3e7dEXAMPLE"
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": "xyz123" } }
26629
+ "path": "meta.token" // For { "meta": { "token": "<token>" } }
26630
26630
  ```
26631
26631
 
26632
26632
  ```
26633
- "path": "verification.key" // For { "verification": { "key": "xyz123" } }
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": "xyz123", "data": {...} }
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=xyz123
26649
+ "path": "verify_token" // For /webhook?verify_token=<token>
26650
26650
  ```
26651
26651
  - |-
26652
26652
  ## VERIFICATION PROCESS
@@ -30040,7 +30040,7 @@ components:
30040
30040
  - eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...
30041
30041
  - sk-1234567890abcdef
30042
30042
  examples:
30043
- - bearerToken: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c
30043
+ - bearerToken: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.EXAMPLEpayload.EXAMPLEsignature
30044
30044
  Cdc:
30045
30045
  type: object
30046
30046
  description: |-
@@ -31122,7 +31122,7 @@ components:
31122
31122
  "method": "token",
31123
31123
  "path": "meta.nextToken",
31124
31124
  "pathLocation": "body",
31125
- "token": "eyJwYWdlIjozfQ=="
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: abc123
31168
+ X-Pagination-Token: <next-page-token>
31169
31169
  ```
31170
31170
  Correct path: "X-Pagination-Token"
31171
31171
 
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@celigo/api-specs",
3
- "version": "0.2.118",
3
+ "version": "0.2.120",
4
4
  "private": false,
5
5
  "description": "Public OpenAPI bundles (dist/) and the celigo-cli lint schema pack (schemas.json).",
6
6
  "keywords": [
package/schemas.json CHANGED
@@ -1,8 +1,8 @@
1
1
  {
2
2
  "provenance": {
3
3
  "repo": "celigo/integrator-api-specs",
4
- "iasCommit": "289007c3",
5
- "generatedAt": "2026-10-16"
4
+ "iasCommit": "a82ea4f6",
5
+ "generatedAt": "2026-10-17"
6
6
  },
7
7
  "roots": {
8
8
  "aiagent": 133,