auth0 5.6.0 → 5.8.0
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/cjs/management/api/requests/requests.d.ts +41 -2
- package/dist/cjs/management/api/resources/clientGrants/client/Client.d.ts +2 -1
- package/dist/cjs/management/api/resources/clientGrants/client/Client.js +4 -2
- package/dist/cjs/management/api/resources/connections/resources/directoryProvisioning/client/Client.d.ts +43 -0
- package/dist/cjs/management/api/resources/connections/resources/directoryProvisioning/client/Client.js +152 -0
- package/dist/cjs/management/api/resources/eventStreams/client/Client.d.ts +1 -1
- package/dist/cjs/management/api/resources/eventStreams/client/Client.js +1 -1
- package/dist/cjs/management/api/resources/logStreams/client/Client.d.ts +465 -300
- package/dist/cjs/management/api/resources/logStreams/client/Client.js +465 -300
- package/dist/cjs/management/api/types/types.d.ts +200 -37
- package/dist/cjs/management/api/types/types.js +104 -46
- package/dist/cjs/management/version.d.ts +1 -1
- package/dist/cjs/management/version.js +1 -1
- package/dist/esm/management/api/requests/requests.d.mts +41 -2
- package/dist/esm/management/api/resources/clientGrants/client/Client.d.mts +2 -1
- package/dist/esm/management/api/resources/clientGrants/client/Client.mjs +4 -2
- package/dist/esm/management/api/resources/connections/resources/directoryProvisioning/client/Client.d.mts +43 -0
- package/dist/esm/management/api/resources/connections/resources/directoryProvisioning/client/Client.mjs +152 -0
- package/dist/esm/management/api/resources/eventStreams/client/Client.d.mts +1 -1
- package/dist/esm/management/api/resources/eventStreams/client/Client.mjs +1 -1
- package/dist/esm/management/api/resources/logStreams/client/Client.d.mts +465 -300
- package/dist/esm/management/api/resources/logStreams/client/Client.mjs +465 -300
- package/dist/esm/management/api/types/types.d.mts +200 -37
- package/dist/esm/management/api/types/types.mjs +94 -36
- package/dist/esm/management/version.d.mts +1 -1
- package/dist/esm/management/version.mjs +1 -1
- package/package.json +1 -1
- package/reference.md +673 -323
package/reference.md
CHANGED
|
@@ -663,6 +663,7 @@ const pageableResponse = await client.clientGrants.list({
|
|
|
663
663
|
client_id: "client_id",
|
|
664
664
|
allow_any_organization: true,
|
|
665
665
|
subject_type: "client",
|
|
666
|
+
default_for: "third_party_clients",
|
|
666
667
|
});
|
|
667
668
|
for await (const item of pageableResponse) {
|
|
668
669
|
console.log(item);
|
|
@@ -676,6 +677,7 @@ let page = await client.clientGrants.list({
|
|
|
676
677
|
client_id: "client_id",
|
|
677
678
|
allow_any_organization: true,
|
|
678
679
|
subject_type: "client",
|
|
680
|
+
default_for: "third_party_clients",
|
|
679
681
|
});
|
|
680
682
|
while (page.hasNextPage()) {
|
|
681
683
|
page = page.getNextPage();
|
|
@@ -3962,7 +3964,7 @@ await client.eventStreams.update("id");
|
|
|
3962
3964
|
|
|
3963
3965
|
```typescript
|
|
3964
3966
|
await client.eventStreams.test("id", {
|
|
3965
|
-
event_type: "
|
|
3967
|
+
event_type: "group.created",
|
|
3966
3968
|
});
|
|
3967
3969
|
```
|
|
3968
3970
|
|
|
@@ -5450,73 +5452,81 @@ await client.jobs.get("id");
|
|
|
5450
5452
|
<dl>
|
|
5451
5453
|
<dd>
|
|
5452
5454
|
|
|
5453
|
-
Retrieve details on
|
|
5455
|
+
Retrieve details on [log streams](https://auth0.com/docs/logs/streams).
|
|
5456
|
+
|
|
5457
|
+
**Sample Response**
|
|
5458
|
+
|
|
5459
|
+
```json
|
|
5460
|
+
[
|
|
5461
|
+
{
|
|
5462
|
+
"id": "string",
|
|
5463
|
+
"name": "string",
|
|
5464
|
+
"type": "eventbridge",
|
|
5465
|
+
"status": "active|paused|suspended",
|
|
5466
|
+
"sink": {
|
|
5467
|
+
"awsAccountId": "string",
|
|
5468
|
+
"awsRegion": "string",
|
|
5469
|
+
"awsPartnerEventSource": "string"
|
|
5470
|
+
}
|
|
5471
|
+
},
|
|
5472
|
+
{
|
|
5473
|
+
"id": "string",
|
|
5474
|
+
"name": "string",
|
|
5475
|
+
"type": "http",
|
|
5476
|
+
"status": "active|paused|suspended",
|
|
5477
|
+
"sink": {
|
|
5478
|
+
"httpContentFormat": "JSONLINES|JSONARRAY",
|
|
5479
|
+
"httpContentType": "string",
|
|
5480
|
+
"httpEndpoint": "string",
|
|
5481
|
+
"httpAuthorization": "string"
|
|
5482
|
+
}
|
|
5483
|
+
},
|
|
5484
|
+
{
|
|
5485
|
+
"id": "string",
|
|
5486
|
+
"name": "string",
|
|
5487
|
+
"type": "eventgrid",
|
|
5488
|
+
"status": "active|paused|suspended",
|
|
5489
|
+
"sink": {
|
|
5490
|
+
"azureSubscriptionId": "string",
|
|
5491
|
+
"azureResourceGroup": "string",
|
|
5492
|
+
"azureRegion": "string",
|
|
5493
|
+
"azurePartnerTopic": "string"
|
|
5494
|
+
}
|
|
5495
|
+
},
|
|
5496
|
+
{
|
|
5497
|
+
"id": "string",
|
|
5498
|
+
"name": "string",
|
|
5499
|
+
"type": "splunk",
|
|
5500
|
+
"status": "active|paused|suspended",
|
|
5501
|
+
"sink": {
|
|
5502
|
+
"splunkDomain": "string",
|
|
5503
|
+
"splunkToken": "string",
|
|
5504
|
+
"splunkPort": "string",
|
|
5505
|
+
"splunkSecure": "boolean"
|
|
5506
|
+
}
|
|
5507
|
+
},
|
|
5508
|
+
{
|
|
5509
|
+
"id": "string",
|
|
5510
|
+
"name": "string",
|
|
5511
|
+
"type": "sumo",
|
|
5512
|
+
"status": "active|paused|suspended",
|
|
5513
|
+
"sink": {
|
|
5514
|
+
"sumoSourceAddress": "string"
|
|
5515
|
+
}
|
|
5516
|
+
},
|
|
5517
|
+
{
|
|
5518
|
+
"id": "string",
|
|
5519
|
+
"name": "string",
|
|
5520
|
+
"type": "datadog",
|
|
5521
|
+
"status": "active|paused|suspended",
|
|
5522
|
+
"sink": {
|
|
5523
|
+
"datadogRegion": "string",
|
|
5524
|
+
"datadogApiKey": "string"
|
|
5525
|
+
}
|
|
5526
|
+
}
|
|
5527
|
+
]
|
|
5528
|
+
```
|
|
5454
5529
|
|
|
5455
|
-
<h5>Sample Response</h5><pre><code>[{
|
|
5456
|
-
"id": "string",
|
|
5457
|
-
"name": "string",
|
|
5458
|
-
"type": "eventbridge",
|
|
5459
|
-
"status": "active|paused|suspended",
|
|
5460
|
-
"sink": {
|
|
5461
|
-
"awsAccountId": "string",
|
|
5462
|
-
"awsRegion": "string",
|
|
5463
|
-
"awsPartnerEventSource": "string"
|
|
5464
|
-
}
|
|
5465
|
-
}, {
|
|
5466
|
-
"id": "string",
|
|
5467
|
-
"name": "string",
|
|
5468
|
-
"type": "http",
|
|
5469
|
-
"status": "active|paused|suspended",
|
|
5470
|
-
"sink": {
|
|
5471
|
-
"httpContentFormat": "JSONLINES|JSONARRAY",
|
|
5472
|
-
"httpContentType": "string",
|
|
5473
|
-
"httpEndpoint": "string",
|
|
5474
|
-
"httpAuthorization": "string"
|
|
5475
|
-
}
|
|
5476
|
-
},
|
|
5477
|
-
{
|
|
5478
|
-
"id": "string",
|
|
5479
|
-
"name": "string",
|
|
5480
|
-
"type": "eventgrid",
|
|
5481
|
-
"status": "active|paused|suspended",
|
|
5482
|
-
"sink": {
|
|
5483
|
-
"azureSubscriptionId": "string",
|
|
5484
|
-
"azureResourceGroup": "string",
|
|
5485
|
-
"azureRegion": "string",
|
|
5486
|
-
"azurePartnerTopic": "string"
|
|
5487
|
-
}
|
|
5488
|
-
},
|
|
5489
|
-
{
|
|
5490
|
-
"id": "string",
|
|
5491
|
-
"name": "string",
|
|
5492
|
-
"type": "splunk",
|
|
5493
|
-
"status": "active|paused|suspended",
|
|
5494
|
-
"sink": {
|
|
5495
|
-
"splunkDomain": "string",
|
|
5496
|
-
"splunkToken": "string",
|
|
5497
|
-
"splunkPort": "string",
|
|
5498
|
-
"splunkSecure": "boolean"
|
|
5499
|
-
}
|
|
5500
|
-
},
|
|
5501
|
-
{
|
|
5502
|
-
"id": "string",
|
|
5503
|
-
"name": "string",
|
|
5504
|
-
"type": "sumo",
|
|
5505
|
-
"status": "active|paused|suspended",
|
|
5506
|
-
"sink": {
|
|
5507
|
-
"sumoSourceAddress": "string",
|
|
5508
|
-
}
|
|
5509
|
-
},
|
|
5510
|
-
{
|
|
5511
|
-
"id": "string",
|
|
5512
|
-
"name": "string",
|
|
5513
|
-
"type": "datadog",
|
|
5514
|
-
"status": "active|paused|suspended",
|
|
5515
|
-
"sink": {
|
|
5516
|
-
"datadogRegion": "string",
|
|
5517
|
-
"datadogApiKey": "string"
|
|
5518
|
-
}
|
|
5519
|
-
}]</code></pre>
|
|
5520
5530
|
</dd>
|
|
5521
5531
|
</dl>
|
|
5522
5532
|
</dd>
|
|
@@ -5572,131 +5582,214 @@ await client.logStreams.list();
|
|
|
5572
5582
|
|
|
5573
5583
|
Create a log stream.
|
|
5574
5584
|
|
|
5575
|
-
|
|
5576
|
-
|
|
5577
|
-
|
|
5578
|
-
|
|
5579
|
-
|
|
5580
|
-
|
|
5581
|
-
|
|
5582
|
-
|
|
5583
|
-
|
|
5584
|
-
|
|
5585
|
-
|
|
5586
|
-
|
|
5587
|
-
|
|
5588
|
-
|
|
5589
|
-
|
|
5590
|
-
|
|
5591
|
-
|
|
5592
|
-
|
|
5593
|
-
|
|
5594
|
-
|
|
5595
|
-
|
|
5596
|
-
|
|
5597
|
-
|
|
5598
|
-
|
|
5599
|
-
|
|
5600
|
-
|
|
5601
|
-
|
|
5602
|
-
|
|
5603
|
-
|
|
5604
|
-
|
|
5605
|
-
|
|
5606
|
-
|
|
5607
|
-
|
|
5608
|
-
|
|
5609
|
-
|
|
5610
|
-
|
|
5611
|
-
|
|
5612
|
-
|
|
5613
|
-
|
|
5614
|
-
|
|
5615
|
-
|
|
5616
|
-
|
|
5617
|
-
|
|
5618
|
-
|
|
5619
|
-
|
|
5620
|
-
|
|
5621
|
-
|
|
5622
|
-
|
|
5623
|
-
|
|
5624
|
-
|
|
5625
|
-
|
|
5626
|
-
|
|
5627
|
-
|
|
5628
|
-
}
|
|
5629
|
-
|
|
5630
|
-
|
|
5631
|
-
|
|
5632
|
-
|
|
5633
|
-
|
|
5634
|
-
|
|
5635
|
-
|
|
5636
|
-
|
|
5637
|
-
|
|
5638
|
-
|
|
5639
|
-
|
|
5640
|
-
|
|
5641
|
-
|
|
5642
|
-
|
|
5643
|
-
|
|
5644
|
-
|
|
5645
|
-
|
|
5646
|
-
|
|
5647
|
-
|
|
5648
|
-
|
|
5649
|
-
|
|
5650
|
-
|
|
5651
|
-
|
|
5652
|
-
|
|
5653
|
-
|
|
5654
|
-
|
|
5655
|
-
|
|
5656
|
-
|
|
5657
|
-
|
|
5658
|
-
|
|
5659
|
-
|
|
5660
|
-
|
|
5661
|
-
|
|
5662
|
-
|
|
5663
|
-
|
|
5664
|
-
|
|
5665
|
-
|
|
5666
|
-
|
|
5667
|
-
|
|
5668
|
-
|
|
5669
|
-
|
|
5670
|
-
|
|
5671
|
-
|
|
5672
|
-
|
|
5673
|
-
|
|
5674
|
-
|
|
5675
|
-
|
|
5676
|
-
|
|
5677
|
-
|
|
5678
|
-
|
|
5679
|
-
|
|
5680
|
-
|
|
5681
|
-
|
|
5682
|
-
}
|
|
5683
|
-
|
|
5684
|
-
|
|
5685
|
-
|
|
5686
|
-
|
|
5687
|
-
|
|
5688
|
-
|
|
5689
|
-
|
|
5690
|
-
|
|
5691
|
-
|
|
5692
|
-
|
|
5693
|
-
|
|
5694
|
-
|
|
5695
|
-
|
|
5696
|
-
|
|
5697
|
-
|
|
5698
|
-
|
|
5699
|
-
}
|
|
5585
|
+
**Log Stream Types**
|
|
5586
|
+
|
|
5587
|
+
The `type` of log stream being created determines the properties required in the `sink` payload.
|
|
5588
|
+
|
|
5589
|
+
**HTTP Stream**
|
|
5590
|
+
|
|
5591
|
+
For an `http` Stream, the `sink` properties are listed in the payload below.
|
|
5592
|
+
|
|
5593
|
+
**Request:**
|
|
5594
|
+
|
|
5595
|
+
```json
|
|
5596
|
+
{
|
|
5597
|
+
"name": "string",
|
|
5598
|
+
"type": "http",
|
|
5599
|
+
"sink": {
|
|
5600
|
+
"httpEndpoint": "string",
|
|
5601
|
+
"httpContentType": "string",
|
|
5602
|
+
"httpContentFormat": "JSONLINES|JSONARRAY",
|
|
5603
|
+
"httpAuthorization": "string"
|
|
5604
|
+
}
|
|
5605
|
+
}
|
|
5606
|
+
```
|
|
5607
|
+
|
|
5608
|
+
**Response:**
|
|
5609
|
+
|
|
5610
|
+
```json
|
|
5611
|
+
{
|
|
5612
|
+
"id": "string",
|
|
5613
|
+
"name": "string",
|
|
5614
|
+
"type": "http",
|
|
5615
|
+
"status": "active",
|
|
5616
|
+
"sink": {
|
|
5617
|
+
"httpEndpoint": "string",
|
|
5618
|
+
"httpContentType": "string",
|
|
5619
|
+
"httpContentFormat": "JSONLINES|JSONARRAY",
|
|
5620
|
+
"httpAuthorization": "string"
|
|
5621
|
+
}
|
|
5622
|
+
}
|
|
5623
|
+
```
|
|
5624
|
+
|
|
5625
|
+
**Amazon EventBridge Stream**
|
|
5626
|
+
|
|
5627
|
+
For an `eventbridge` Stream, the `sink` properties are listed in the payload below.
|
|
5628
|
+
|
|
5629
|
+
**Request:**
|
|
5630
|
+
|
|
5631
|
+
```json
|
|
5632
|
+
{
|
|
5633
|
+
"name": "string",
|
|
5634
|
+
"type": "eventbridge",
|
|
5635
|
+
"sink": {
|
|
5636
|
+
"awsRegion": "string",
|
|
5637
|
+
"awsAccountId": "string"
|
|
5638
|
+
}
|
|
5639
|
+
}
|
|
5640
|
+
```
|
|
5641
|
+
|
|
5642
|
+
The response will include an additional field `awsPartnerEventSource` in the `sink`:
|
|
5643
|
+
|
|
5644
|
+
**Response:**
|
|
5645
|
+
|
|
5646
|
+
```json
|
|
5647
|
+
{
|
|
5648
|
+
"id": "string",
|
|
5649
|
+
"name": "string",
|
|
5650
|
+
"type": "eventbridge",
|
|
5651
|
+
"status": "active",
|
|
5652
|
+
"sink": {
|
|
5653
|
+
"awsAccountId": "string",
|
|
5654
|
+
"awsRegion": "string",
|
|
5655
|
+
"awsPartnerEventSource": "string"
|
|
5656
|
+
}
|
|
5657
|
+
}
|
|
5658
|
+
```
|
|
5659
|
+
|
|
5660
|
+
**Azure Event Grid Stream**
|
|
5661
|
+
|
|
5662
|
+
For an `Azure Event Grid` Stream, the `sink` properties are listed in the payload below.
|
|
5663
|
+
|
|
5664
|
+
**Request:**
|
|
5665
|
+
|
|
5666
|
+
```json
|
|
5667
|
+
{
|
|
5668
|
+
"name": "string",
|
|
5669
|
+
"type": "eventgrid",
|
|
5670
|
+
"sink": {
|
|
5671
|
+
"azureSubscriptionId": "string",
|
|
5672
|
+
"azureResourceGroup": "string",
|
|
5673
|
+
"azureRegion": "string"
|
|
5674
|
+
}
|
|
5675
|
+
}
|
|
5676
|
+
```
|
|
5677
|
+
|
|
5678
|
+
**Response:**
|
|
5679
|
+
|
|
5680
|
+
```json
|
|
5681
|
+
{
|
|
5682
|
+
"id": "string",
|
|
5683
|
+
"name": "string",
|
|
5684
|
+
"type": "http",
|
|
5685
|
+
"status": "active",
|
|
5686
|
+
"sink": {
|
|
5687
|
+
"azureSubscriptionId": "string",
|
|
5688
|
+
"azureResourceGroup": "string",
|
|
5689
|
+
"azureRegion": "string",
|
|
5690
|
+
"azurePartnerTopic": "string"
|
|
5691
|
+
}
|
|
5692
|
+
}
|
|
5693
|
+
```
|
|
5694
|
+
|
|
5695
|
+
**Datadog Stream**
|
|
5696
|
+
|
|
5697
|
+
For a `Datadog` Stream, the `sink` properties are listed in the payload below.
|
|
5698
|
+
|
|
5699
|
+
**Request:**
|
|
5700
|
+
|
|
5701
|
+
```json
|
|
5702
|
+
{
|
|
5703
|
+
"name": "string",
|
|
5704
|
+
"type": "datadog",
|
|
5705
|
+
"sink": {
|
|
5706
|
+
"datadogRegion": "string",
|
|
5707
|
+
"datadogApiKey": "string"
|
|
5708
|
+
}
|
|
5709
|
+
}
|
|
5710
|
+
```
|
|
5711
|
+
|
|
5712
|
+
**Response:**
|
|
5713
|
+
|
|
5714
|
+
```json
|
|
5715
|
+
{
|
|
5716
|
+
"id": "string",
|
|
5717
|
+
"name": "string",
|
|
5718
|
+
"type": "datadog",
|
|
5719
|
+
"status": "active",
|
|
5720
|
+
"sink": {
|
|
5721
|
+
"datadogRegion": "string",
|
|
5722
|
+
"datadogApiKey": "string"
|
|
5723
|
+
}
|
|
5724
|
+
}
|
|
5725
|
+
```
|
|
5726
|
+
|
|
5727
|
+
**Splunk Stream**
|
|
5728
|
+
|
|
5729
|
+
For a `Splunk` Stream, the `sink` properties are listed in the payload below.
|
|
5730
|
+
|
|
5731
|
+
**Request:**
|
|
5732
|
+
|
|
5733
|
+
```json
|
|
5734
|
+
{
|
|
5735
|
+
"name": "string",
|
|
5736
|
+
"type": "splunk",
|
|
5737
|
+
"sink": {
|
|
5738
|
+
"splunkDomain": "string",
|
|
5739
|
+
"splunkToken": "string",
|
|
5740
|
+
"splunkPort": "string",
|
|
5741
|
+
"splunkSecure": "boolean"
|
|
5742
|
+
}
|
|
5743
|
+
}
|
|
5744
|
+
```
|
|
5745
|
+
|
|
5746
|
+
**Response:**
|
|
5747
|
+
|
|
5748
|
+
```json
|
|
5749
|
+
{
|
|
5750
|
+
"id": "string",
|
|
5751
|
+
"name": "string",
|
|
5752
|
+
"type": "splunk",
|
|
5753
|
+
"status": "active",
|
|
5754
|
+
"sink": {
|
|
5755
|
+
"splunkDomain": "string",
|
|
5756
|
+
"splunkToken": "string",
|
|
5757
|
+
"splunkPort": "string",
|
|
5758
|
+
"splunkSecure": "boolean"
|
|
5759
|
+
}
|
|
5760
|
+
}
|
|
5761
|
+
```
|
|
5762
|
+
|
|
5763
|
+
**Sumo Logic Stream**
|
|
5764
|
+
|
|
5765
|
+
For a `Sumo Logic` Stream, the `sink` properties are listed in the payload below.
|
|
5766
|
+
|
|
5767
|
+
**Request:**
|
|
5768
|
+
|
|
5769
|
+
```json
|
|
5770
|
+
{
|
|
5771
|
+
"name": "string",
|
|
5772
|
+
"type": "sumo",
|
|
5773
|
+
"sink": {
|
|
5774
|
+
"sumoSourceAddress": "string"
|
|
5775
|
+
}
|
|
5776
|
+
}
|
|
5777
|
+
```
|
|
5778
|
+
|
|
5779
|
+
**Response:**
|
|
5780
|
+
|
|
5781
|
+
```json
|
|
5782
|
+
{
|
|
5783
|
+
"id": "string",
|
|
5784
|
+
"name": "string",
|
|
5785
|
+
"type": "sumo",
|
|
5786
|
+
"status": "active",
|
|
5787
|
+
"sink": {
|
|
5788
|
+
"sumoSourceAddress": "string"
|
|
5789
|
+
}
|
|
5790
|
+
}
|
|
5791
|
+
```
|
|
5792
|
+
|
|
5700
5793
|
</dd>
|
|
5701
5794
|
</dl>
|
|
5702
5795
|
</dd>
|
|
@@ -5765,108 +5858,160 @@ await client.logStreams.create({
|
|
|
5765
5858
|
|
|
5766
5859
|
Retrieve a log stream configuration and status.
|
|
5767
5860
|
|
|
5768
|
-
|
|
5769
|
-
|
|
5770
|
-
|
|
5771
|
-
|
|
5772
|
-
|
|
5773
|
-
|
|
5774
|
-
|
|
5775
|
-
|
|
5776
|
-
|
|
5777
|
-
|
|
5778
|
-
|
|
5779
|
-
|
|
5780
|
-
|
|
5781
|
-
|
|
5782
|
-
|
|
5783
|
-
"sink": {
|
|
5784
|
-
"httpContentFormat": "JSONLINES|JSONARRAY",
|
|
5785
|
-
"httpContentType": "string",
|
|
5786
|
-
"httpEndpoint": "string",
|
|
5787
|
-
"httpAuthorization": "string"
|
|
5788
|
-
}
|
|
5789
|
-
}</code></pre> <h5>Datadog Log Stream</h5><pre><code>{
|
|
5790
|
-
"id": "string",
|
|
5791
|
-
"name": "string",
|
|
5792
|
-
"type": "datadog",
|
|
5793
|
-
"status": "active|paused|suspended",
|
|
5794
|
-
"sink": {
|
|
5795
|
-
"datadogRegion": "string",
|
|
5796
|
-
"datadogApiKey": "string"
|
|
5797
|
-
}
|
|
5798
|
-
|
|
5799
|
-
}</code></pre><h5>Mixpanel</h5>
|
|
5800
|
-
Request: <pre><code>{
|
|
5801
|
-
"name": "string",
|
|
5802
|
-
"type": "mixpanel",
|
|
5803
|
-
"sink": {
|
|
5804
|
-
"mixpanelRegion": "string", // "us" | "eu",
|
|
5805
|
-
"mixpanelProjectId": "string",
|
|
5806
|
-
"mixpanelServiceAccountUsername": "string",
|
|
5807
|
-
"mixpanelServiceAccountPassword": "string"
|
|
5861
|
+
**Sample responses**
|
|
5862
|
+
|
|
5863
|
+
**Amazon EventBridge Log Stream**
|
|
5864
|
+
|
|
5865
|
+
```json
|
|
5866
|
+
{
|
|
5867
|
+
"id": "string",
|
|
5868
|
+
"name": "string",
|
|
5869
|
+
"type": "eventbridge",
|
|
5870
|
+
"status": "active|paused|suspended",
|
|
5871
|
+
"sink": {
|
|
5872
|
+
"awsAccountId": "string",
|
|
5873
|
+
"awsRegion": "string",
|
|
5874
|
+
"awsPartnerEventSource": "string"
|
|
5875
|
+
}
|
|
5808
5876
|
}
|
|
5809
|
-
|
|
5810
|
-
|
|
5811
|
-
|
|
5812
|
-
|
|
5813
|
-
|
|
5814
|
-
|
|
5815
|
-
"
|
|
5816
|
-
"
|
|
5817
|
-
"
|
|
5818
|
-
"
|
|
5819
|
-
"
|
|
5877
|
+
```
|
|
5878
|
+
|
|
5879
|
+
**HTTP Log Stream**
|
|
5880
|
+
|
|
5881
|
+
```json
|
|
5882
|
+
{
|
|
5883
|
+
"id": "string",
|
|
5884
|
+
"name": "string",
|
|
5885
|
+
"type": "http",
|
|
5886
|
+
"status": "active|paused|suspended",
|
|
5887
|
+
"sink": {
|
|
5888
|
+
"httpContentFormat": "JSONLINES|JSONARRAY",
|
|
5889
|
+
"httpContentType": "string",
|
|
5890
|
+
"httpEndpoint": "string",
|
|
5891
|
+
"httpAuthorization": "string"
|
|
5892
|
+
}
|
|
5820
5893
|
}
|
|
5821
|
-
|
|
5894
|
+
```
|
|
5822
5895
|
|
|
5823
|
-
|
|
5896
|
+
**Datadog Log Stream**
|
|
5824
5897
|
|
|
5825
|
-
|
|
5826
|
-
|
|
5827
|
-
|
|
5828
|
-
|
|
5829
|
-
|
|
5830
|
-
|
|
5831
|
-
|
|
5832
|
-
|
|
5833
|
-
|
|
5834
|
-
|
|
5835
|
-
|
|
5836
|
-
|
|
5837
|
-
"status": "active",
|
|
5838
|
-
"sink": {
|
|
5839
|
-
"segmentWriteKey": "string"
|
|
5840
|
-
}
|
|
5841
|
-
} </code></pre>
|
|
5898
|
+
```json
|
|
5899
|
+
{
|
|
5900
|
+
"id": "string",
|
|
5901
|
+
"name": "string",
|
|
5902
|
+
"type": "datadog",
|
|
5903
|
+
"status": "active|paused|suspended",
|
|
5904
|
+
"sink": {
|
|
5905
|
+
"datadogRegion": "string",
|
|
5906
|
+
"datadogApiKey": "string"
|
|
5907
|
+
}
|
|
5908
|
+
}
|
|
5909
|
+
```
|
|
5842
5910
|
|
|
5843
|
-
|
|
5844
|
-
|
|
5845
|
-
|
|
5846
|
-
|
|
5847
|
-
|
|
5848
|
-
|
|
5849
|
-
|
|
5850
|
-
|
|
5851
|
-
|
|
5852
|
-
|
|
5853
|
-
|
|
5854
|
-
|
|
5855
|
-
|
|
5856
|
-
|
|
5857
|
-
|
|
5858
|
-
|
|
5859
|
-
|
|
5860
|
-
|
|
5861
|
-
|
|
5862
|
-
|
|
5863
|
-
|
|
5864
|
-
|
|
5865
|
-
|
|
5866
|
-
|
|
5867
|
-
|
|
5868
|
-
|
|
5869
|
-
|
|
5911
|
+
**Mixpanel**
|
|
5912
|
+
|
|
5913
|
+
**Request:**
|
|
5914
|
+
|
|
5915
|
+
```json
|
|
5916
|
+
{
|
|
5917
|
+
"name": "string",
|
|
5918
|
+
"type": "mixpanel",
|
|
5919
|
+
"sink": {
|
|
5920
|
+
"mixpanelRegion": "string",
|
|
5921
|
+
"mixpanelProjectId": "string",
|
|
5922
|
+
"mixpanelServiceAccountUsername": "string",
|
|
5923
|
+
"mixpanelServiceAccountPassword": "string"
|
|
5924
|
+
}
|
|
5925
|
+
}
|
|
5926
|
+
```
|
|
5927
|
+
|
|
5928
|
+
**Response:**
|
|
5929
|
+
|
|
5930
|
+
```json
|
|
5931
|
+
{
|
|
5932
|
+
"id": "string",
|
|
5933
|
+
"name": "string",
|
|
5934
|
+
"type": "mixpanel",
|
|
5935
|
+
"status": "active",
|
|
5936
|
+
"sink": {
|
|
5937
|
+
"mixpanelRegion": "string",
|
|
5938
|
+
"mixpanelProjectId": "string",
|
|
5939
|
+
"mixpanelServiceAccountUsername": "string",
|
|
5940
|
+
"mixpanelServiceAccountPassword": "string"
|
|
5941
|
+
}
|
|
5942
|
+
}
|
|
5943
|
+
```
|
|
5944
|
+
|
|
5945
|
+
**Segment**
|
|
5946
|
+
|
|
5947
|
+
**Request:**
|
|
5948
|
+
|
|
5949
|
+
```json
|
|
5950
|
+
{
|
|
5951
|
+
"name": "string",
|
|
5952
|
+
"type": "segment",
|
|
5953
|
+
"sink": {
|
|
5954
|
+
"segmentWriteKey": "string"
|
|
5955
|
+
}
|
|
5956
|
+
}
|
|
5957
|
+
```
|
|
5958
|
+
|
|
5959
|
+
**Response:**
|
|
5960
|
+
|
|
5961
|
+
```json
|
|
5962
|
+
{
|
|
5963
|
+
"id": "string",
|
|
5964
|
+
"name": "string",
|
|
5965
|
+
"type": "segment",
|
|
5966
|
+
"status": "active",
|
|
5967
|
+
"sink": {
|
|
5968
|
+
"segmentWriteKey": "string"
|
|
5969
|
+
}
|
|
5970
|
+
}
|
|
5971
|
+
```
|
|
5972
|
+
|
|
5973
|
+
**Splunk Log Stream**
|
|
5974
|
+
|
|
5975
|
+
```json
|
|
5976
|
+
{
|
|
5977
|
+
"id": "string",
|
|
5978
|
+
"name": "string",
|
|
5979
|
+
"type": "splunk",
|
|
5980
|
+
"status": "active|paused|suspended",
|
|
5981
|
+
"sink": {
|
|
5982
|
+
"splunkDomain": "string",
|
|
5983
|
+
"splunkToken": "string",
|
|
5984
|
+
"splunkPort": "string",
|
|
5985
|
+
"splunkSecure": "boolean"
|
|
5986
|
+
}
|
|
5987
|
+
}
|
|
5988
|
+
```
|
|
5989
|
+
|
|
5990
|
+
**Sumo Logic Log Stream**
|
|
5991
|
+
|
|
5992
|
+
```json
|
|
5993
|
+
{
|
|
5994
|
+
"id": "string",
|
|
5995
|
+
"name": "string",
|
|
5996
|
+
"type": "sumo",
|
|
5997
|
+
"status": "active|paused|suspended",
|
|
5998
|
+
"sink": {
|
|
5999
|
+
"sumoSourceAddress": "string"
|
|
6000
|
+
}
|
|
6001
|
+
}
|
|
6002
|
+
```
|
|
6003
|
+
|
|
6004
|
+
**Status**
|
|
6005
|
+
|
|
6006
|
+
The `status` of a log stream maybe any of the following:
|
|
6007
|
+
|
|
6008
|
+
1. `active` - Stream is currently enabled.
|
|
6009
|
+
2. `paused` - Stream is currently user disabled and will not attempt log delivery.
|
|
6010
|
+
3. `suspended` - Stream is currently disabled because of errors and will not attempt log delivery.
|
|
6011
|
+
</dd>
|
|
6012
|
+
</dl>
|
|
6013
|
+
</dd>
|
|
6014
|
+
</dl>
|
|
5870
6015
|
|
|
5871
6016
|
#### 🔌 Usage
|
|
5872
6017
|
|
|
@@ -5989,40 +6134,79 @@ await client.logStreams.delete("id");
|
|
|
5989
6134
|
|
|
5990
6135
|
Update a log stream.
|
|
5991
6136
|
|
|
5992
|
-
|
|
5993
|
-
|
|
5994
|
-
|
|
5995
|
-
|
|
5996
|
-
|
|
5997
|
-
|
|
5998
|
-
|
|
5999
|
-
|
|
6000
|
-
|
|
6001
|
-
|
|
6002
|
-
|
|
6003
|
-
|
|
6004
|
-
|
|
6005
|
-
|
|
6006
|
-
|
|
6007
|
-
|
|
6008
|
-
|
|
6009
|
-
|
|
6010
|
-
|
|
6011
|
-
|
|
6012
|
-
|
|
6013
|
-
|
|
6014
|
-
|
|
6015
|
-
|
|
6016
|
-
|
|
6017
|
-
|
|
6018
|
-
|
|
6019
|
-
|
|
6020
|
-
|
|
6021
|
-
|
|
6022
|
-
|
|
6023
|
-
|
|
6024
|
-
|
|
6025
|
-
|
|
6137
|
+
**Examples of how to use the PATCH endpoint.**
|
|
6138
|
+
|
|
6139
|
+
The following fields may be updated in a PATCH operation:
|
|
6140
|
+
|
|
6141
|
+
- name
|
|
6142
|
+
- status
|
|
6143
|
+
- sink
|
|
6144
|
+
|
|
6145
|
+
Note: For log streams of type `eventbridge` and `eventgrid`, updating the `sink` is not permitted.
|
|
6146
|
+
|
|
6147
|
+
**Update the status of a log stream**
|
|
6148
|
+
|
|
6149
|
+
```json
|
|
6150
|
+
{
|
|
6151
|
+
"status": "active|paused"
|
|
6152
|
+
}
|
|
6153
|
+
```
|
|
6154
|
+
|
|
6155
|
+
**Update the name of a log stream**
|
|
6156
|
+
|
|
6157
|
+
```json
|
|
6158
|
+
{
|
|
6159
|
+
"name": "string"
|
|
6160
|
+
}
|
|
6161
|
+
```
|
|
6162
|
+
|
|
6163
|
+
**Update the sink properties of a stream of type `http`**
|
|
6164
|
+
|
|
6165
|
+
```json
|
|
6166
|
+
{
|
|
6167
|
+
"sink": {
|
|
6168
|
+
"httpEndpoint": "string",
|
|
6169
|
+
"httpContentType": "string",
|
|
6170
|
+
"httpContentFormat": "JSONARRAY|JSONLINES",
|
|
6171
|
+
"httpAuthorization": "string"
|
|
6172
|
+
}
|
|
6173
|
+
}
|
|
6174
|
+
```
|
|
6175
|
+
|
|
6176
|
+
**Update the sink properties of a stream of type `datadog`**
|
|
6177
|
+
|
|
6178
|
+
```json
|
|
6179
|
+
{
|
|
6180
|
+
"sink": {
|
|
6181
|
+
"datadogRegion": "string",
|
|
6182
|
+
"datadogApiKey": "string"
|
|
6183
|
+
}
|
|
6184
|
+
}
|
|
6185
|
+
```
|
|
6186
|
+
|
|
6187
|
+
**Update the sink properties of a stream of type `splunk`**
|
|
6188
|
+
|
|
6189
|
+
```json
|
|
6190
|
+
{
|
|
6191
|
+
"sink": {
|
|
6192
|
+
"splunkDomain": "string",
|
|
6193
|
+
"splunkToken": "string",
|
|
6194
|
+
"splunkPort": "string",
|
|
6195
|
+
"splunkSecure": "boolean"
|
|
6196
|
+
}
|
|
6197
|
+
}
|
|
6198
|
+
```
|
|
6199
|
+
|
|
6200
|
+
**Update the sink properties of a stream of type `sumo`**
|
|
6201
|
+
|
|
6202
|
+
```json
|
|
6203
|
+
{
|
|
6204
|
+
"sink": {
|
|
6205
|
+
"sumoSourceAddress": "string"
|
|
6206
|
+
}
|
|
6207
|
+
}
|
|
6208
|
+
```
|
|
6209
|
+
|
|
6026
6210
|
</dd>
|
|
6027
6211
|
</dl>
|
|
6028
6212
|
</dd>
|
|
@@ -15929,6 +16113,172 @@ await client.connections.directoryProvisioning.getDefaultMapping("id");
|
|
|
15929
16113
|
</dl>
|
|
15930
16114
|
</details>
|
|
15931
16115
|
|
|
16116
|
+
<details><summary><code>client.connections.directoryProvisioning.<a href="/src/management/api/resources/connections/resources/directoryProvisioning/client/Client.ts">listSynchronizedGroups</a>(id, { ...params }) -> core.Page<Management.SynchronizedGroupPayload, Management.ListSynchronizedGroupsResponseContent></code></summary>
|
|
16117
|
+
<dl>
|
|
16118
|
+
<dd>
|
|
16119
|
+
|
|
16120
|
+
#### 📝 Description
|
|
16121
|
+
|
|
16122
|
+
<dl>
|
|
16123
|
+
<dd>
|
|
16124
|
+
|
|
16125
|
+
<dl>
|
|
16126
|
+
<dd>
|
|
16127
|
+
|
|
16128
|
+
Retrieve the configured synchronized groups for a connection directory provisioning configuration.
|
|
16129
|
+
|
|
16130
|
+
</dd>
|
|
16131
|
+
</dl>
|
|
16132
|
+
</dd>
|
|
16133
|
+
</dl>
|
|
16134
|
+
|
|
16135
|
+
#### 🔌 Usage
|
|
16136
|
+
|
|
16137
|
+
<dl>
|
|
16138
|
+
<dd>
|
|
16139
|
+
|
|
16140
|
+
<dl>
|
|
16141
|
+
<dd>
|
|
16142
|
+
|
|
16143
|
+
```typescript
|
|
16144
|
+
const pageableResponse = await client.connections.directoryProvisioning.listSynchronizedGroups("id", {
|
|
16145
|
+
from: "from",
|
|
16146
|
+
take: 1,
|
|
16147
|
+
});
|
|
16148
|
+
for await (const item of pageableResponse) {
|
|
16149
|
+
console.log(item);
|
|
16150
|
+
}
|
|
16151
|
+
|
|
16152
|
+
// Or you can manually iterate page-by-page
|
|
16153
|
+
let page = await client.connections.directoryProvisioning.listSynchronizedGroups("id", {
|
|
16154
|
+
from: "from",
|
|
16155
|
+
take: 1,
|
|
16156
|
+
});
|
|
16157
|
+
while (page.hasNextPage()) {
|
|
16158
|
+
page = page.getNextPage();
|
|
16159
|
+
}
|
|
16160
|
+
|
|
16161
|
+
// You can also access the underlying response
|
|
16162
|
+
const response = page.response;
|
|
16163
|
+
```
|
|
16164
|
+
|
|
16165
|
+
</dd>
|
|
16166
|
+
</dl>
|
|
16167
|
+
</dd>
|
|
16168
|
+
</dl>
|
|
16169
|
+
|
|
16170
|
+
#### ⚙️ Parameters
|
|
16171
|
+
|
|
16172
|
+
<dl>
|
|
16173
|
+
<dd>
|
|
16174
|
+
|
|
16175
|
+
<dl>
|
|
16176
|
+
<dd>
|
|
16177
|
+
|
|
16178
|
+
**id:** `string` — The id of the connection to list synchronized groups for.
|
|
16179
|
+
|
|
16180
|
+
</dd>
|
|
16181
|
+
</dl>
|
|
16182
|
+
|
|
16183
|
+
<dl>
|
|
16184
|
+
<dd>
|
|
16185
|
+
|
|
16186
|
+
**request:** `Management.ListSynchronizedGroupsRequestParameters`
|
|
16187
|
+
|
|
16188
|
+
</dd>
|
|
16189
|
+
</dl>
|
|
16190
|
+
|
|
16191
|
+
<dl>
|
|
16192
|
+
<dd>
|
|
16193
|
+
|
|
16194
|
+
**requestOptions:** `DirectoryProvisioningClient.RequestOptions`
|
|
16195
|
+
|
|
16196
|
+
</dd>
|
|
16197
|
+
</dl>
|
|
16198
|
+
</dd>
|
|
16199
|
+
</dl>
|
|
16200
|
+
|
|
16201
|
+
</dd>
|
|
16202
|
+
</dl>
|
|
16203
|
+
</details>
|
|
16204
|
+
|
|
16205
|
+
<details><summary><code>client.connections.directoryProvisioning.<a href="/src/management/api/resources/connections/resources/directoryProvisioning/client/Client.ts">set</a>(id, { ...params }) -> void</code></summary>
|
|
16206
|
+
<dl>
|
|
16207
|
+
<dd>
|
|
16208
|
+
|
|
16209
|
+
#### 📝 Description
|
|
16210
|
+
|
|
16211
|
+
<dl>
|
|
16212
|
+
<dd>
|
|
16213
|
+
|
|
16214
|
+
<dl>
|
|
16215
|
+
<dd>
|
|
16216
|
+
|
|
16217
|
+
Create or replace the selected groups for a connection directory provisioning configuration.
|
|
16218
|
+
|
|
16219
|
+
</dd>
|
|
16220
|
+
</dl>
|
|
16221
|
+
</dd>
|
|
16222
|
+
</dl>
|
|
16223
|
+
|
|
16224
|
+
#### 🔌 Usage
|
|
16225
|
+
|
|
16226
|
+
<dl>
|
|
16227
|
+
<dd>
|
|
16228
|
+
|
|
16229
|
+
<dl>
|
|
16230
|
+
<dd>
|
|
16231
|
+
|
|
16232
|
+
```typescript
|
|
16233
|
+
await client.connections.directoryProvisioning.set("id", {
|
|
16234
|
+
groups: [
|
|
16235
|
+
{
|
|
16236
|
+
id: "id",
|
|
16237
|
+
},
|
|
16238
|
+
],
|
|
16239
|
+
});
|
|
16240
|
+
```
|
|
16241
|
+
|
|
16242
|
+
</dd>
|
|
16243
|
+
</dl>
|
|
16244
|
+
</dd>
|
|
16245
|
+
</dl>
|
|
16246
|
+
|
|
16247
|
+
#### ⚙️ Parameters
|
|
16248
|
+
|
|
16249
|
+
<dl>
|
|
16250
|
+
<dd>
|
|
16251
|
+
|
|
16252
|
+
<dl>
|
|
16253
|
+
<dd>
|
|
16254
|
+
|
|
16255
|
+
**id:** `string` — The id of the connection to create or replace synchronized groups for
|
|
16256
|
+
|
|
16257
|
+
</dd>
|
|
16258
|
+
</dl>
|
|
16259
|
+
|
|
16260
|
+
<dl>
|
|
16261
|
+
<dd>
|
|
16262
|
+
|
|
16263
|
+
**request:** `Management.ReplaceSynchronizedGroupsRequestContent`
|
|
16264
|
+
|
|
16265
|
+
</dd>
|
|
16266
|
+
</dl>
|
|
16267
|
+
|
|
16268
|
+
<dl>
|
|
16269
|
+
<dd>
|
|
16270
|
+
|
|
16271
|
+
**requestOptions:** `DirectoryProvisioningClient.RequestOptions`
|
|
16272
|
+
|
|
16273
|
+
</dd>
|
|
16274
|
+
</dl>
|
|
16275
|
+
</dd>
|
|
16276
|
+
</dl>
|
|
16277
|
+
|
|
16278
|
+
</dd>
|
|
16279
|
+
</dl>
|
|
16280
|
+
</details>
|
|
16281
|
+
|
|
15932
16282
|
## Connections ScimConfiguration
|
|
15933
16283
|
|
|
15934
16284
|
<details><summary><code>client.connections.scimConfiguration.<a href="/src/management/api/resources/connections/resources/scimConfiguration/client/Client.ts">list</a>({ ...params }) -> core.Page<Management.ScimConfiguration, Management.ListScimConfigurationsResponseContent></code></summary>
|