@celigo/api-specs 0.2.61 → 0.2.63
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/enduser.yml +44 -15
- package/dist/export.yml +39 -0
- package/dist/tool.yml +39 -0
- package/dist/user.yml +42 -3
- package/package.json +1 -1
- package/schemas.json +3 -2
package/dist/enduser.yml
CHANGED
|
@@ -38,8 +38,8 @@ tags:
|
|
|
38
38
|
description: |-
|
|
39
39
|
Groups bundle roles and resource grants so end-user access can be
|
|
40
40
|
managed collectively. End users receive a group's access through
|
|
41
|
-
membership, added manually or synced from an identity provider
|
|
42
|
-
claims.
|
|
41
|
+
membership, added manually or synced from an identity provider (group
|
|
42
|
+
claims at sign-in or a SCIM group push).
|
|
43
43
|
|
|
44
44
|
## Group schema
|
|
45
45
|
|
|
@@ -920,7 +920,8 @@ paths:
|
|
|
920
920
|
description: |-
|
|
921
921
|
Bulk-removes manual memberships from the group. Only manual memberships
|
|
922
922
|
can be removed this way — attempting to remove an IdP-synced membership
|
|
923
|
-
returns 409; change the
|
|
923
|
+
returns 409; change the person's group in the identity provider (its
|
|
924
|
+
group mapping or SCIM group assignment) instead. Uses POST rather than
|
|
924
925
|
DELETE so the request body survives proxies and CDNs. Requires account
|
|
925
926
|
owner or administrator access.
|
|
926
927
|
parameters:
|
|
@@ -1212,11 +1213,12 @@ components:
|
|
|
1212
1213
|
- idp
|
|
1213
1214
|
x-enumDescriptions:
|
|
1214
1215
|
manual: Membership was added by an owner or administrator (invite or group members API)
|
|
1215
|
-
idp: Membership is synced from the identity provider
|
|
1216
|
+
idp: Membership is synced from the identity provider — group claims at sign-in or a SCIM group push
|
|
1216
1217
|
description: |-
|
|
1217
1218
|
How the membership was created. IdP-synced memberships cannot be
|
|
1218
|
-
removed through the group members API — change the
|
|
1219
|
-
instead
|
|
1219
|
+
removed through the group members API — change the person's group in
|
|
1220
|
+
the identity provider instead (its group mapping, or the SCIM group
|
|
1221
|
+
assignment, whichever created the membership).
|
|
1220
1222
|
ResourceGrant:
|
|
1221
1223
|
type: object
|
|
1222
1224
|
description: |-
|
|
@@ -1319,10 +1321,34 @@ components:
|
|
|
1319
1321
|
x-enumDescriptions:
|
|
1320
1322
|
invite: Created through an explicit invite (or by migration from a workspace user)
|
|
1321
1323
|
jit: Provisioned just-in-time on first sign-in through an external IdP
|
|
1322
|
-
scim: Provisioned
|
|
1324
|
+
scim: Provisioned, or adopted from an invited or JIT record, by the identity provider through SCIM
|
|
1323
1325
|
description: |-
|
|
1324
|
-
How this end-user record was created.
|
|
1325
|
-
|
|
1326
|
+
How this end-user record was created. A SCIM push for a person who already has an invited
|
|
1327
|
+
or JIT record adopts it in place, so the value can change to `scim` over the record's life.
|
|
1328
|
+
For a SCIM-managed user the identity provider owns the active state and the IdP-sourced
|
|
1329
|
+
group memberships and roles: `PUT /v1/ashares/{_ashareId}/disable` still toggles `disabled`,
|
|
1330
|
+
but the identity provider's next push re-applies what it holds — deactivate the person or
|
|
1331
|
+
change their groups in the IdP. Direct `resourceGrants` and `manual` memberships are never
|
|
1332
|
+
touched by SCIM.
|
|
1333
|
+
externalId:
|
|
1334
|
+
type: string
|
|
1335
|
+
readOnly: true
|
|
1336
|
+
examples:
|
|
1337
|
+
- 00u1a2b3c4d5e6f7g8h9
|
|
1338
|
+
description: |-
|
|
1339
|
+
Identifier the identity provider uses for this person in its own directory,
|
|
1340
|
+
stored when the record is provisioned through SCIM. Present only when
|
|
1341
|
+
`provisionedBy` is `scim`. SCIM matches people by email, not by this value.
|
|
1342
|
+
_scimIdpConfigId:
|
|
1343
|
+
type: string
|
|
1344
|
+
format: objectId
|
|
1345
|
+
readOnly: true
|
|
1346
|
+
x-celigo-refModel: idpconfigs
|
|
1347
|
+
examples:
|
|
1348
|
+
- 68d1e2f3a4b5c6d7e8f9a0b1
|
|
1349
|
+
description: |-
|
|
1350
|
+
IdP configuration whose SCIM endpoint provisioned this record. Present
|
|
1351
|
+
only when `provisionedBy` is `scim`.
|
|
1326
1352
|
accepted:
|
|
1327
1353
|
type: boolean
|
|
1328
1354
|
description: When true, the end user has completed invite setup (or was JIT-provisioned).
|
|
@@ -1684,9 +1710,11 @@ components:
|
|
|
1684
1710
|
enum:
|
|
1685
1711
|
- invite
|
|
1686
1712
|
- jit
|
|
1713
|
+
- scim
|
|
1687
1714
|
x-enumDescriptions:
|
|
1688
1715
|
invite: Created through an explicit invite (or by migration from a workspace user)
|
|
1689
1716
|
jit: Provisioned just-in-time on first sign-in through an external IdP
|
|
1717
|
+
scim: Provisioned, or adopted from an invited or JIT record, by the identity provider through SCIM
|
|
1690
1718
|
description: How the end-user record was created.
|
|
1691
1719
|
groups:
|
|
1692
1720
|
type: array
|
|
@@ -1708,9 +1736,9 @@ components:
|
|
|
1708
1736
|
- manual
|
|
1709
1737
|
- idp
|
|
1710
1738
|
x-enumDescriptions:
|
|
1711
|
-
manual: Membership was added by an owner or administrator
|
|
1712
|
-
idp: Membership is synced from the identity provider
|
|
1713
|
-
description: How the end user's membership in this group was created.
|
|
1739
|
+
manual: Membership was added by an owner or administrator (invite or group members API)
|
|
1740
|
+
idp: Membership is synced from the identity provider — group claims at sign-in or a SCIM group push
|
|
1741
|
+
description: How the end user's membership in this group was created (same rule as `GroupMembership.source` on the end-user record).
|
|
1714
1742
|
roles:
|
|
1715
1743
|
type: array
|
|
1716
1744
|
description: Roles that contributed to the compiled access.
|
|
@@ -7224,9 +7252,10 @@ components:
|
|
|
7224
7252
|
readOnly: true
|
|
7225
7253
|
description: |-
|
|
7226
7254
|
When true, at least one end user's membership in this group is synced
|
|
7227
|
-
from an identity provider
|
|
7228
|
-
IdP-synced memberships cannot be
|
|
7229
|
-
API.
|
|
7255
|
+
from an identity provider — through group claims at sign-in or a SCIM
|
|
7256
|
+
group push. Maintained by the server — IdP-synced memberships cannot be
|
|
7257
|
+
removed through the group members API. Groups a SCIM push names that do
|
|
7258
|
+
not exist yet are created with this flag set and no grants.
|
|
7230
7259
|
createdAt:
|
|
7231
7260
|
type: string
|
|
7232
7261
|
format: date-time
|
package/dist/export.yml
CHANGED
|
@@ -16555,6 +16555,45 @@ components:
|
|
|
16555
16555
|
example:
|
|
16556
16556
|
threshold: 100
|
|
16557
16557
|
prefix: EXP-
|
|
16558
|
+
preParse:
|
|
16559
|
+
type: object
|
|
16560
|
+
x-celigo-agent:
|
|
16561
|
+
- script
|
|
16562
|
+
description: |-
|
|
16563
|
+
Hook that runs on file-based exports after the file is downloaded and before it is
|
|
16564
|
+
parsed: it receives the raw file text as `preParseData` together with `fileMeta` and
|
|
16565
|
+
returns both, modified or not, for the configured parser to read. Used to normalize a
|
|
16566
|
+
non-standard file — fix a header row, strip a preamble, convert a format — before
|
|
16567
|
+
parsing; an exception thrown here fails the run.
|
|
16568
|
+
properties:
|
|
16569
|
+
function:
|
|
16570
|
+
type: string
|
|
16571
|
+
description: Function to invoke within the referenced script.
|
|
16572
|
+
examples:
|
|
16573
|
+
- fixHeader
|
|
16574
|
+
- normalizeFile
|
|
16575
|
+
- convertToCsv
|
|
16576
|
+
_scriptId:
|
|
16577
|
+
type: string
|
|
16578
|
+
format: objectId
|
|
16579
|
+
x-celigo-refModel: scripts
|
|
16580
|
+
description: Script containing the hook function named in `function`.
|
|
16581
|
+
examples:
|
|
16582
|
+
- 60a2c4e6f321d800129a1a3c
|
|
16583
|
+
- 5f8e7d2c1b54e6003a9c7e12
|
|
16584
|
+
_stackId:
|
|
16585
|
+
type: string
|
|
16586
|
+
x-celigo-refModel: stacks
|
|
16587
|
+
format: objectId
|
|
16588
|
+
description: Stack that hosts the hook logic, used instead of a script for stack-based deployments.
|
|
16589
|
+
configuration:
|
|
16590
|
+
type: object
|
|
16591
|
+
description: |-
|
|
16592
|
+
Static parameters passed to the hook function at runtime, letting one script be
|
|
16593
|
+
reused across exports with different settings.
|
|
16594
|
+
example:
|
|
16595
|
+
headerRow: 1
|
|
16596
|
+
encoding: utf8
|
|
16558
16597
|
settingsForm:
|
|
16559
16598
|
x-celigo-agent:
|
|
16560
16599
|
- settings_form
|
package/dist/tool.yml
CHANGED
|
@@ -36489,6 +36489,45 @@ components:
|
|
|
36489
36489
|
example:
|
|
36490
36490
|
threshold: 100
|
|
36491
36491
|
prefix: EXP-
|
|
36492
|
+
preParse:
|
|
36493
|
+
type: object
|
|
36494
|
+
x-celigo-agent:
|
|
36495
|
+
- script
|
|
36496
|
+
description: |-
|
|
36497
|
+
Hook that runs on file-based exports after the file is downloaded and before it is
|
|
36498
|
+
parsed: it receives the raw file text as `preParseData` together with `fileMeta` and
|
|
36499
|
+
returns both, modified or not, for the configured parser to read. Used to normalize a
|
|
36500
|
+
non-standard file — fix a header row, strip a preamble, convert a format — before
|
|
36501
|
+
parsing; an exception thrown here fails the run.
|
|
36502
|
+
properties:
|
|
36503
|
+
function:
|
|
36504
|
+
type: string
|
|
36505
|
+
description: Function to invoke within the referenced script.
|
|
36506
|
+
examples:
|
|
36507
|
+
- fixHeader
|
|
36508
|
+
- normalizeFile
|
|
36509
|
+
- convertToCsv
|
|
36510
|
+
_scriptId:
|
|
36511
|
+
type: string
|
|
36512
|
+
format: objectId
|
|
36513
|
+
x-celigo-refModel: scripts
|
|
36514
|
+
description: Script containing the hook function named in `function`.
|
|
36515
|
+
examples:
|
|
36516
|
+
- 60a2c4e6f321d800129a1a3c
|
|
36517
|
+
- 5f8e7d2c1b54e6003a9c7e12
|
|
36518
|
+
_stackId:
|
|
36519
|
+
type: string
|
|
36520
|
+
x-celigo-refModel: stacks
|
|
36521
|
+
format: objectId
|
|
36522
|
+
description: Stack that hosts the hook logic, used instead of a script for stack-based deployments.
|
|
36523
|
+
configuration:
|
|
36524
|
+
type: object
|
|
36525
|
+
description: |-
|
|
36526
|
+
Static parameters passed to the hook function at runtime, letting one script be
|
|
36527
|
+
reused across exports with different settings.
|
|
36528
|
+
example:
|
|
36529
|
+
headerRow: 1
|
|
36530
|
+
encoding: utf8
|
|
36492
36531
|
settingsForm:
|
|
36493
36532
|
x-celigo-agent:
|
|
36494
36533
|
- settings_form
|
package/dist/user.yml
CHANGED
|
@@ -28,8 +28,9 @@ tags:
|
|
|
28
28
|
- **accessLevel** — account-wide role (administrator, manage, monitor, etc.)
|
|
29
29
|
- **integrationAccessLevel** — per-integration overrides for finer control.
|
|
30
30
|
|
|
31
|
-
The account owner is not included — only invited users appear
|
|
32
|
-
|
|
31
|
+
The account owner is not included — only invited users appear, plus any
|
|
32
|
+
the identity provider provisioned through SCIM (`provisionedBy: scim`).
|
|
33
|
+
Users can be disabled (reversible) or permanently removed.
|
|
33
34
|
|
|
34
35
|
## User schema
|
|
35
36
|
|
|
@@ -760,7 +761,8 @@ components:
|
|
|
760
761
|
- lastModified
|
|
761
762
|
description: |-
|
|
762
763
|
A user's access record in the account. Each user who has been invited
|
|
763
|
-
(or shared access)
|
|
764
|
+
(or shared access), or whom the identity provider provisioned through
|
|
765
|
+
SCIM, gets one record per account they belong to. The
|
|
764
766
|
`_id` is the access-record id, not the user's own id — the user's
|
|
765
767
|
identity is in `sharedWithUser._id` on list and invite responses, and
|
|
766
768
|
in `_sharedWithUserId` on `GET /v1/ashares/{_id}`. The account owner
|
|
@@ -854,6 +856,43 @@ components:
|
|
|
854
856
|
before their SSO-required access is fully active. Set by the
|
|
855
857
|
server during SSO enrollment; cleared by removing the field, so
|
|
856
858
|
it is never `false`.
|
|
859
|
+
provisionedBy:
|
|
860
|
+
type: string
|
|
861
|
+
readOnly: true
|
|
862
|
+
enum:
|
|
863
|
+
- scim
|
|
864
|
+
x-enumDescriptions:
|
|
865
|
+
scim: Created, or adopted from an existing invitation, by the identity provider through SCIM
|
|
866
|
+
description: |-
|
|
867
|
+
Present only on workspace users the identity provider manages through
|
|
868
|
+
SCIM; every other workspace record omits the field, so an invited
|
|
869
|
+
user has no value here rather than `invite`. The identity provider
|
|
870
|
+
owns a SCIM-managed user's account-wide access level and active
|
|
871
|
+
state: `PUT /v1/ashares/{_id}` still accepts a new `accessLevel` and
|
|
872
|
+
`PUT /v1/ashares/{_userId}/disable` still toggles `disabled`, but the
|
|
873
|
+
identity provider's next push overwrites both — change them in the
|
|
874
|
+
IdP. SCIM never sets `integrationAccessLevel`, so integration-level
|
|
875
|
+
grants made here stay.
|
|
876
|
+
externalId:
|
|
877
|
+
type: string
|
|
878
|
+
readOnly: true
|
|
879
|
+
examples:
|
|
880
|
+
- 00u1a2b3c4d5e6f7g8h9
|
|
881
|
+
description: |-
|
|
882
|
+
Identifier the identity provider uses for this person in its own
|
|
883
|
+
directory, stored when the record is provisioned through SCIM.
|
|
884
|
+
Present only when `provisionedBy` is `scim`. SCIM matches people by
|
|
885
|
+
email, not by this value.
|
|
886
|
+
_scimSsoClientId:
|
|
887
|
+
type: string
|
|
888
|
+
format: objectId
|
|
889
|
+
readOnly: true
|
|
890
|
+
x-celigo-refModel: ssoclients
|
|
891
|
+
examples:
|
|
892
|
+
- 6a1b2c3d4e5f6a7b8c9d0e1f
|
|
893
|
+
description: |-
|
|
894
|
+
SSO client whose SCIM configuration provisioned this record. Present
|
|
895
|
+
only when `provisionedBy` is `scim`.
|
|
857
896
|
sharedWithUser:
|
|
858
897
|
type: object
|
|
859
898
|
readOnly: true
|
package/package.json
CHANGED
package/schemas.json
CHANGED
|
@@ -1,8 +1,8 @@
|
|
|
1
1
|
{
|
|
2
2
|
"provenance": {
|
|
3
3
|
"repo": "celigo/integrator-api-specs",
|
|
4
|
-
"iasCommit": "
|
|
5
|
-
"generatedAt": "2026-09-
|
|
4
|
+
"iasCommit": "27222ec",
|
|
5
|
+
"generatedAt": "2026-09-29"
|
|
6
6
|
},
|
|
7
7
|
"roots": {
|
|
8
8
|
"aiagent": 133,
|
|
@@ -5224,6 +5224,7 @@
|
|
|
5224
5224
|
"object"
|
|
5225
5225
|
],
|
|
5226
5226
|
"p": {
|
|
5227
|
+
"preParse": 445,
|
|
5227
5228
|
"preSavePage": 445
|
|
5228
5229
|
}
|
|
5229
5230
|
},
|