@celigo/api-specs 0.2.18 → 0.2.19
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/iclient.yml +23 -60
- package/package.json +1 -1
- package/schemas.json +2 -2
package/dist/iclient.yml
CHANGED
|
@@ -1744,73 +1744,36 @@ components:
|
|
|
1744
1744
|
items:
|
|
1745
1745
|
type: string
|
|
1746
1746
|
description: |-
|
|
1747
|
-
|
|
1748
|
-
|
|
1747
|
+
Registrable domains (`domain.com`, `domain.co.uk` — the host with its
|
|
1748
|
+
subdomains removed) of the OAuth URLs this client's credentials are
|
|
1749
|
+
sent to: the access token, authorization, and revoke URLs. Before an
|
|
1750
|
+
OAuth request leaves integrator.io, the target URL's registrable
|
|
1751
|
+
domain must appear here; a full hostname never matches.
|
|
1749
1752
|
examples:
|
|
1750
1753
|
- - domain.com
|
|
1751
1754
|
- - domain.com
|
|
1752
1755
|
- domain1.com
|
|
1753
1756
|
- domain2.com
|
|
1757
|
+
- - microsoftonline.com
|
|
1758
|
+
- microsoft.com
|
|
1754
1759
|
x-celigo-ai-guidance:
|
|
1755
1760
|
- |-
|
|
1756
|
-
|
|
1757
|
-
|
|
1758
|
-
|
|
1759
|
-
|
|
1760
|
-
|
|
1761
|
-
|
|
1762
|
-
|
|
1763
|
-
|
|
1764
|
-
|
|
1765
|
-
|
|
1766
|
-
|
|
1767
|
-
|
|
1768
|
-
|
|
1769
|
-
|
|
1770
|
-
|
|
1771
|
-
|
|
1772
|
-
- Stored as an array of strings.
|
|
1773
|
-
- |-
|
|
1774
|
-
## FIELD BEHAVIOR:
|
|
1775
|
-
- Array of domain names (no scheme, no path).
|
|
1776
|
-
- Used to validate the OAuth URL domains (authorization/token/revoke).
|
|
1777
|
-
- Provide each unique domain once.
|
|
1778
|
-
- |-
|
|
1779
|
-
## DEPENDENCY CHAIN:
|
|
1780
|
-
- Used alongside `oauth2.auth.uri`, `oauth2.token.uri`, and `oauth2.revoke.uri`.
|
|
1781
|
-
- |-
|
|
1782
|
-
## IMPLEMENTATION GUIDANCE:
|
|
1783
|
-
- Extract the domain portion from each OAuth URL and include it here.
|
|
1784
|
-
- Do not include `https://` or any URL path/query—only the domain.
|
|
1785
|
-
- Keep this list in sync if any OAuth URLs change.
|
|
1786
|
-
- |-
|
|
1787
|
-
## EXAMPLES:
|
|
1788
|
-
- ["domain.com"]
|
|
1789
|
-
- ["domain.com", "domain1.com", "domain2.com"]
|
|
1790
|
-
- |-
|
|
1791
|
-
## IMPORTANT NOTES:
|
|
1792
|
-
- This is about **domains** for OAuth URLs, not full URLs.
|
|
1793
|
-
- |-
|
|
1794
|
-
Example: if your URLs are:
|
|
1795
|
-
- `https://<AccessTokenURL>.domain.com`
|
|
1796
|
-
- `https://<RevokeTokenURL>.domain1.com`
|
|
1797
|
-
- `https://<AuthorizationURL>.domain2.com`
|
|
1798
|
-
- |-
|
|
1799
|
-
Set this to the list of unique domain names used to validate the OAuth URLs (Authorization,
|
|
1800
|
-
Access Token, Revoke Token).
|
|
1801
|
-
In the UI, enter each unique domain name as comma-separated values;
|
|
1802
|
-
if the same domain is used for each URL, provide it only once.
|
|
1803
|
-
For multiple domains, set this to `["domain.com", "domain1.com",
|
|
1804
|
-
"domain2.com"]`; if all URLs share the same domain (e.g.
|
|
1805
|
-
`domain.com`), set this to `["domain.com"]`.
|
|
1806
|
-
- |-
|
|
1807
|
-
Set this to the list of unique domain names used to validate the OAuth URLs (Authorization,
|
|
1808
|
-
Access Token, Revoke Token).
|
|
1809
|
-
In the UI, enter each unique domain name as comma-separated values;
|
|
1810
|
-
if the same domain is used for each URL, provide it only once.
|
|
1811
|
-
For multiple domains, set this to `["domain.com", "domain1.com",
|
|
1812
|
-
"domain2.com"]`; if all URLs share the same domain (e.g.
|
|
1813
|
-
`domain.com`), set this to `["domain.com"]`.
|
|
1761
|
+
Store the registrable domain, never the hostname. For the token URL
|
|
1762
|
+
`https://login.microsoftonline.com/<tenant>/oauth2/v2.0/token` the entry is
|
|
1763
|
+
`microsoftonline.com`; `login.microsoftonline.com` fails the connection test with
|
|
1764
|
+
`[invalid_domain] The domain of request url should be present in
|
|
1765
|
+
iClient.oauth2.validDomainNames` and no request is sent. Public suffixes are
|
|
1766
|
+
honoured: `auth.example.co.uk` → `example.co.uk`, not `co.uk`.
|
|
1767
|
+
- |-
|
|
1768
|
+
List the registrable domain of every OAuth URL on the client (token, authorization,
|
|
1769
|
+
revoke) once each — a missing token-URL domain is what blocks the connection.
|
|
1770
|
+
Celigo's connector setup guides also list the API host's registrable domain next to
|
|
1771
|
+
them (Microsoft: `microsoftonline.com`, `microsoft.com`); include it to match the
|
|
1772
|
+
guides — an extra entry is harmless.
|
|
1773
|
+
- |-
|
|
1774
|
+
When a connection using this client reports `[invalid_domain]`, the fix is this
|
|
1775
|
+
field — replace hostnames with registrable domains. The connection's base URI and
|
|
1776
|
+
ping path are where the request goes, not where the allow-list lives.
|
|
1814
1777
|
failPath:
|
|
1815
1778
|
type: string
|
|
1816
1779
|
description: |-
|
package/package.json
CHANGED