You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
**Call an endpoint; workspaceId is auto-injected.**
353
+
354
+
```bash
355
+
$ tailor-sdk api GetApplication -b '{"applicationName":"app-1"}'
356
+
```
357
+
358
+
**List all invocable OperatorService methods.**
359
+
360
+
```bash
361
+
$ tailor-sdk api list
362
+
```
363
+
364
+
**Show the input message tree for an endpoint.**
365
+
366
+
```bash
367
+
$ tailor-sdk api inspect GetApplication
368
+
```
369
+
370
+
<!-- politty:command:api:examples:end -->
371
+
348
372
<!-- politty:command:api:notes:start -->
349
373
350
374
**Notes**
351
375
376
+
Use `tailor-sdk api list` to enumerate invocable methods and `tailor-sdk api inspect <endpoint>` to print an endpoint's input message tree (combine with `--json` for machine-readable output).
377
+
352
378
The request body is inferred from the proto definition of the target endpoint, and commonly required fields are auto-injected so they can be omitted from `--body`:
353
379
354
380
-`workspaceId` — resolved from `-w` / `TAILOR_PLATFORM_WORKSPACE_ID` / the selected profile.
@@ -359,3 +385,102 @@ The request body is inferred from the proto definition of the target endpoint, a
359
385
Values already present in `--body` are never overridden. If a value cannot be resolved (e.g. no config found), injection is silently skipped and the server-side validation error takes precedence.
**Inspect a deeply nested input with `(oneof config)` annotations.**
437
+
438
+
```bash
439
+
$ tailor-sdk api inspect CreateExecutorExecutor
440
+
```
441
+
442
+
<!-- politty:command:api inspect:examples:end -->
443
+
444
+
<!-- politty:command:api inspect:notes:start -->
445
+
446
+
**Notes**
447
+
448
+
Combine with the global `--json` flag for a machine-readable descriptor. Recursive type references and `oneof` membership are annotated. Use `tailor-sdk api list` to discover endpoint names.
Copy file name to clipboardExpand all lines: docs/sdk/services/executor.md
+4Lines changed: 4 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -130,6 +130,8 @@ Fire when IdP users are created, updated, or deleted:
130
130
idpUserCreatedTrigger();
131
131
```
132
132
133
+
These triggers require the IdP to publish user lifecycle events. The SDK enables `publishUserEvents` on the IdP automatically during `apply` when any executor uses an `idpUser` trigger; set the value explicitly on `defineIdp()` to override. See [IdP service - publishUserEvents](idp.md#publishuserevents).
134
+
133
135
### Auth Access Token Triggers
134
136
135
137
Fire on auth access token lifecycle events:
@@ -203,6 +205,8 @@ createExecutor({
203
205
});
204
206
```
205
207
208
+
`function` and `jobFunction``body` args include an `invoker` field: the principal running this function, overridden by `authInvoker` when set; `null` for anonymous calls. Other operation kinds (`graphql`, `webhook`, `workflow`) do not pass `invoker` into their callbacks.
209
+
206
210
### Job Function Operation
207
211
208
212
For long-running operations, use `jobFunction` which runs asynchronously and supports extended execution times. See [Job Function Operation](/guides/executor/job-function-operation) for details.
Copy file name to clipboardExpand all lines: docs/sdk/services/idp.md
+16Lines changed: 16 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -164,6 +164,22 @@ defineIdp("my-idp", {
164
164
165
165
**Validation:** Each field must be 200 characters or less and must not contain newline characters.
166
166
167
+
### publishUserEvents
168
+
169
+
Publish IdP user lifecycle events (`idp.user.created`, `idp.user.updated`, `idp.user.deleted`). These events are consumed by executors that use `idpUserCreatedTrigger`, `idpUserUpdatedTrigger`, `idpUserDeletedTrigger`, or `idpUserTrigger`.
170
+
171
+
```typescript
172
+
defineIdp("my-idp", {
173
+
clients: ["my-client"],
174
+
publishUserEvents: true,
175
+
});
176
+
```
177
+
178
+
**Auto-configuration:** When `publishUserEvents` is omitted, the SDK enables it automatically during `apply` if the project defines any executor with an `idpUser` trigger. Set the value explicitly to override:
-`publishUserEvents: false`: never publish events. The SDK warns when executors with `idpUser` triggers are present, since those executors will not fire for this IdP.
182
+
167
183
## Using idp.provider()
168
184
169
185
The `idp.provider()` method creates a type-safe reference to the IdP for use in Auth configuration. The client name is validated at compile time against the clients defined in the IdP.
![tailor-docs-bot[bot]](https://avatars.githubusercontent.com/u/127912421?v=4&size=40){kind=avatar}
0 commit comments