auth0 5.2.0 → 5.3.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/LICENSE +1 -1
- package/dist/cjs/management/Client.d.ts +3 -0
- package/dist/cjs/management/Client.js +59 -54
- package/dist/cjs/management/api/errors/PreconditionFailedError.d.ts +5 -0
- package/dist/cjs/management/api/errors/PreconditionFailedError.js +54 -0
- package/dist/cjs/management/api/errors/index.d.ts +1 -0
- package/dist/cjs/management/api/errors/index.js +1 -0
- package/dist/cjs/management/api/requests/requests.d.ts +185 -10
- package/dist/cjs/management/api/resources/actions/client/Client.d.ts +3 -0
- package/dist/cjs/management/api/resources/actions/client/Client.js +9 -4
- package/dist/cjs/management/api/resources/actions/resources/index.d.ts +1 -0
- package/dist/cjs/management/api/resources/actions/resources/index.js +2 -1
- package/dist/cjs/management/api/resources/actions/resources/modules/client/Client.d.ts +149 -0
- package/dist/cjs/management/api/resources/actions/resources/modules/client/Client.js +569 -0
- package/dist/cjs/management/api/resources/actions/resources/modules/client/index.d.ts +1 -0
- package/dist/cjs/management/api/resources/actions/resources/modules/client/index.js +2 -0
- package/dist/cjs/management/api/resources/actions/resources/modules/index.d.ts +2 -0
- package/dist/cjs/management/api/resources/actions/resources/modules/index.js +18 -0
- package/dist/cjs/management/api/resources/actions/resources/modules/resources/index.d.ts +1 -0
- package/dist/cjs/management/api/resources/actions/resources/modules/resources/index.js +37 -0
- package/dist/cjs/management/api/resources/actions/resources/modules/resources/versions/client/Client.d.ts +66 -0
- package/dist/cjs/management/api/resources/actions/resources/modules/resources/versions/client/Client.js +252 -0
- package/dist/cjs/management/api/resources/actions/resources/modules/resources/versions/client/index.d.ts +1 -0
- package/dist/cjs/management/api/resources/actions/resources/modules/resources/versions/client/index.js +2 -0
- package/dist/cjs/management/api/resources/actions/resources/modules/resources/versions/index.d.ts +1 -0
- package/dist/cjs/management/api/resources/actions/resources/modules/resources/versions/index.js +17 -0
- package/dist/cjs/management/api/resources/clientGrants/client/Client.d.ts +17 -0
- package/dist/cjs/management/api/resources/clientGrants/client/Client.js +61 -0
- package/dist/cjs/management/api/resources/connections/client/Client.d.ts +7 -3
- package/dist/cjs/management/api/resources/connections/client/Client.js +9 -5
- package/dist/cjs/management/api/resources/connections/resources/directoryProvisioning/client/Client.d.ts +18 -0
- package/dist/cjs/management/api/resources/connections/resources/directoryProvisioning/client/Client.js +80 -0
- package/dist/cjs/management/api/resources/deviceCredentials/client/Client.d.ts +1 -0
- package/dist/cjs/management/api/resources/deviceCredentials/client/Client.js +2 -1
- package/dist/cjs/management/api/resources/eventStreams/client/Client.d.ts +1 -2
- package/dist/cjs/management/api/resources/eventStreams/client/Client.js +59 -50
- package/dist/cjs/management/api/resources/flows/index.d.ts +1 -0
- package/dist/cjs/management/api/resources/flows/index.js +1 -0
- package/dist/cjs/management/api/resources/flows/resources/executions/index.d.ts +1 -0
- package/dist/cjs/management/api/resources/flows/resources/executions/index.js +1 -0
- package/dist/cjs/management/api/resources/flows/resources/executions/types/index.d.ts +1 -0
- package/dist/cjs/management/api/resources/flows/resources/executions/types/index.js +17 -0
- package/dist/cjs/management/api/resources/flows/resources/executions/types/types.d.ts +4 -0
- package/dist/cjs/management/api/resources/flows/resources/executions/types/types.js +7 -0
- package/dist/cjs/management/api/resources/flows/resources/index.d.ts +1 -0
- package/dist/cjs/management/api/resources/flows/resources/index.js +4 -0
- package/dist/cjs/management/api/resources/flows/types/index.d.ts +1 -0
- package/dist/cjs/management/api/resources/flows/types/index.js +17 -0
- package/dist/cjs/management/api/resources/flows/types/types.d.ts +4 -0
- package/dist/cjs/management/api/resources/flows/types/types.js +7 -0
- package/dist/cjs/management/api/resources/groups/client/Client.d.ts +56 -0
- package/dist/cjs/management/api/resources/groups/client/Client.js +224 -0
- package/dist/cjs/management/api/resources/groups/client/index.d.ts +1 -0
- package/dist/cjs/management/api/resources/groups/client/index.js +2 -0
- package/dist/cjs/management/api/resources/groups/index.d.ts +2 -0
- package/dist/cjs/management/api/resources/groups/index.js +18 -0
- package/dist/cjs/management/api/resources/groups/resources/index.d.ts +1 -0
- package/dist/cjs/management/api/resources/groups/resources/index.js +37 -0
- package/dist/cjs/management/api/resources/groups/resources/members/client/Client.d.ts +34 -0
- package/dist/cjs/management/api/resources/groups/resources/members/client/Client.js +148 -0
- package/dist/cjs/management/api/resources/groups/resources/members/client/index.d.ts +1 -0
- package/dist/cjs/management/api/resources/groups/resources/members/client/index.js +2 -0
- package/dist/cjs/management/api/resources/groups/resources/members/index.d.ts +1 -0
- package/dist/cjs/management/api/resources/groups/resources/members/index.js +17 -0
- package/dist/cjs/management/api/resources/index.d.ts +2 -0
- package/dist/cjs/management/api/resources/index.js +3 -1
- package/dist/cjs/management/api/resources/organizations/resources/discoveryDomains/client/Client.d.ts +20 -1
- package/dist/cjs/management/api/resources/organizations/resources/discoveryDomains/client/Client.js +66 -1
- package/dist/cjs/management/api/resources/prompts/resources/rendering/client/Client.d.ts +1 -1
- package/dist/cjs/management/api/resources/refreshTokens/client/Client.d.ts +18 -0
- package/dist/cjs/management/api/resources/refreshTokens/client/Client.js +67 -0
- package/dist/cjs/management/api/resources/roles/client/Client.d.ts +1 -0
- package/dist/cjs/management/api/resources/roles/client/Client.js +3 -0
- package/dist/cjs/management/api/resources/tokenExchangeProfiles/client/Client.d.ts +2 -1
- package/dist/cjs/management/api/resources/tokenExchangeProfiles/client/Client.js +3 -2
- package/dist/cjs/management/api/resources/users/client/Client.d.ts +3 -0
- package/dist/cjs/management/api/resources/users/client/Client.js +23 -18
- package/dist/cjs/management/api/resources/users/resources/groups/client/Client.d.ts +34 -0
- package/dist/cjs/management/api/resources/users/resources/groups/client/Client.js +148 -0
- package/dist/cjs/management/api/resources/users/resources/groups/client/index.d.ts +1 -0
- package/dist/cjs/management/api/resources/users/resources/groups/client/index.js +2 -0
- package/dist/cjs/management/api/resources/users/resources/groups/index.d.ts +1 -0
- package/dist/cjs/management/api/resources/users/resources/groups/index.js +17 -0
- package/dist/cjs/management/api/resources/users/resources/index.d.ts +1 -0
- package/dist/cjs/management/api/resources/users/resources/index.js +2 -1
- package/dist/cjs/management/api/types/types.d.ts +4374 -959
- package/dist/cjs/management/api/types/types.js +1715 -11
- package/dist/cjs/management/version.d.ts +1 -1
- package/dist/cjs/management/version.js +1 -1
- package/dist/esm/management/Client.d.mts +3 -0
- package/dist/esm/management/Client.mjs +5 -0
- package/dist/esm/management/api/errors/PreconditionFailedError.d.mts +5 -0
- package/dist/esm/management/api/errors/PreconditionFailedError.mjs +17 -0
- package/dist/esm/management/api/errors/index.d.mts +1 -0
- package/dist/esm/management/api/errors/index.mjs +1 -0
- package/dist/esm/management/api/requests/requests.d.mts +185 -10
- package/dist/esm/management/api/resources/actions/client/Client.d.mts +3 -0
- package/dist/esm/management/api/resources/actions/client/Client.mjs +5 -0
- package/dist/esm/management/api/resources/actions/resources/index.d.mts +1 -0
- package/dist/esm/management/api/resources/actions/resources/index.mjs +1 -0
- package/dist/esm/management/api/resources/actions/resources/modules/client/Client.d.mts +149 -0
- package/dist/esm/management/api/resources/actions/resources/modules/client/Client.mjs +532 -0
- package/dist/esm/management/api/resources/actions/resources/modules/client/index.d.mts +1 -0
- package/dist/esm/management/api/resources/actions/resources/modules/client/index.mjs +1 -0
- package/dist/esm/management/api/resources/actions/resources/modules/index.d.mts +2 -0
- package/dist/esm/management/api/resources/actions/resources/modules/index.mjs +2 -0
- package/dist/esm/management/api/resources/actions/resources/modules/resources/index.d.mts +1 -0
- package/dist/esm/management/api/resources/actions/resources/modules/resources/index.mjs +1 -0
- package/dist/esm/management/api/resources/actions/resources/modules/resources/versions/client/Client.d.mts +66 -0
- package/dist/esm/management/api/resources/actions/resources/modules/resources/versions/client/Client.mjs +215 -0
- package/dist/esm/management/api/resources/actions/resources/modules/resources/versions/client/index.d.mts +1 -0
- package/dist/esm/management/api/resources/actions/resources/modules/resources/versions/client/index.mjs +1 -0
- package/dist/esm/management/api/resources/actions/resources/modules/resources/versions/index.d.mts +1 -0
- package/dist/esm/management/api/resources/actions/resources/modules/resources/versions/index.mjs +1 -0
- package/dist/esm/management/api/resources/clientGrants/client/Client.d.mts +17 -0
- package/dist/esm/management/api/resources/clientGrants/client/Client.mjs +61 -0
- package/dist/esm/management/api/resources/connections/client/Client.d.mts +7 -3
- package/dist/esm/management/api/resources/connections/client/Client.mjs +9 -5
- package/dist/esm/management/api/resources/connections/resources/directoryProvisioning/client/Client.d.mts +18 -0
- package/dist/esm/management/api/resources/connections/resources/directoryProvisioning/client/Client.mjs +80 -0
- package/dist/esm/management/api/resources/deviceCredentials/client/Client.d.mts +1 -0
- package/dist/esm/management/api/resources/deviceCredentials/client/Client.mjs +2 -1
- package/dist/esm/management/api/resources/eventStreams/client/Client.d.mts +1 -2
- package/dist/esm/management/api/resources/eventStreams/client/Client.mjs +59 -50
- package/dist/esm/management/api/resources/flows/index.d.mts +1 -0
- package/dist/esm/management/api/resources/flows/index.mjs +1 -0
- package/dist/esm/management/api/resources/flows/resources/executions/index.d.mts +1 -0
- package/dist/esm/management/api/resources/flows/resources/executions/index.mjs +1 -0
- package/dist/esm/management/api/resources/flows/resources/executions/types/index.d.mts +1 -0
- package/dist/esm/management/api/resources/flows/resources/executions/types/index.mjs +1 -0
- package/dist/esm/management/api/resources/flows/resources/executions/types/types.d.mts +4 -0
- package/dist/esm/management/api/resources/flows/resources/executions/types/types.mjs +4 -0
- package/dist/esm/management/api/resources/flows/resources/index.d.mts +1 -0
- package/dist/esm/management/api/resources/flows/resources/index.mjs +1 -0
- package/dist/esm/management/api/resources/flows/types/index.d.mts +1 -0
- package/dist/esm/management/api/resources/flows/types/index.mjs +1 -0
- package/dist/esm/management/api/resources/flows/types/types.d.mts +4 -0
- package/dist/esm/management/api/resources/flows/types/types.mjs +4 -0
- package/dist/esm/management/api/resources/groups/client/Client.d.mts +56 -0
- package/dist/esm/management/api/resources/groups/client/Client.mjs +187 -0
- package/dist/esm/management/api/resources/groups/client/index.d.mts +1 -0
- package/dist/esm/management/api/resources/groups/client/index.mjs +1 -0
- package/dist/esm/management/api/resources/groups/index.d.mts +2 -0
- package/dist/esm/management/api/resources/groups/index.mjs +2 -0
- package/dist/esm/management/api/resources/groups/resources/index.d.mts +1 -0
- package/dist/esm/management/api/resources/groups/resources/index.mjs +1 -0
- package/dist/esm/management/api/resources/groups/resources/members/client/Client.d.mts +34 -0
- package/dist/esm/management/api/resources/groups/resources/members/client/Client.mjs +111 -0
- package/dist/esm/management/api/resources/groups/resources/members/client/index.d.mts +1 -0
- package/dist/esm/management/api/resources/groups/resources/members/client/index.mjs +1 -0
- package/dist/esm/management/api/resources/groups/resources/members/index.d.mts +1 -0
- package/dist/esm/management/api/resources/groups/resources/members/index.mjs +1 -0
- package/dist/esm/management/api/resources/index.d.mts +2 -0
- package/dist/esm/management/api/resources/index.mjs +2 -0
- package/dist/esm/management/api/resources/organizations/resources/discoveryDomains/client/Client.d.mts +20 -1
- package/dist/esm/management/api/resources/organizations/resources/discoveryDomains/client/Client.mjs +66 -1
- package/dist/esm/management/api/resources/prompts/resources/rendering/client/Client.d.mts +1 -1
- package/dist/esm/management/api/resources/refreshTokens/client/Client.d.mts +18 -0
- package/dist/esm/management/api/resources/refreshTokens/client/Client.mjs +67 -0
- package/dist/esm/management/api/resources/roles/client/Client.d.mts +1 -0
- package/dist/esm/management/api/resources/roles/client/Client.mjs +3 -0
- package/dist/esm/management/api/resources/tokenExchangeProfiles/client/Client.d.mts +2 -1
- package/dist/esm/management/api/resources/tokenExchangeProfiles/client/Client.mjs +3 -2
- package/dist/esm/management/api/resources/users/client/Client.d.mts +3 -0
- package/dist/esm/management/api/resources/users/client/Client.mjs +5 -0
- package/dist/esm/management/api/resources/users/resources/groups/client/Client.d.mts +34 -0
- package/dist/esm/management/api/resources/users/resources/groups/client/Client.mjs +111 -0
- package/dist/esm/management/api/resources/users/resources/groups/client/index.d.mts +1 -0
- package/dist/esm/management/api/resources/users/resources/groups/client/index.mjs +1 -0
- package/dist/esm/management/api/resources/users/resources/groups/index.d.mts +1 -0
- package/dist/esm/management/api/resources/users/resources/groups/index.mjs +1 -0
- package/dist/esm/management/api/resources/users/resources/index.d.mts +1 -0
- package/dist/esm/management/api/resources/users/resources/index.mjs +1 -0
- package/dist/esm/management/api/types/types.d.mts +4374 -959
- package/dist/esm/management/api/types/types.mjs +1705 -7
- 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 +1547 -186
package/reference.md
CHANGED
|
@@ -783,6 +783,70 @@ await client.clientGrants.create({
|
|
|
783
783
|
</dl>
|
|
784
784
|
</details>
|
|
785
785
|
|
|
786
|
+
<details><summary><code>client.clientGrants.<a href="/src/management/api/resources/clientGrants/client/Client.ts">get</a>(id) -> Management.GetClientGrantResponseContent</code></summary>
|
|
787
|
+
<dl>
|
|
788
|
+
<dd>
|
|
789
|
+
|
|
790
|
+
#### 📝 Description
|
|
791
|
+
|
|
792
|
+
<dl>
|
|
793
|
+
<dd>
|
|
794
|
+
|
|
795
|
+
<dl>
|
|
796
|
+
<dd>
|
|
797
|
+
|
|
798
|
+
Retrieve a single <a href="https://auth0.com/docs/get-started/applications/application-access-to-apis-client-grants">client grant</a>, including the
|
|
799
|
+
scopes associated with the application/API pair.
|
|
800
|
+
|
|
801
|
+
</dd>
|
|
802
|
+
</dl>
|
|
803
|
+
</dd>
|
|
804
|
+
</dl>
|
|
805
|
+
|
|
806
|
+
#### 🔌 Usage
|
|
807
|
+
|
|
808
|
+
<dl>
|
|
809
|
+
<dd>
|
|
810
|
+
|
|
811
|
+
<dl>
|
|
812
|
+
<dd>
|
|
813
|
+
|
|
814
|
+
```typescript
|
|
815
|
+
await client.clientGrants.get("id");
|
|
816
|
+
```
|
|
817
|
+
|
|
818
|
+
</dd>
|
|
819
|
+
</dl>
|
|
820
|
+
</dd>
|
|
821
|
+
</dl>
|
|
822
|
+
|
|
823
|
+
#### ⚙️ Parameters
|
|
824
|
+
|
|
825
|
+
<dl>
|
|
826
|
+
<dd>
|
|
827
|
+
|
|
828
|
+
<dl>
|
|
829
|
+
<dd>
|
|
830
|
+
|
|
831
|
+
**id:** `string` — The ID of the client grant to retrieve.
|
|
832
|
+
|
|
833
|
+
</dd>
|
|
834
|
+
</dl>
|
|
835
|
+
|
|
836
|
+
<dl>
|
|
837
|
+
<dd>
|
|
838
|
+
|
|
839
|
+
**requestOptions:** `ClientGrantsClient.RequestOptions`
|
|
840
|
+
|
|
841
|
+
</dd>
|
|
842
|
+
</dl>
|
|
843
|
+
</dd>
|
|
844
|
+
</dl>
|
|
845
|
+
|
|
846
|
+
</dd>
|
|
847
|
+
</dl>
|
|
848
|
+
</details>
|
|
849
|
+
|
|
786
850
|
<details><summary><code>client.clientGrants.<a href="/src/management/api/resources/clientGrants/client/Client.ts">delete</a>(id) -> void</code></summary>
|
|
787
851
|
<dl>
|
|
788
852
|
<dd>
|
|
@@ -2020,7 +2084,9 @@ const response = page.response;
|
|
|
2020
2084
|
<dl>
|
|
2021
2085
|
<dd>
|
|
2022
2086
|
|
|
2023
|
-
Creates a new connection according to the JSON object received in <code>body</code
|
|
2087
|
+
Creates a new connection according to the JSON object received in <code>body</code>.
|
|
2088
|
+
|
|
2089
|
+
<b>Note:</b> If a connection with the same name was recently deleted and had a large number of associated users, the deletion may still be processing. Creating a new connection with that name before the deletion completes may fail or produce unexpected results.
|
|
2024
2090
|
|
|
2025
2091
|
</dd>
|
|
2026
2092
|
</dl>
|
|
@@ -2162,6 +2228,8 @@ await client.connections.get("id", {
|
|
|
2162
2228
|
|
|
2163
2229
|
Removes a specific <a href="https://auth0.com/docs/authenticate/identity-providers">connection</a> from your tenant. This action cannot be undone. Once removed, users can no longer use this connection to authenticate.
|
|
2164
2230
|
|
|
2231
|
+
<b>Note:</b> If your connection has a large amount of users associated with it, please be aware that this operation can be long running after the response is returned and may impact concurrent <a href="https://auth0.com/docs/api/management/v2/connections/post-connections">create connection</a> requests, if they use an identical connection name.
|
|
2232
|
+
|
|
2165
2233
|
</dd>
|
|
2166
2234
|
</dl>
|
|
2167
2235
|
</dd>
|
|
@@ -2971,6 +3039,7 @@ When refresh token rotation is enabled, the endpoint becomes consistent. For mor
|
|
|
2971
3039
|
```typescript
|
|
2972
3040
|
await client.deviceCredentials.createPublicKey({
|
|
2973
3041
|
device_name: "device_name",
|
|
3042
|
+
type: "public_key",
|
|
2974
3043
|
value: "value",
|
|
2975
3044
|
device_id: "device_id",
|
|
2976
3045
|
});
|
|
@@ -3347,7 +3416,7 @@ await client.emailTemplates.update("verify_email");
|
|
|
3347
3416
|
|
|
3348
3417
|
## EventStreams
|
|
3349
3418
|
|
|
3350
|
-
<details><summary><code>client.eventStreams.<a href="/src/management/api/resources/eventStreams/client/Client.ts">list</a>({ ...params }) -> Management.EventStreamResponseContent
|
|
3419
|
+
<details><summary><code>client.eventStreams.<a href="/src/management/api/resources/eventStreams/client/Client.ts">list</a>({ ...params }) -> core.Page<Management.EventStreamResponseContent, Management.ListEventStreamsResponseContent></code></summary>
|
|
3351
3420
|
<dl>
|
|
3352
3421
|
<dd>
|
|
3353
3422
|
|
|
@@ -3360,10 +3429,25 @@ await client.emailTemplates.update("verify_email");
|
|
|
3360
3429
|
<dd>
|
|
3361
3430
|
|
|
3362
3431
|
```typescript
|
|
3363
|
-
await client.eventStreams.list({
|
|
3432
|
+
const pageableResponse = await client.eventStreams.list({
|
|
3433
|
+
from: "from",
|
|
3434
|
+
take: 1,
|
|
3435
|
+
});
|
|
3436
|
+
for await (const item of pageableResponse) {
|
|
3437
|
+
console.log(item);
|
|
3438
|
+
}
|
|
3439
|
+
|
|
3440
|
+
// Or you can manually iterate page-by-page
|
|
3441
|
+
let page = await client.eventStreams.list({
|
|
3364
3442
|
from: "from",
|
|
3365
3443
|
take: 1,
|
|
3366
3444
|
});
|
|
3445
|
+
while (page.hasNextPage()) {
|
|
3446
|
+
page = page.getNextPage();
|
|
3447
|
+
}
|
|
3448
|
+
|
|
3449
|
+
// You can also access the underlying response
|
|
3450
|
+
const response = page.response;
|
|
3367
3451
|
```
|
|
3368
3452
|
|
|
3369
3453
|
</dd>
|
|
@@ -4448,6 +4532,162 @@ await client.userGrants.delete("id");
|
|
|
4448
4532
|
</dl>
|
|
4449
4533
|
</details>
|
|
4450
4534
|
|
|
4535
|
+
## Groups
|
|
4536
|
+
|
|
4537
|
+
<details><summary><code>client.groups.<a href="/src/management/api/resources/groups/client/Client.ts">list</a>({ ...params }) -> core.Page<Management.Group, Management.ListGroupsPaginatedResponseContent></code></summary>
|
|
4538
|
+
<dl>
|
|
4539
|
+
<dd>
|
|
4540
|
+
|
|
4541
|
+
#### 📝 Description
|
|
4542
|
+
|
|
4543
|
+
<dl>
|
|
4544
|
+
<dd>
|
|
4545
|
+
|
|
4546
|
+
<dl>
|
|
4547
|
+
<dd>
|
|
4548
|
+
|
|
4549
|
+
List all groups in your tenant.
|
|
4550
|
+
|
|
4551
|
+
</dd>
|
|
4552
|
+
</dl>
|
|
4553
|
+
</dd>
|
|
4554
|
+
</dl>
|
|
4555
|
+
|
|
4556
|
+
#### 🔌 Usage
|
|
4557
|
+
|
|
4558
|
+
<dl>
|
|
4559
|
+
<dd>
|
|
4560
|
+
|
|
4561
|
+
<dl>
|
|
4562
|
+
<dd>
|
|
4563
|
+
|
|
4564
|
+
```typescript
|
|
4565
|
+
const pageableResponse = await client.groups.list({
|
|
4566
|
+
connection_id: "connection_id",
|
|
4567
|
+
name: "name",
|
|
4568
|
+
external_id: "external_id",
|
|
4569
|
+
fields: "fields",
|
|
4570
|
+
include_fields: true,
|
|
4571
|
+
from: "from",
|
|
4572
|
+
take: 1,
|
|
4573
|
+
});
|
|
4574
|
+
for await (const item of pageableResponse) {
|
|
4575
|
+
console.log(item);
|
|
4576
|
+
}
|
|
4577
|
+
|
|
4578
|
+
// Or you can manually iterate page-by-page
|
|
4579
|
+
let page = await client.groups.list({
|
|
4580
|
+
connection_id: "connection_id",
|
|
4581
|
+
name: "name",
|
|
4582
|
+
external_id: "external_id",
|
|
4583
|
+
fields: "fields",
|
|
4584
|
+
include_fields: true,
|
|
4585
|
+
from: "from",
|
|
4586
|
+
take: 1,
|
|
4587
|
+
});
|
|
4588
|
+
while (page.hasNextPage()) {
|
|
4589
|
+
page = page.getNextPage();
|
|
4590
|
+
}
|
|
4591
|
+
|
|
4592
|
+
// You can also access the underlying response
|
|
4593
|
+
const response = page.response;
|
|
4594
|
+
```
|
|
4595
|
+
|
|
4596
|
+
</dd>
|
|
4597
|
+
</dl>
|
|
4598
|
+
</dd>
|
|
4599
|
+
</dl>
|
|
4600
|
+
|
|
4601
|
+
#### ⚙️ Parameters
|
|
4602
|
+
|
|
4603
|
+
<dl>
|
|
4604
|
+
<dd>
|
|
4605
|
+
|
|
4606
|
+
<dl>
|
|
4607
|
+
<dd>
|
|
4608
|
+
|
|
4609
|
+
**request:** `Management.ListGroupsRequestParameters`
|
|
4610
|
+
|
|
4611
|
+
</dd>
|
|
4612
|
+
</dl>
|
|
4613
|
+
|
|
4614
|
+
<dl>
|
|
4615
|
+
<dd>
|
|
4616
|
+
|
|
4617
|
+
**requestOptions:** `GroupsClient.RequestOptions`
|
|
4618
|
+
|
|
4619
|
+
</dd>
|
|
4620
|
+
</dl>
|
|
4621
|
+
</dd>
|
|
4622
|
+
</dl>
|
|
4623
|
+
|
|
4624
|
+
</dd>
|
|
4625
|
+
</dl>
|
|
4626
|
+
</details>
|
|
4627
|
+
|
|
4628
|
+
<details><summary><code>client.groups.<a href="/src/management/api/resources/groups/client/Client.ts">get</a>(id) -> Management.GetGroupResponseContent</code></summary>
|
|
4629
|
+
<dl>
|
|
4630
|
+
<dd>
|
|
4631
|
+
|
|
4632
|
+
#### 📝 Description
|
|
4633
|
+
|
|
4634
|
+
<dl>
|
|
4635
|
+
<dd>
|
|
4636
|
+
|
|
4637
|
+
<dl>
|
|
4638
|
+
<dd>
|
|
4639
|
+
|
|
4640
|
+
Retrieve a group by its ID.
|
|
4641
|
+
|
|
4642
|
+
</dd>
|
|
4643
|
+
</dl>
|
|
4644
|
+
</dd>
|
|
4645
|
+
</dl>
|
|
4646
|
+
|
|
4647
|
+
#### 🔌 Usage
|
|
4648
|
+
|
|
4649
|
+
<dl>
|
|
4650
|
+
<dd>
|
|
4651
|
+
|
|
4652
|
+
<dl>
|
|
4653
|
+
<dd>
|
|
4654
|
+
|
|
4655
|
+
```typescript
|
|
4656
|
+
await client.groups.get("id");
|
|
4657
|
+
```
|
|
4658
|
+
|
|
4659
|
+
</dd>
|
|
4660
|
+
</dl>
|
|
4661
|
+
</dd>
|
|
4662
|
+
</dl>
|
|
4663
|
+
|
|
4664
|
+
#### ⚙️ Parameters
|
|
4665
|
+
|
|
4666
|
+
<dl>
|
|
4667
|
+
<dd>
|
|
4668
|
+
|
|
4669
|
+
<dl>
|
|
4670
|
+
<dd>
|
|
4671
|
+
|
|
4672
|
+
**id:** `string` — Unique identifier for the group (service-generated).
|
|
4673
|
+
|
|
4674
|
+
</dd>
|
|
4675
|
+
</dl>
|
|
4676
|
+
|
|
4677
|
+
<dl>
|
|
4678
|
+
<dd>
|
|
4679
|
+
|
|
4680
|
+
**requestOptions:** `GroupsClient.RequestOptions`
|
|
4681
|
+
|
|
4682
|
+
</dd>
|
|
4683
|
+
</dl>
|
|
4684
|
+
</dd>
|
|
4685
|
+
</dl>
|
|
4686
|
+
|
|
4687
|
+
</dd>
|
|
4688
|
+
</dl>
|
|
4689
|
+
</details>
|
|
4690
|
+
|
|
4451
4691
|
## Hooks
|
|
4452
4692
|
|
|
4453
4693
|
<details><summary><code>client.hooks.<a href="/src/management/api/resources/hooks/client/Client.ts">list</a>({ ...params }) -> core.Page<Management.Hook, Management.ListHooksOffsetPaginatedResponseContent></code></summary>
|
|
@@ -6818,9 +7058,7 @@ await client.refreshTokens.delete("id");
|
|
|
6818
7058
|
</dl>
|
|
6819
7059
|
</details>
|
|
6820
7060
|
|
|
6821
|
-
|
|
6822
|
-
|
|
6823
|
-
<details><summary><code>client.resourceServers.<a href="/src/management/api/resources/resourceServers/client/Client.ts">list</a>({ ...params }) -> core.Page<Management.ResourceServer, Management.ListResourceServerOffsetPaginatedResponseContent></code></summary>
|
|
7061
|
+
<details><summary><code>client.refreshTokens.<a href="/src/management/api/resources/refreshTokens/client/Client.ts">update</a>(id, { ...params }) -> Management.UpdateRefreshTokenResponseContent</code></summary>
|
|
6824
7062
|
<dl>
|
|
6825
7063
|
<dd>
|
|
6826
7064
|
|
|
@@ -6832,7 +7070,7 @@ await client.refreshTokens.delete("id");
|
|
|
6832
7070
|
<dl>
|
|
6833
7071
|
<dd>
|
|
6834
7072
|
|
|
6835
|
-
|
|
7073
|
+
Update a refresh token by its ID.
|
|
6836
7074
|
|
|
6837
7075
|
</dd>
|
|
6838
7076
|
</dl>
|
|
@@ -6848,29 +7086,7 @@ Retrieve details of all APIs associated with your tenant.
|
|
|
6848
7086
|
<dd>
|
|
6849
7087
|
|
|
6850
7088
|
```typescript
|
|
6851
|
-
|
|
6852
|
-
page: 1,
|
|
6853
|
-
per_page: 1,
|
|
6854
|
-
include_totals: true,
|
|
6855
|
-
include_fields: true,
|
|
6856
|
-
});
|
|
6857
|
-
for await (const item of pageableResponse) {
|
|
6858
|
-
console.log(item);
|
|
6859
|
-
}
|
|
6860
|
-
|
|
6861
|
-
// Or you can manually iterate page-by-page
|
|
6862
|
-
let page = await client.resourceServers.list({
|
|
6863
|
-
page: 1,
|
|
6864
|
-
per_page: 1,
|
|
6865
|
-
include_totals: true,
|
|
6866
|
-
include_fields: true,
|
|
6867
|
-
});
|
|
6868
|
-
while (page.hasNextPage()) {
|
|
6869
|
-
page = page.getNextPage();
|
|
6870
|
-
}
|
|
6871
|
-
|
|
6872
|
-
// You can also access the underlying response
|
|
6873
|
-
const response = page.response;
|
|
7089
|
+
await client.refreshTokens.update("id");
|
|
6874
7090
|
```
|
|
6875
7091
|
|
|
6876
7092
|
</dd>
|
|
@@ -6886,7 +7102,7 @@ const response = page.response;
|
|
|
6886
7102
|
<dl>
|
|
6887
7103
|
<dd>
|
|
6888
7104
|
|
|
6889
|
-
**
|
|
7105
|
+
**id:** `string` — ID of the refresh token to update.
|
|
6890
7106
|
|
|
6891
7107
|
</dd>
|
|
6892
7108
|
</dl>
|
|
@@ -6894,7 +7110,15 @@ const response = page.response;
|
|
|
6894
7110
|
<dl>
|
|
6895
7111
|
<dd>
|
|
6896
7112
|
|
|
6897
|
-
**
|
|
7113
|
+
**request:** `Management.UpdateRefreshTokenRequestContent`
|
|
7114
|
+
|
|
7115
|
+
</dd>
|
|
7116
|
+
</dl>
|
|
7117
|
+
|
|
7118
|
+
<dl>
|
|
7119
|
+
<dd>
|
|
7120
|
+
|
|
7121
|
+
**requestOptions:** `RefreshTokensClient.RequestOptions`
|
|
6898
7122
|
|
|
6899
7123
|
</dd>
|
|
6900
7124
|
</dl>
|
|
@@ -6905,7 +7129,94 @@ const response = page.response;
|
|
|
6905
7129
|
</dl>
|
|
6906
7130
|
</details>
|
|
6907
7131
|
|
|
6908
|
-
|
|
7132
|
+
## ResourceServers
|
|
7133
|
+
|
|
7134
|
+
<details><summary><code>client.resourceServers.<a href="/src/management/api/resources/resourceServers/client/Client.ts">list</a>({ ...params }) -> core.Page<Management.ResourceServer, Management.ListResourceServerOffsetPaginatedResponseContent></code></summary>
|
|
7135
|
+
<dl>
|
|
7136
|
+
<dd>
|
|
7137
|
+
|
|
7138
|
+
#### 📝 Description
|
|
7139
|
+
|
|
7140
|
+
<dl>
|
|
7141
|
+
<dd>
|
|
7142
|
+
|
|
7143
|
+
<dl>
|
|
7144
|
+
<dd>
|
|
7145
|
+
|
|
7146
|
+
Retrieve details of all APIs associated with your tenant.
|
|
7147
|
+
|
|
7148
|
+
</dd>
|
|
7149
|
+
</dl>
|
|
7150
|
+
</dd>
|
|
7151
|
+
</dl>
|
|
7152
|
+
|
|
7153
|
+
#### 🔌 Usage
|
|
7154
|
+
|
|
7155
|
+
<dl>
|
|
7156
|
+
<dd>
|
|
7157
|
+
|
|
7158
|
+
<dl>
|
|
7159
|
+
<dd>
|
|
7160
|
+
|
|
7161
|
+
```typescript
|
|
7162
|
+
const pageableResponse = await client.resourceServers.list({
|
|
7163
|
+
page: 1,
|
|
7164
|
+
per_page: 1,
|
|
7165
|
+
include_totals: true,
|
|
7166
|
+
include_fields: true,
|
|
7167
|
+
});
|
|
7168
|
+
for await (const item of pageableResponse) {
|
|
7169
|
+
console.log(item);
|
|
7170
|
+
}
|
|
7171
|
+
|
|
7172
|
+
// Or you can manually iterate page-by-page
|
|
7173
|
+
let page = await client.resourceServers.list({
|
|
7174
|
+
page: 1,
|
|
7175
|
+
per_page: 1,
|
|
7176
|
+
include_totals: true,
|
|
7177
|
+
include_fields: true,
|
|
7178
|
+
});
|
|
7179
|
+
while (page.hasNextPage()) {
|
|
7180
|
+
page = page.getNextPage();
|
|
7181
|
+
}
|
|
7182
|
+
|
|
7183
|
+
// You can also access the underlying response
|
|
7184
|
+
const response = page.response;
|
|
7185
|
+
```
|
|
7186
|
+
|
|
7187
|
+
</dd>
|
|
7188
|
+
</dl>
|
|
7189
|
+
</dd>
|
|
7190
|
+
</dl>
|
|
7191
|
+
|
|
7192
|
+
#### ⚙️ Parameters
|
|
7193
|
+
|
|
7194
|
+
<dl>
|
|
7195
|
+
<dd>
|
|
7196
|
+
|
|
7197
|
+
<dl>
|
|
7198
|
+
<dd>
|
|
7199
|
+
|
|
7200
|
+
**request:** `Management.ListResourceServerRequestParameters`
|
|
7201
|
+
|
|
7202
|
+
</dd>
|
|
7203
|
+
</dl>
|
|
7204
|
+
|
|
7205
|
+
<dl>
|
|
7206
|
+
<dd>
|
|
7207
|
+
|
|
7208
|
+
**requestOptions:** `ResourceServersClient.RequestOptions`
|
|
7209
|
+
|
|
7210
|
+
</dd>
|
|
7211
|
+
</dl>
|
|
7212
|
+
</dd>
|
|
7213
|
+
</dl>
|
|
7214
|
+
|
|
7215
|
+
</dd>
|
|
7216
|
+
</dl>
|
|
7217
|
+
</details>
|
|
7218
|
+
|
|
7219
|
+
<details><summary><code>client.resourceServers.<a href="/src/management/api/resources/resourceServers/client/Client.ts">create</a>({ ...params }) -> Management.CreateResourceServerResponseContent</code></summary>
|
|
6909
7220
|
<dl>
|
|
6910
7221
|
<dd>
|
|
6911
7222
|
|
|
@@ -9206,6 +9517,7 @@ await client.tokenExchangeProfiles.create({
|
|
|
9206
9517
|
name: "name",
|
|
9207
9518
|
subject_token_type: "subject_token_type",
|
|
9208
9519
|
action_id: "action_id",
|
|
9520
|
+
type: "custom_authentication",
|
|
9209
9521
|
});
|
|
9210
9522
|
```
|
|
9211
9523
|
|
|
@@ -11157,9 +11469,9 @@ await client.actions.executions.get("id");
|
|
|
11157
11469
|
</dl>
|
|
11158
11470
|
</details>
|
|
11159
11471
|
|
|
11160
|
-
## Actions
|
|
11472
|
+
## Actions Modules
|
|
11161
11473
|
|
|
11162
|
-
<details><summary><code>client.actions.
|
|
11474
|
+
<details><summary><code>client.actions.modules.<a href="/src/management/api/resources/actions/resources/modules/client/Client.ts">list</a>({ ...params }) -> core.Page<Management.ActionModuleListItem, Management.GetActionModulesResponseContent></code></summary>
|
|
11163
11475
|
<dl>
|
|
11164
11476
|
<dd>
|
|
11165
11477
|
|
|
@@ -11171,7 +11483,7 @@ await client.actions.executions.get("id");
|
|
|
11171
11483
|
<dl>
|
|
11172
11484
|
<dd>
|
|
11173
11485
|
|
|
11174
|
-
Retrieve
|
|
11486
|
+
Retrieve a paginated list of all Actions Modules with optional filtering and totals.
|
|
11175
11487
|
|
|
11176
11488
|
</dd>
|
|
11177
11489
|
</dl>
|
|
@@ -11187,7 +11499,25 @@ Retrieve the set of triggers currently available within actions. A trigger is an
|
|
|
11187
11499
|
<dd>
|
|
11188
11500
|
|
|
11189
11501
|
```typescript
|
|
11190
|
-
await client.actions.
|
|
11502
|
+
const pageableResponse = await client.actions.modules.list({
|
|
11503
|
+
page: 1,
|
|
11504
|
+
per_page: 1,
|
|
11505
|
+
});
|
|
11506
|
+
for await (const item of pageableResponse) {
|
|
11507
|
+
console.log(item);
|
|
11508
|
+
}
|
|
11509
|
+
|
|
11510
|
+
// Or you can manually iterate page-by-page
|
|
11511
|
+
let page = await client.actions.modules.list({
|
|
11512
|
+
page: 1,
|
|
11513
|
+
per_page: 1,
|
|
11514
|
+
});
|
|
11515
|
+
while (page.hasNextPage()) {
|
|
11516
|
+
page = page.getNextPage();
|
|
11517
|
+
}
|
|
11518
|
+
|
|
11519
|
+
// You can also access the underlying response
|
|
11520
|
+
const response = page.response;
|
|
11191
11521
|
```
|
|
11192
11522
|
|
|
11193
11523
|
</dd>
|
|
@@ -11203,7 +11533,15 @@ await client.actions.triggers.list();
|
|
|
11203
11533
|
<dl>
|
|
11204
11534
|
<dd>
|
|
11205
11535
|
|
|
11206
|
-
**
|
|
11536
|
+
**request:** `Management.GetActionModulesRequestParameters`
|
|
11537
|
+
|
|
11538
|
+
</dd>
|
|
11539
|
+
</dl>
|
|
11540
|
+
|
|
11541
|
+
<dl>
|
|
11542
|
+
<dd>
|
|
11543
|
+
|
|
11544
|
+
**requestOptions:** `ModulesClient.RequestOptions`
|
|
11207
11545
|
|
|
11208
11546
|
</dd>
|
|
11209
11547
|
</dl>
|
|
@@ -11214,9 +11552,7 @@ await client.actions.triggers.list();
|
|
|
11214
11552
|
</dl>
|
|
11215
11553
|
</details>
|
|
11216
11554
|
|
|
11217
|
-
|
|
11218
|
-
|
|
11219
|
-
<details><summary><code>client.actions.triggers.bindings.<a href="/src/management/api/resources/actions/resources/triggers/resources/bindings/client/Client.ts">list</a>(triggerId, { ...params }) -> core.Page<Management.ActionBinding, Management.ListActionBindingsPaginatedResponseContent></code></summary>
|
|
11555
|
+
<details><summary><code>client.actions.modules.<a href="/src/management/api/resources/actions/resources/modules/client/Client.ts">create</a>({ ...params }) -> Management.CreateActionModuleResponseContent</code></summary>
|
|
11220
11556
|
<dl>
|
|
11221
11557
|
<dd>
|
|
11222
11558
|
|
|
@@ -11228,7 +11564,7 @@ await client.actions.triggers.list();
|
|
|
11228
11564
|
<dl>
|
|
11229
11565
|
<dd>
|
|
11230
11566
|
|
|
11231
|
-
|
|
11567
|
+
Create a new Actions Module for reusable code across actions.
|
|
11232
11568
|
|
|
11233
11569
|
</dd>
|
|
11234
11570
|
</dl>
|
|
@@ -11244,25 +11580,10 @@ Retrieve the actions that are bound to a trigger. Once an action is created and
|
|
|
11244
11580
|
<dd>
|
|
11245
11581
|
|
|
11246
11582
|
```typescript
|
|
11247
|
-
|
|
11248
|
-
|
|
11249
|
-
|
|
11250
|
-
});
|
|
11251
|
-
for await (const item of pageableResponse) {
|
|
11252
|
-
console.log(item);
|
|
11253
|
-
}
|
|
11254
|
-
|
|
11255
|
-
// Or you can manually iterate page-by-page
|
|
11256
|
-
let page = await client.actions.triggers.bindings.list("triggerId", {
|
|
11257
|
-
page: 1,
|
|
11258
|
-
per_page: 1,
|
|
11583
|
+
await client.actions.modules.create({
|
|
11584
|
+
name: "name",
|
|
11585
|
+
code: "code",
|
|
11259
11586
|
});
|
|
11260
|
-
while (page.hasNextPage()) {
|
|
11261
|
-
page = page.getNextPage();
|
|
11262
|
-
}
|
|
11263
|
-
|
|
11264
|
-
// You can also access the underlying response
|
|
11265
|
-
const response = page.response;
|
|
11266
11587
|
```
|
|
11267
11588
|
|
|
11268
11589
|
</dd>
|
|
@@ -11278,15 +11599,7 @@ const response = page.response;
|
|
|
11278
11599
|
<dl>
|
|
11279
11600
|
<dd>
|
|
11280
11601
|
|
|
11281
|
-
**
|
|
11282
|
-
|
|
11283
|
-
</dd>
|
|
11284
|
-
</dl>
|
|
11285
|
-
|
|
11286
|
-
<dl>
|
|
11287
|
-
<dd>
|
|
11288
|
-
|
|
11289
|
-
**request:** `Management.ListActionTriggerBindingsRequestParameters`
|
|
11602
|
+
**request:** `Management.CreateActionModuleRequestContent`
|
|
11290
11603
|
|
|
11291
11604
|
</dd>
|
|
11292
11605
|
</dl>
|
|
@@ -11294,7 +11607,7 @@ const response = page.response;
|
|
|
11294
11607
|
<dl>
|
|
11295
11608
|
<dd>
|
|
11296
11609
|
|
|
11297
|
-
**requestOptions:** `
|
|
11610
|
+
**requestOptions:** `ModulesClient.RequestOptions`
|
|
11298
11611
|
|
|
11299
11612
|
</dd>
|
|
11300
11613
|
</dl>
|
|
@@ -11305,7 +11618,7 @@ const response = page.response;
|
|
|
11305
11618
|
</dl>
|
|
11306
11619
|
</details>
|
|
11307
11620
|
|
|
11308
|
-
<details><summary><code>client.actions.
|
|
11621
|
+
<details><summary><code>client.actions.modules.<a href="/src/management/api/resources/actions/resources/modules/client/Client.ts">get</a>(id) -> Management.GetActionModuleResponseContent</code></summary>
|
|
11309
11622
|
<dl>
|
|
11310
11623
|
<dd>
|
|
11311
11624
|
|
|
@@ -11317,7 +11630,7 @@ const response = page.response;
|
|
|
11317
11630
|
<dl>
|
|
11318
11631
|
<dd>
|
|
11319
11632
|
|
|
11320
|
-
|
|
11633
|
+
Retrieve details of a specific Actions Module by its unique identifier.
|
|
11321
11634
|
|
|
11322
11635
|
</dd>
|
|
11323
11636
|
</dl>
|
|
@@ -11333,7 +11646,7 @@ Update the actions that are bound (i.e. attached) to a trigger. Once an action i
|
|
|
11333
11646
|
<dd>
|
|
11334
11647
|
|
|
11335
11648
|
```typescript
|
|
11336
|
-
await client.actions.
|
|
11649
|
+
await client.actions.modules.get("id");
|
|
11337
11650
|
```
|
|
11338
11651
|
|
|
11339
11652
|
</dd>
|
|
@@ -11349,15 +11662,7 @@ await client.actions.triggers.bindings.updateMany("triggerId");
|
|
|
11349
11662
|
<dl>
|
|
11350
11663
|
<dd>
|
|
11351
11664
|
|
|
11352
|
-
**
|
|
11353
|
-
|
|
11354
|
-
</dd>
|
|
11355
|
-
</dl>
|
|
11356
|
-
|
|
11357
|
-
<dl>
|
|
11358
|
-
<dd>
|
|
11359
|
-
|
|
11360
|
-
**request:** `Management.UpdateActionBindingsRequestContent`
|
|
11665
|
+
**id:** `string` — The ID of the action module to retrieve.
|
|
11361
11666
|
|
|
11362
11667
|
</dd>
|
|
11363
11668
|
</dl>
|
|
@@ -11365,7 +11670,7 @@ await client.actions.triggers.bindings.updateMany("triggerId");
|
|
|
11365
11670
|
<dl>
|
|
11366
11671
|
<dd>
|
|
11367
11672
|
|
|
11368
|
-
**requestOptions:** `
|
|
11673
|
+
**requestOptions:** `ModulesClient.RequestOptions`
|
|
11369
11674
|
|
|
11370
11675
|
</dd>
|
|
11371
11676
|
</dl>
|
|
@@ -11376,9 +11681,7 @@ await client.actions.triggers.bindings.updateMany("triggerId");
|
|
|
11376
11681
|
</dl>
|
|
11377
11682
|
</details>
|
|
11378
11683
|
|
|
11379
|
-
|
|
11380
|
-
|
|
11381
|
-
<details><summary><code>client.anomaly.blocks.<a href="/src/management/api/resources/anomaly/resources/blocks/client/Client.ts">checkIp</a>(id) -> void</code></summary>
|
|
11684
|
+
<details><summary><code>client.actions.modules.<a href="/src/management/api/resources/actions/resources/modules/client/Client.ts">delete</a>(id) -> void</code></summary>
|
|
11382
11685
|
<dl>
|
|
11383
11686
|
<dd>
|
|
11384
11687
|
|
|
@@ -11390,7 +11693,7 @@ await client.actions.triggers.bindings.updateMany("triggerId");
|
|
|
11390
11693
|
<dl>
|
|
11391
11694
|
<dd>
|
|
11392
11695
|
|
|
11393
|
-
|
|
11696
|
+
Permanently delete an Actions Module. This will fail if the module is still in use by any actions.
|
|
11394
11697
|
|
|
11395
11698
|
</dd>
|
|
11396
11699
|
</dl>
|
|
@@ -11406,7 +11709,7 @@ Check if the given IP address is blocked via the <a href="https://auth0.com/docs
|
|
|
11406
11709
|
<dd>
|
|
11407
11710
|
|
|
11408
11711
|
```typescript
|
|
11409
|
-
await client.
|
|
11712
|
+
await client.actions.modules.delete("id");
|
|
11410
11713
|
```
|
|
11411
11714
|
|
|
11412
11715
|
</dd>
|
|
@@ -11422,7 +11725,7 @@ await client.anomaly.blocks.checkIp("id");
|
|
|
11422
11725
|
<dl>
|
|
11423
11726
|
<dd>
|
|
11424
11727
|
|
|
11425
|
-
**id:** `
|
|
11728
|
+
**id:** `string` — The ID of the Actions Module to delete.
|
|
11426
11729
|
|
|
11427
11730
|
</dd>
|
|
11428
11731
|
</dl>
|
|
@@ -11430,7 +11733,7 @@ await client.anomaly.blocks.checkIp("id");
|
|
|
11430
11733
|
<dl>
|
|
11431
11734
|
<dd>
|
|
11432
11735
|
|
|
11433
|
-
**requestOptions:** `
|
|
11736
|
+
**requestOptions:** `ModulesClient.RequestOptions`
|
|
11434
11737
|
|
|
11435
11738
|
</dd>
|
|
11436
11739
|
</dl>
|
|
@@ -11441,7 +11744,7 @@ await client.anomaly.blocks.checkIp("id");
|
|
|
11441
11744
|
</dl>
|
|
11442
11745
|
</details>
|
|
11443
11746
|
|
|
11444
|
-
<details><summary><code>client.
|
|
11747
|
+
<details><summary><code>client.actions.modules.<a href="/src/management/api/resources/actions/resources/modules/client/Client.ts">update</a>(id, { ...params }) -> Management.UpdateActionModuleResponseContent</code></summary>
|
|
11445
11748
|
<dl>
|
|
11446
11749
|
<dd>
|
|
11447
11750
|
|
|
@@ -11453,7 +11756,7 @@ await client.anomaly.blocks.checkIp("id");
|
|
|
11453
11756
|
<dl>
|
|
11454
11757
|
<dd>
|
|
11455
11758
|
|
|
11456
|
-
|
|
11759
|
+
Update properties of an existing Actions Module, such as code, dependencies, or secrets.
|
|
11457
11760
|
|
|
11458
11761
|
</dd>
|
|
11459
11762
|
</dl>
|
|
@@ -11469,7 +11772,7 @@ Remove a block imposed by <a href="https://auth0.com/docs/configure/attack-prote
|
|
|
11469
11772
|
<dd>
|
|
11470
11773
|
|
|
11471
11774
|
```typescript
|
|
11472
|
-
await client.
|
|
11775
|
+
await client.actions.modules.update("id");
|
|
11473
11776
|
```
|
|
11474
11777
|
|
|
11475
11778
|
</dd>
|
|
@@ -11485,7 +11788,7 @@ await client.anomaly.blocks.unblockIp("id");
|
|
|
11485
11788
|
<dl>
|
|
11486
11789
|
<dd>
|
|
11487
11790
|
|
|
11488
|
-
**id:** `
|
|
11791
|
+
**id:** `string` — The ID of the action module to update.
|
|
11489
11792
|
|
|
11490
11793
|
</dd>
|
|
11491
11794
|
</dl>
|
|
@@ -11493,7 +11796,15 @@ await client.anomaly.blocks.unblockIp("id");
|
|
|
11493
11796
|
<dl>
|
|
11494
11797
|
<dd>
|
|
11495
11798
|
|
|
11496
|
-
**
|
|
11799
|
+
**request:** `Management.UpdateActionModuleRequestContent`
|
|
11800
|
+
|
|
11801
|
+
</dd>
|
|
11802
|
+
</dl>
|
|
11803
|
+
|
|
11804
|
+
<dl>
|
|
11805
|
+
<dd>
|
|
11806
|
+
|
|
11807
|
+
**requestOptions:** `ModulesClient.RequestOptions`
|
|
11497
11808
|
|
|
11498
11809
|
</dd>
|
|
11499
11810
|
</dl>
|
|
@@ -11504,9 +11815,7 @@ await client.anomaly.blocks.unblockIp("id");
|
|
|
11504
11815
|
</dl>
|
|
11505
11816
|
</details>
|
|
11506
11817
|
|
|
11507
|
-
|
|
11508
|
-
|
|
11509
|
-
<details><summary><code>client.attackProtection.botDetection.<a href="/src/management/api/resources/attackProtection/resources/botDetection/client/Client.ts">get</a>() -> Management.GetBotDetectionSettingsResponseContent</code></summary>
|
|
11818
|
+
<details><summary><code>client.actions.modules.<a href="/src/management/api/resources/actions/resources/modules/client/Client.ts">listActions</a>(id, { ...params }) -> core.Page<Management.ActionModuleAction, Management.GetActionModuleActionsResponseContent></code></summary>
|
|
11510
11819
|
<dl>
|
|
11511
11820
|
<dd>
|
|
11512
11821
|
|
|
@@ -11518,7 +11827,7 @@ await client.anomaly.blocks.unblockIp("id");
|
|
|
11518
11827
|
<dl>
|
|
11519
11828
|
<dd>
|
|
11520
11829
|
|
|
11521
|
-
|
|
11830
|
+
Lists all actions that are using a specific Actions Module, showing which deployed action versions reference this Actions Module.
|
|
11522
11831
|
|
|
11523
11832
|
</dd>
|
|
11524
11833
|
</dl>
|
|
@@ -11534,7 +11843,25 @@ Get the Bot Detection configuration of your tenant.
|
|
|
11534
11843
|
<dd>
|
|
11535
11844
|
|
|
11536
11845
|
```typescript
|
|
11537
|
-
await client.
|
|
11846
|
+
const pageableResponse = await client.actions.modules.listActions("id", {
|
|
11847
|
+
page: 1,
|
|
11848
|
+
per_page: 1,
|
|
11849
|
+
});
|
|
11850
|
+
for await (const item of pageableResponse) {
|
|
11851
|
+
console.log(item);
|
|
11852
|
+
}
|
|
11853
|
+
|
|
11854
|
+
// Or you can manually iterate page-by-page
|
|
11855
|
+
let page = await client.actions.modules.listActions("id", {
|
|
11856
|
+
page: 1,
|
|
11857
|
+
per_page: 1,
|
|
11858
|
+
});
|
|
11859
|
+
while (page.hasNextPage()) {
|
|
11860
|
+
page = page.getNextPage();
|
|
11861
|
+
}
|
|
11862
|
+
|
|
11863
|
+
// You can also access the underlying response
|
|
11864
|
+
const response = page.response;
|
|
11538
11865
|
```
|
|
11539
11866
|
|
|
11540
11867
|
</dd>
|
|
@@ -11550,7 +11877,23 @@ await client.attackProtection.botDetection.get();
|
|
|
11550
11877
|
<dl>
|
|
11551
11878
|
<dd>
|
|
11552
11879
|
|
|
11553
|
-
**
|
|
11880
|
+
**id:** `string` — The unique ID of the module.
|
|
11881
|
+
|
|
11882
|
+
</dd>
|
|
11883
|
+
</dl>
|
|
11884
|
+
|
|
11885
|
+
<dl>
|
|
11886
|
+
<dd>
|
|
11887
|
+
|
|
11888
|
+
**request:** `Management.GetActionModuleActionsRequestParameters`
|
|
11889
|
+
|
|
11890
|
+
</dd>
|
|
11891
|
+
</dl>
|
|
11892
|
+
|
|
11893
|
+
<dl>
|
|
11894
|
+
<dd>
|
|
11895
|
+
|
|
11896
|
+
**requestOptions:** `ModulesClient.RequestOptions`
|
|
11554
11897
|
|
|
11555
11898
|
</dd>
|
|
11556
11899
|
</dl>
|
|
@@ -11561,7 +11904,7 @@ await client.attackProtection.botDetection.get();
|
|
|
11561
11904
|
</dl>
|
|
11562
11905
|
</details>
|
|
11563
11906
|
|
|
11564
|
-
<details><summary><code>client.
|
|
11907
|
+
<details><summary><code>client.actions.modules.<a href="/src/management/api/resources/actions/resources/modules/client/Client.ts">rollback</a>(id, { ...params }) -> Management.RollbackActionModuleResponseContent</code></summary>
|
|
11565
11908
|
<dl>
|
|
11566
11909
|
<dd>
|
|
11567
11910
|
|
|
@@ -11573,7 +11916,7 @@ await client.attackProtection.botDetection.get();
|
|
|
11573
11916
|
<dl>
|
|
11574
11917
|
<dd>
|
|
11575
11918
|
|
|
11576
|
-
|
|
11919
|
+
Rolls back an Actions Module's draft to a previously created version. This action copies the code, dependencies, and secrets from the specified version into the current draft.
|
|
11577
11920
|
|
|
11578
11921
|
</dd>
|
|
11579
11922
|
</dl>
|
|
@@ -11589,7 +11932,9 @@ Update the Bot Detection configuration of your tenant.
|
|
|
11589
11932
|
<dd>
|
|
11590
11933
|
|
|
11591
11934
|
```typescript
|
|
11592
|
-
await client.
|
|
11935
|
+
await client.actions.modules.rollback("id", {
|
|
11936
|
+
module_version_id: "module_version_id",
|
|
11937
|
+
});
|
|
11593
11938
|
```
|
|
11594
11939
|
|
|
11595
11940
|
</dd>
|
|
@@ -11605,7 +11950,7 @@ await client.attackProtection.botDetection.update();
|
|
|
11605
11950
|
<dl>
|
|
11606
11951
|
<dd>
|
|
11607
11952
|
|
|
11608
|
-
**
|
|
11953
|
+
**id:** `string` — The unique ID of the module to roll back.
|
|
11609
11954
|
|
|
11610
11955
|
</dd>
|
|
11611
11956
|
</dl>
|
|
@@ -11613,7 +11958,15 @@ await client.attackProtection.botDetection.update();
|
|
|
11613
11958
|
<dl>
|
|
11614
11959
|
<dd>
|
|
11615
11960
|
|
|
11616
|
-
**
|
|
11961
|
+
**request:** `Management.RollbackActionModuleRequestParameters`
|
|
11962
|
+
|
|
11963
|
+
</dd>
|
|
11964
|
+
</dl>
|
|
11965
|
+
|
|
11966
|
+
<dl>
|
|
11967
|
+
<dd>
|
|
11968
|
+
|
|
11969
|
+
**requestOptions:** `ModulesClient.RequestOptions`
|
|
11617
11970
|
|
|
11618
11971
|
</dd>
|
|
11619
11972
|
</dl>
|
|
@@ -11624,9 +11977,9 @@ await client.attackProtection.botDetection.update();
|
|
|
11624
11977
|
</dl>
|
|
11625
11978
|
</details>
|
|
11626
11979
|
|
|
11627
|
-
##
|
|
11980
|
+
## Actions Triggers
|
|
11628
11981
|
|
|
11629
|
-
<details><summary><code>client.
|
|
11982
|
+
<details><summary><code>client.actions.triggers.<a href="/src/management/api/resources/actions/resources/triggers/client/Client.ts">list</a>() -> Management.ListActionTriggersResponseContent</code></summary>
|
|
11630
11983
|
<dl>
|
|
11631
11984
|
<dd>
|
|
11632
11985
|
|
|
@@ -11638,7 +11991,7 @@ await client.attackProtection.botDetection.update();
|
|
|
11638
11991
|
<dl>
|
|
11639
11992
|
<dd>
|
|
11640
11993
|
|
|
11641
|
-
Retrieve
|
|
11994
|
+
Retrieve the set of triggers currently available within actions. A trigger is an extensibility point to which actions can be bound.
|
|
11642
11995
|
|
|
11643
11996
|
</dd>
|
|
11644
11997
|
</dl>
|
|
@@ -11654,7 +12007,7 @@ Retrieve details of the Breached Password Detection configuration of your tenant
|
|
|
11654
12007
|
<dd>
|
|
11655
12008
|
|
|
11656
12009
|
```typescript
|
|
11657
|
-
await client.
|
|
12010
|
+
await client.actions.triggers.list();
|
|
11658
12011
|
```
|
|
11659
12012
|
|
|
11660
12013
|
</dd>
|
|
@@ -11670,7 +12023,7 @@ await client.attackProtection.breachedPasswordDetection.get();
|
|
|
11670
12023
|
<dl>
|
|
11671
12024
|
<dd>
|
|
11672
12025
|
|
|
11673
|
-
**requestOptions:** `
|
|
12026
|
+
**requestOptions:** `TriggersClient.RequestOptions`
|
|
11674
12027
|
|
|
11675
12028
|
</dd>
|
|
11676
12029
|
</dl>
|
|
@@ -11681,7 +12034,9 @@ await client.attackProtection.breachedPasswordDetection.get();
|
|
|
11681
12034
|
</dl>
|
|
11682
12035
|
</details>
|
|
11683
12036
|
|
|
11684
|
-
|
|
12037
|
+
## Actions Modules Versions
|
|
12038
|
+
|
|
12039
|
+
<details><summary><code>client.actions.modules.versions.<a href="/src/management/api/resources/actions/resources/modules/resources/versions/client/Client.ts">list</a>(id) -> Management.GetActionModuleVersionsResponseContent</code></summary>
|
|
11685
12040
|
<dl>
|
|
11686
12041
|
<dd>
|
|
11687
12042
|
|
|
@@ -11693,7 +12048,7 @@ await client.attackProtection.breachedPasswordDetection.get();
|
|
|
11693
12048
|
<dl>
|
|
11694
12049
|
<dd>
|
|
11695
12050
|
|
|
11696
|
-
|
|
12051
|
+
List all published versions of a specific Actions Module.
|
|
11697
12052
|
|
|
11698
12053
|
</dd>
|
|
11699
12054
|
</dl>
|
|
@@ -11709,7 +12064,7 @@ Update details of the Breached Password Detection configuration of your tenant.
|
|
|
11709
12064
|
<dd>
|
|
11710
12065
|
|
|
11711
12066
|
```typescript
|
|
11712
|
-
await client.
|
|
12067
|
+
await client.actions.modules.versions.list("id");
|
|
11713
12068
|
```
|
|
11714
12069
|
|
|
11715
12070
|
</dd>
|
|
@@ -11725,7 +12080,7 @@ await client.attackProtection.breachedPasswordDetection.update();
|
|
|
11725
12080
|
<dl>
|
|
11726
12081
|
<dd>
|
|
11727
12082
|
|
|
11728
|
-
**
|
|
12083
|
+
**id:** `string` — The unique ID of the module.
|
|
11729
12084
|
|
|
11730
12085
|
</dd>
|
|
11731
12086
|
</dl>
|
|
@@ -11733,7 +12088,7 @@ await client.attackProtection.breachedPasswordDetection.update();
|
|
|
11733
12088
|
<dl>
|
|
11734
12089
|
<dd>
|
|
11735
12090
|
|
|
11736
|
-
**requestOptions:** `
|
|
12091
|
+
**requestOptions:** `VersionsClient.RequestOptions`
|
|
11737
12092
|
|
|
11738
12093
|
</dd>
|
|
11739
12094
|
</dl>
|
|
@@ -11744,9 +12099,7 @@ await client.attackProtection.breachedPasswordDetection.update();
|
|
|
11744
12099
|
</dl>
|
|
11745
12100
|
</details>
|
|
11746
12101
|
|
|
11747
|
-
|
|
11748
|
-
|
|
11749
|
-
<details><summary><code>client.attackProtection.bruteForceProtection.<a href="/src/management/api/resources/attackProtection/resources/bruteForceProtection/client/Client.ts">get</a>() -> Management.GetBruteForceSettingsResponseContent</code></summary>
|
|
12102
|
+
<details><summary><code>client.actions.modules.versions.<a href="/src/management/api/resources/actions/resources/modules/resources/versions/client/Client.ts">create</a>(id) -> Management.CreateActionModuleVersionResponseContent</code></summary>
|
|
11750
12103
|
<dl>
|
|
11751
12104
|
<dd>
|
|
11752
12105
|
|
|
@@ -11758,7 +12111,7 @@ await client.attackProtection.breachedPasswordDetection.update();
|
|
|
11758
12111
|
<dl>
|
|
11759
12112
|
<dd>
|
|
11760
12113
|
|
|
11761
|
-
|
|
12114
|
+
Creates a new immutable version of an Actions Module from the current draft version. This publishes the draft as a new version that can be referenced by actions, while maintaining the existing draft for continued development.
|
|
11762
12115
|
|
|
11763
12116
|
</dd>
|
|
11764
12117
|
</dl>
|
|
@@ -11774,7 +12127,7 @@ Retrieve details of the Brute-force Protection configuration of your tenant.
|
|
|
11774
12127
|
<dd>
|
|
11775
12128
|
|
|
11776
12129
|
```typescript
|
|
11777
|
-
await client.
|
|
12130
|
+
await client.actions.modules.versions.create("id");
|
|
11778
12131
|
```
|
|
11779
12132
|
|
|
11780
12133
|
</dd>
|
|
@@ -11790,11 +12143,677 @@ await client.attackProtection.bruteForceProtection.get();
|
|
|
11790
12143
|
<dl>
|
|
11791
12144
|
<dd>
|
|
11792
12145
|
|
|
11793
|
-
**
|
|
12146
|
+
**id:** `string` — The ID of the action module to create a version for.
|
|
11794
12147
|
|
|
11795
12148
|
</dd>
|
|
11796
12149
|
</dl>
|
|
11797
|
-
|
|
12150
|
+
|
|
12151
|
+
<dl>
|
|
12152
|
+
<dd>
|
|
12153
|
+
|
|
12154
|
+
**requestOptions:** `VersionsClient.RequestOptions`
|
|
12155
|
+
|
|
12156
|
+
</dd>
|
|
12157
|
+
</dl>
|
|
12158
|
+
</dd>
|
|
12159
|
+
</dl>
|
|
12160
|
+
|
|
12161
|
+
</dd>
|
|
12162
|
+
</dl>
|
|
12163
|
+
</details>
|
|
12164
|
+
|
|
12165
|
+
<details><summary><code>client.actions.modules.versions.<a href="/src/management/api/resources/actions/resources/modules/resources/versions/client/Client.ts">get</a>(id, versionId) -> Management.GetActionModuleVersionResponseContent</code></summary>
|
|
12166
|
+
<dl>
|
|
12167
|
+
<dd>
|
|
12168
|
+
|
|
12169
|
+
#### 📝 Description
|
|
12170
|
+
|
|
12171
|
+
<dl>
|
|
12172
|
+
<dd>
|
|
12173
|
+
|
|
12174
|
+
<dl>
|
|
12175
|
+
<dd>
|
|
12176
|
+
|
|
12177
|
+
Retrieve the details of a specific, immutable version of an Actions Module.
|
|
12178
|
+
|
|
12179
|
+
</dd>
|
|
12180
|
+
</dl>
|
|
12181
|
+
</dd>
|
|
12182
|
+
</dl>
|
|
12183
|
+
|
|
12184
|
+
#### 🔌 Usage
|
|
12185
|
+
|
|
12186
|
+
<dl>
|
|
12187
|
+
<dd>
|
|
12188
|
+
|
|
12189
|
+
<dl>
|
|
12190
|
+
<dd>
|
|
12191
|
+
|
|
12192
|
+
```typescript
|
|
12193
|
+
await client.actions.modules.versions.get("id", "versionId");
|
|
12194
|
+
```
|
|
12195
|
+
|
|
12196
|
+
</dd>
|
|
12197
|
+
</dl>
|
|
12198
|
+
</dd>
|
|
12199
|
+
</dl>
|
|
12200
|
+
|
|
12201
|
+
#### ⚙️ Parameters
|
|
12202
|
+
|
|
12203
|
+
<dl>
|
|
12204
|
+
<dd>
|
|
12205
|
+
|
|
12206
|
+
<dl>
|
|
12207
|
+
<dd>
|
|
12208
|
+
|
|
12209
|
+
**id:** `string` — The unique ID of the module.
|
|
12210
|
+
|
|
12211
|
+
</dd>
|
|
12212
|
+
</dl>
|
|
12213
|
+
|
|
12214
|
+
<dl>
|
|
12215
|
+
<dd>
|
|
12216
|
+
|
|
12217
|
+
**versionId:** `string` — The unique ID of the module version to retrieve.
|
|
12218
|
+
|
|
12219
|
+
</dd>
|
|
12220
|
+
</dl>
|
|
12221
|
+
|
|
12222
|
+
<dl>
|
|
12223
|
+
<dd>
|
|
12224
|
+
|
|
12225
|
+
**requestOptions:** `VersionsClient.RequestOptions`
|
|
12226
|
+
|
|
12227
|
+
</dd>
|
|
12228
|
+
</dl>
|
|
12229
|
+
</dd>
|
|
12230
|
+
</dl>
|
|
12231
|
+
|
|
12232
|
+
</dd>
|
|
12233
|
+
</dl>
|
|
12234
|
+
</details>
|
|
12235
|
+
|
|
12236
|
+
## Actions Triggers Bindings
|
|
12237
|
+
|
|
12238
|
+
<details><summary><code>client.actions.triggers.bindings.<a href="/src/management/api/resources/actions/resources/triggers/resources/bindings/client/Client.ts">list</a>(triggerId, { ...params }) -> core.Page<Management.ActionBinding, Management.ListActionBindingsPaginatedResponseContent></code></summary>
|
|
12239
|
+
<dl>
|
|
12240
|
+
<dd>
|
|
12241
|
+
|
|
12242
|
+
#### 📝 Description
|
|
12243
|
+
|
|
12244
|
+
<dl>
|
|
12245
|
+
<dd>
|
|
12246
|
+
|
|
12247
|
+
<dl>
|
|
12248
|
+
<dd>
|
|
12249
|
+
|
|
12250
|
+
Retrieve the actions that are bound to a trigger. Once an action is created and deployed, it must be attached (i.e. bound) to a trigger so that it will be executed as part of a flow. The list of actions returned reflects the order in which they will be executed during the appropriate flow.
|
|
12251
|
+
|
|
12252
|
+
</dd>
|
|
12253
|
+
</dl>
|
|
12254
|
+
</dd>
|
|
12255
|
+
</dl>
|
|
12256
|
+
|
|
12257
|
+
#### 🔌 Usage
|
|
12258
|
+
|
|
12259
|
+
<dl>
|
|
12260
|
+
<dd>
|
|
12261
|
+
|
|
12262
|
+
<dl>
|
|
12263
|
+
<dd>
|
|
12264
|
+
|
|
12265
|
+
```typescript
|
|
12266
|
+
const pageableResponse = await client.actions.triggers.bindings.list("triggerId", {
|
|
12267
|
+
page: 1,
|
|
12268
|
+
per_page: 1,
|
|
12269
|
+
});
|
|
12270
|
+
for await (const item of pageableResponse) {
|
|
12271
|
+
console.log(item);
|
|
12272
|
+
}
|
|
12273
|
+
|
|
12274
|
+
// Or you can manually iterate page-by-page
|
|
12275
|
+
let page = await client.actions.triggers.bindings.list("triggerId", {
|
|
12276
|
+
page: 1,
|
|
12277
|
+
per_page: 1,
|
|
12278
|
+
});
|
|
12279
|
+
while (page.hasNextPage()) {
|
|
12280
|
+
page = page.getNextPage();
|
|
12281
|
+
}
|
|
12282
|
+
|
|
12283
|
+
// You can also access the underlying response
|
|
12284
|
+
const response = page.response;
|
|
12285
|
+
```
|
|
12286
|
+
|
|
12287
|
+
</dd>
|
|
12288
|
+
</dl>
|
|
12289
|
+
</dd>
|
|
12290
|
+
</dl>
|
|
12291
|
+
|
|
12292
|
+
#### ⚙️ Parameters
|
|
12293
|
+
|
|
12294
|
+
<dl>
|
|
12295
|
+
<dd>
|
|
12296
|
+
|
|
12297
|
+
<dl>
|
|
12298
|
+
<dd>
|
|
12299
|
+
|
|
12300
|
+
**triggerId:** `Management.ActionTriggerTypeEnum` — An actions extensibility point.
|
|
12301
|
+
|
|
12302
|
+
</dd>
|
|
12303
|
+
</dl>
|
|
12304
|
+
|
|
12305
|
+
<dl>
|
|
12306
|
+
<dd>
|
|
12307
|
+
|
|
12308
|
+
**request:** `Management.ListActionTriggerBindingsRequestParameters`
|
|
12309
|
+
|
|
12310
|
+
</dd>
|
|
12311
|
+
</dl>
|
|
12312
|
+
|
|
12313
|
+
<dl>
|
|
12314
|
+
<dd>
|
|
12315
|
+
|
|
12316
|
+
**requestOptions:** `BindingsClient.RequestOptions`
|
|
12317
|
+
|
|
12318
|
+
</dd>
|
|
12319
|
+
</dl>
|
|
12320
|
+
</dd>
|
|
12321
|
+
</dl>
|
|
12322
|
+
|
|
12323
|
+
</dd>
|
|
12324
|
+
</dl>
|
|
12325
|
+
</details>
|
|
12326
|
+
|
|
12327
|
+
<details><summary><code>client.actions.triggers.bindings.<a href="/src/management/api/resources/actions/resources/triggers/resources/bindings/client/Client.ts">updateMany</a>(triggerId, { ...params }) -> Management.UpdateActionBindingsResponseContent</code></summary>
|
|
12328
|
+
<dl>
|
|
12329
|
+
<dd>
|
|
12330
|
+
|
|
12331
|
+
#### 📝 Description
|
|
12332
|
+
|
|
12333
|
+
<dl>
|
|
12334
|
+
<dd>
|
|
12335
|
+
|
|
12336
|
+
<dl>
|
|
12337
|
+
<dd>
|
|
12338
|
+
|
|
12339
|
+
Update the actions that are bound (i.e. attached) to a trigger. Once an action is created and deployed, it must be attached (i.e. bound) to a trigger so that it will be executed as part of a flow. The order in which the actions are provided will determine the order in which they are executed.
|
|
12340
|
+
|
|
12341
|
+
</dd>
|
|
12342
|
+
</dl>
|
|
12343
|
+
</dd>
|
|
12344
|
+
</dl>
|
|
12345
|
+
|
|
12346
|
+
#### 🔌 Usage
|
|
12347
|
+
|
|
12348
|
+
<dl>
|
|
12349
|
+
<dd>
|
|
12350
|
+
|
|
12351
|
+
<dl>
|
|
12352
|
+
<dd>
|
|
12353
|
+
|
|
12354
|
+
```typescript
|
|
12355
|
+
await client.actions.triggers.bindings.updateMany("triggerId");
|
|
12356
|
+
```
|
|
12357
|
+
|
|
12358
|
+
</dd>
|
|
12359
|
+
</dl>
|
|
12360
|
+
</dd>
|
|
12361
|
+
</dl>
|
|
12362
|
+
|
|
12363
|
+
#### ⚙️ Parameters
|
|
12364
|
+
|
|
12365
|
+
<dl>
|
|
12366
|
+
<dd>
|
|
12367
|
+
|
|
12368
|
+
<dl>
|
|
12369
|
+
<dd>
|
|
12370
|
+
|
|
12371
|
+
**triggerId:** `Management.ActionTriggerTypeEnum` — An actions extensibility point.
|
|
12372
|
+
|
|
12373
|
+
</dd>
|
|
12374
|
+
</dl>
|
|
12375
|
+
|
|
12376
|
+
<dl>
|
|
12377
|
+
<dd>
|
|
12378
|
+
|
|
12379
|
+
**request:** `Management.UpdateActionBindingsRequestContent`
|
|
12380
|
+
|
|
12381
|
+
</dd>
|
|
12382
|
+
</dl>
|
|
12383
|
+
|
|
12384
|
+
<dl>
|
|
12385
|
+
<dd>
|
|
12386
|
+
|
|
12387
|
+
**requestOptions:** `BindingsClient.RequestOptions`
|
|
12388
|
+
|
|
12389
|
+
</dd>
|
|
12390
|
+
</dl>
|
|
12391
|
+
</dd>
|
|
12392
|
+
</dl>
|
|
12393
|
+
|
|
12394
|
+
</dd>
|
|
12395
|
+
</dl>
|
|
12396
|
+
</details>
|
|
12397
|
+
|
|
12398
|
+
## Anomaly Blocks
|
|
12399
|
+
|
|
12400
|
+
<details><summary><code>client.anomaly.blocks.<a href="/src/management/api/resources/anomaly/resources/blocks/client/Client.ts">checkIp</a>(id) -> void</code></summary>
|
|
12401
|
+
<dl>
|
|
12402
|
+
<dd>
|
|
12403
|
+
|
|
12404
|
+
#### 📝 Description
|
|
12405
|
+
|
|
12406
|
+
<dl>
|
|
12407
|
+
<dd>
|
|
12408
|
+
|
|
12409
|
+
<dl>
|
|
12410
|
+
<dd>
|
|
12411
|
+
|
|
12412
|
+
Check if the given IP address is blocked via the <a href="https://auth0.com/docs/configure/attack-protection/suspicious-ip-throttling">Suspicious IP Throttling</a> due to multiple suspicious attempts.
|
|
12413
|
+
|
|
12414
|
+
</dd>
|
|
12415
|
+
</dl>
|
|
12416
|
+
</dd>
|
|
12417
|
+
</dl>
|
|
12418
|
+
|
|
12419
|
+
#### 🔌 Usage
|
|
12420
|
+
|
|
12421
|
+
<dl>
|
|
12422
|
+
<dd>
|
|
12423
|
+
|
|
12424
|
+
<dl>
|
|
12425
|
+
<dd>
|
|
12426
|
+
|
|
12427
|
+
```typescript
|
|
12428
|
+
await client.anomaly.blocks.checkIp("id");
|
|
12429
|
+
```
|
|
12430
|
+
|
|
12431
|
+
</dd>
|
|
12432
|
+
</dl>
|
|
12433
|
+
</dd>
|
|
12434
|
+
</dl>
|
|
12435
|
+
|
|
12436
|
+
#### ⚙️ Parameters
|
|
12437
|
+
|
|
12438
|
+
<dl>
|
|
12439
|
+
<dd>
|
|
12440
|
+
|
|
12441
|
+
<dl>
|
|
12442
|
+
<dd>
|
|
12443
|
+
|
|
12444
|
+
**id:** `Management.AnomalyIpFormat` — IP address to check.
|
|
12445
|
+
|
|
12446
|
+
</dd>
|
|
12447
|
+
</dl>
|
|
12448
|
+
|
|
12449
|
+
<dl>
|
|
12450
|
+
<dd>
|
|
12451
|
+
|
|
12452
|
+
**requestOptions:** `BlocksClient.RequestOptions`
|
|
12453
|
+
|
|
12454
|
+
</dd>
|
|
12455
|
+
</dl>
|
|
12456
|
+
</dd>
|
|
12457
|
+
</dl>
|
|
12458
|
+
|
|
12459
|
+
</dd>
|
|
12460
|
+
</dl>
|
|
12461
|
+
</details>
|
|
12462
|
+
|
|
12463
|
+
<details><summary><code>client.anomaly.blocks.<a href="/src/management/api/resources/anomaly/resources/blocks/client/Client.ts">unblockIp</a>(id) -> void</code></summary>
|
|
12464
|
+
<dl>
|
|
12465
|
+
<dd>
|
|
12466
|
+
|
|
12467
|
+
#### 📝 Description
|
|
12468
|
+
|
|
12469
|
+
<dl>
|
|
12470
|
+
<dd>
|
|
12471
|
+
|
|
12472
|
+
<dl>
|
|
12473
|
+
<dd>
|
|
12474
|
+
|
|
12475
|
+
Remove a block imposed by <a href="https://auth0.com/docs/configure/attack-protection/suspicious-ip-throttling">Suspicious IP Throttling</a> for the given IP address.
|
|
12476
|
+
|
|
12477
|
+
</dd>
|
|
12478
|
+
</dl>
|
|
12479
|
+
</dd>
|
|
12480
|
+
</dl>
|
|
12481
|
+
|
|
12482
|
+
#### 🔌 Usage
|
|
12483
|
+
|
|
12484
|
+
<dl>
|
|
12485
|
+
<dd>
|
|
12486
|
+
|
|
12487
|
+
<dl>
|
|
12488
|
+
<dd>
|
|
12489
|
+
|
|
12490
|
+
```typescript
|
|
12491
|
+
await client.anomaly.blocks.unblockIp("id");
|
|
12492
|
+
```
|
|
12493
|
+
|
|
12494
|
+
</dd>
|
|
12495
|
+
</dl>
|
|
12496
|
+
</dd>
|
|
12497
|
+
</dl>
|
|
12498
|
+
|
|
12499
|
+
#### ⚙️ Parameters
|
|
12500
|
+
|
|
12501
|
+
<dl>
|
|
12502
|
+
<dd>
|
|
12503
|
+
|
|
12504
|
+
<dl>
|
|
12505
|
+
<dd>
|
|
12506
|
+
|
|
12507
|
+
**id:** `Management.AnomalyIpFormat` — IP address to unblock.
|
|
12508
|
+
|
|
12509
|
+
</dd>
|
|
12510
|
+
</dl>
|
|
12511
|
+
|
|
12512
|
+
<dl>
|
|
12513
|
+
<dd>
|
|
12514
|
+
|
|
12515
|
+
**requestOptions:** `BlocksClient.RequestOptions`
|
|
12516
|
+
|
|
12517
|
+
</dd>
|
|
12518
|
+
</dl>
|
|
12519
|
+
</dd>
|
|
12520
|
+
</dl>
|
|
12521
|
+
|
|
12522
|
+
</dd>
|
|
12523
|
+
</dl>
|
|
12524
|
+
</details>
|
|
12525
|
+
|
|
12526
|
+
## AttackProtection BotDetection
|
|
12527
|
+
|
|
12528
|
+
<details><summary><code>client.attackProtection.botDetection.<a href="/src/management/api/resources/attackProtection/resources/botDetection/client/Client.ts">get</a>() -> Management.GetBotDetectionSettingsResponseContent</code></summary>
|
|
12529
|
+
<dl>
|
|
12530
|
+
<dd>
|
|
12531
|
+
|
|
12532
|
+
#### 📝 Description
|
|
12533
|
+
|
|
12534
|
+
<dl>
|
|
12535
|
+
<dd>
|
|
12536
|
+
|
|
12537
|
+
<dl>
|
|
12538
|
+
<dd>
|
|
12539
|
+
|
|
12540
|
+
Get the Bot Detection configuration of your tenant.
|
|
12541
|
+
|
|
12542
|
+
</dd>
|
|
12543
|
+
</dl>
|
|
12544
|
+
</dd>
|
|
12545
|
+
</dl>
|
|
12546
|
+
|
|
12547
|
+
#### 🔌 Usage
|
|
12548
|
+
|
|
12549
|
+
<dl>
|
|
12550
|
+
<dd>
|
|
12551
|
+
|
|
12552
|
+
<dl>
|
|
12553
|
+
<dd>
|
|
12554
|
+
|
|
12555
|
+
```typescript
|
|
12556
|
+
await client.attackProtection.botDetection.get();
|
|
12557
|
+
```
|
|
12558
|
+
|
|
12559
|
+
</dd>
|
|
12560
|
+
</dl>
|
|
12561
|
+
</dd>
|
|
12562
|
+
</dl>
|
|
12563
|
+
|
|
12564
|
+
#### ⚙️ Parameters
|
|
12565
|
+
|
|
12566
|
+
<dl>
|
|
12567
|
+
<dd>
|
|
12568
|
+
|
|
12569
|
+
<dl>
|
|
12570
|
+
<dd>
|
|
12571
|
+
|
|
12572
|
+
**requestOptions:** `BotDetectionClient.RequestOptions`
|
|
12573
|
+
|
|
12574
|
+
</dd>
|
|
12575
|
+
</dl>
|
|
12576
|
+
</dd>
|
|
12577
|
+
</dl>
|
|
12578
|
+
|
|
12579
|
+
</dd>
|
|
12580
|
+
</dl>
|
|
12581
|
+
</details>
|
|
12582
|
+
|
|
12583
|
+
<details><summary><code>client.attackProtection.botDetection.<a href="/src/management/api/resources/attackProtection/resources/botDetection/client/Client.ts">update</a>({ ...params }) -> Management.UpdateBotDetectionSettingsResponseContent</code></summary>
|
|
12584
|
+
<dl>
|
|
12585
|
+
<dd>
|
|
12586
|
+
|
|
12587
|
+
#### 📝 Description
|
|
12588
|
+
|
|
12589
|
+
<dl>
|
|
12590
|
+
<dd>
|
|
12591
|
+
|
|
12592
|
+
<dl>
|
|
12593
|
+
<dd>
|
|
12594
|
+
|
|
12595
|
+
Update the Bot Detection configuration of your tenant.
|
|
12596
|
+
|
|
12597
|
+
</dd>
|
|
12598
|
+
</dl>
|
|
12599
|
+
</dd>
|
|
12600
|
+
</dl>
|
|
12601
|
+
|
|
12602
|
+
#### 🔌 Usage
|
|
12603
|
+
|
|
12604
|
+
<dl>
|
|
12605
|
+
<dd>
|
|
12606
|
+
|
|
12607
|
+
<dl>
|
|
12608
|
+
<dd>
|
|
12609
|
+
|
|
12610
|
+
```typescript
|
|
12611
|
+
await client.attackProtection.botDetection.update();
|
|
12612
|
+
```
|
|
12613
|
+
|
|
12614
|
+
</dd>
|
|
12615
|
+
</dl>
|
|
12616
|
+
</dd>
|
|
12617
|
+
</dl>
|
|
12618
|
+
|
|
12619
|
+
#### ⚙️ Parameters
|
|
12620
|
+
|
|
12621
|
+
<dl>
|
|
12622
|
+
<dd>
|
|
12623
|
+
|
|
12624
|
+
<dl>
|
|
12625
|
+
<dd>
|
|
12626
|
+
|
|
12627
|
+
**request:** `Management.UpdateBotDetectionSettingsRequestContent`
|
|
12628
|
+
|
|
12629
|
+
</dd>
|
|
12630
|
+
</dl>
|
|
12631
|
+
|
|
12632
|
+
<dl>
|
|
12633
|
+
<dd>
|
|
12634
|
+
|
|
12635
|
+
**requestOptions:** `BotDetectionClient.RequestOptions`
|
|
12636
|
+
|
|
12637
|
+
</dd>
|
|
12638
|
+
</dl>
|
|
12639
|
+
</dd>
|
|
12640
|
+
</dl>
|
|
12641
|
+
|
|
12642
|
+
</dd>
|
|
12643
|
+
</dl>
|
|
12644
|
+
</details>
|
|
12645
|
+
|
|
12646
|
+
## AttackProtection BreachedPasswordDetection
|
|
12647
|
+
|
|
12648
|
+
<details><summary><code>client.attackProtection.breachedPasswordDetection.<a href="/src/management/api/resources/attackProtection/resources/breachedPasswordDetection/client/Client.ts">get</a>() -> Management.GetBreachedPasswordDetectionSettingsResponseContent</code></summary>
|
|
12649
|
+
<dl>
|
|
12650
|
+
<dd>
|
|
12651
|
+
|
|
12652
|
+
#### 📝 Description
|
|
12653
|
+
|
|
12654
|
+
<dl>
|
|
12655
|
+
<dd>
|
|
12656
|
+
|
|
12657
|
+
<dl>
|
|
12658
|
+
<dd>
|
|
12659
|
+
|
|
12660
|
+
Retrieve details of the Breached Password Detection configuration of your tenant.
|
|
12661
|
+
|
|
12662
|
+
</dd>
|
|
12663
|
+
</dl>
|
|
12664
|
+
</dd>
|
|
12665
|
+
</dl>
|
|
12666
|
+
|
|
12667
|
+
#### 🔌 Usage
|
|
12668
|
+
|
|
12669
|
+
<dl>
|
|
12670
|
+
<dd>
|
|
12671
|
+
|
|
12672
|
+
<dl>
|
|
12673
|
+
<dd>
|
|
12674
|
+
|
|
12675
|
+
```typescript
|
|
12676
|
+
await client.attackProtection.breachedPasswordDetection.get();
|
|
12677
|
+
```
|
|
12678
|
+
|
|
12679
|
+
</dd>
|
|
12680
|
+
</dl>
|
|
12681
|
+
</dd>
|
|
12682
|
+
</dl>
|
|
12683
|
+
|
|
12684
|
+
#### ⚙️ Parameters
|
|
12685
|
+
|
|
12686
|
+
<dl>
|
|
12687
|
+
<dd>
|
|
12688
|
+
|
|
12689
|
+
<dl>
|
|
12690
|
+
<dd>
|
|
12691
|
+
|
|
12692
|
+
**requestOptions:** `BreachedPasswordDetectionClient.RequestOptions`
|
|
12693
|
+
|
|
12694
|
+
</dd>
|
|
12695
|
+
</dl>
|
|
12696
|
+
</dd>
|
|
12697
|
+
</dl>
|
|
12698
|
+
|
|
12699
|
+
</dd>
|
|
12700
|
+
</dl>
|
|
12701
|
+
</details>
|
|
12702
|
+
|
|
12703
|
+
<details><summary><code>client.attackProtection.breachedPasswordDetection.<a href="/src/management/api/resources/attackProtection/resources/breachedPasswordDetection/client/Client.ts">update</a>({ ...params }) -> Management.UpdateBreachedPasswordDetectionSettingsResponseContent</code></summary>
|
|
12704
|
+
<dl>
|
|
12705
|
+
<dd>
|
|
12706
|
+
|
|
12707
|
+
#### 📝 Description
|
|
12708
|
+
|
|
12709
|
+
<dl>
|
|
12710
|
+
<dd>
|
|
12711
|
+
|
|
12712
|
+
<dl>
|
|
12713
|
+
<dd>
|
|
12714
|
+
|
|
12715
|
+
Update details of the Breached Password Detection configuration of your tenant.
|
|
12716
|
+
|
|
12717
|
+
</dd>
|
|
12718
|
+
</dl>
|
|
12719
|
+
</dd>
|
|
12720
|
+
</dl>
|
|
12721
|
+
|
|
12722
|
+
#### 🔌 Usage
|
|
12723
|
+
|
|
12724
|
+
<dl>
|
|
12725
|
+
<dd>
|
|
12726
|
+
|
|
12727
|
+
<dl>
|
|
12728
|
+
<dd>
|
|
12729
|
+
|
|
12730
|
+
```typescript
|
|
12731
|
+
await client.attackProtection.breachedPasswordDetection.update();
|
|
12732
|
+
```
|
|
12733
|
+
|
|
12734
|
+
</dd>
|
|
12735
|
+
</dl>
|
|
12736
|
+
</dd>
|
|
12737
|
+
</dl>
|
|
12738
|
+
|
|
12739
|
+
#### ⚙️ Parameters
|
|
12740
|
+
|
|
12741
|
+
<dl>
|
|
12742
|
+
<dd>
|
|
12743
|
+
|
|
12744
|
+
<dl>
|
|
12745
|
+
<dd>
|
|
12746
|
+
|
|
12747
|
+
**request:** `Management.UpdateBreachedPasswordDetectionSettingsRequestContent`
|
|
12748
|
+
|
|
12749
|
+
</dd>
|
|
12750
|
+
</dl>
|
|
12751
|
+
|
|
12752
|
+
<dl>
|
|
12753
|
+
<dd>
|
|
12754
|
+
|
|
12755
|
+
**requestOptions:** `BreachedPasswordDetectionClient.RequestOptions`
|
|
12756
|
+
|
|
12757
|
+
</dd>
|
|
12758
|
+
</dl>
|
|
12759
|
+
</dd>
|
|
12760
|
+
</dl>
|
|
12761
|
+
|
|
12762
|
+
</dd>
|
|
12763
|
+
</dl>
|
|
12764
|
+
</details>
|
|
12765
|
+
|
|
12766
|
+
## AttackProtection BruteForceProtection
|
|
12767
|
+
|
|
12768
|
+
<details><summary><code>client.attackProtection.bruteForceProtection.<a href="/src/management/api/resources/attackProtection/resources/bruteForceProtection/client/Client.ts">get</a>() -> Management.GetBruteForceSettingsResponseContent</code></summary>
|
|
12769
|
+
<dl>
|
|
12770
|
+
<dd>
|
|
12771
|
+
|
|
12772
|
+
#### 📝 Description
|
|
12773
|
+
|
|
12774
|
+
<dl>
|
|
12775
|
+
<dd>
|
|
12776
|
+
|
|
12777
|
+
<dl>
|
|
12778
|
+
<dd>
|
|
12779
|
+
|
|
12780
|
+
Retrieve details of the Brute-force Protection configuration of your tenant.
|
|
12781
|
+
|
|
12782
|
+
</dd>
|
|
12783
|
+
</dl>
|
|
12784
|
+
</dd>
|
|
12785
|
+
</dl>
|
|
12786
|
+
|
|
12787
|
+
#### 🔌 Usage
|
|
12788
|
+
|
|
12789
|
+
<dl>
|
|
12790
|
+
<dd>
|
|
12791
|
+
|
|
12792
|
+
<dl>
|
|
12793
|
+
<dd>
|
|
12794
|
+
|
|
12795
|
+
```typescript
|
|
12796
|
+
await client.attackProtection.bruteForceProtection.get();
|
|
12797
|
+
```
|
|
12798
|
+
|
|
12799
|
+
</dd>
|
|
12800
|
+
</dl>
|
|
12801
|
+
</dd>
|
|
12802
|
+
</dl>
|
|
12803
|
+
|
|
12804
|
+
#### ⚙️ Parameters
|
|
12805
|
+
|
|
12806
|
+
<dl>
|
|
12807
|
+
<dd>
|
|
12808
|
+
|
|
12809
|
+
<dl>
|
|
12810
|
+
<dd>
|
|
12811
|
+
|
|
12812
|
+
**requestOptions:** `BruteForceProtectionClient.RequestOptions`
|
|
12813
|
+
|
|
12814
|
+
</dd>
|
|
12815
|
+
</dl>
|
|
12816
|
+
</dd>
|
|
11798
12817
|
</dl>
|
|
11799
12818
|
|
|
11800
12819
|
</dd>
|
|
@@ -14065,9 +15084,9 @@ const response = page.response;
|
|
|
14065
15084
|
</dl>
|
|
14066
15085
|
</details>
|
|
14067
15086
|
|
|
14068
|
-
## Connections
|
|
15087
|
+
## Connections DirectoryProvisioning
|
|
14069
15088
|
|
|
14070
|
-
<details><summary><code>client.connections.
|
|
15089
|
+
<details><summary><code>client.connections.directoryProvisioning.<a href="/src/management/api/resources/connections/resources/directoryProvisioning/client/Client.ts">list</a>({ ...params }) -> core.Page<Management.DirectoryProvisioning, Management.ListDirectoryProvisioningsResponseContent></code></summary>
|
|
14071
15090
|
<dl>
|
|
14072
15091
|
<dd>
|
|
14073
15092
|
|
|
@@ -14079,9 +15098,7 @@ const response = page.response;
|
|
|
14079
15098
|
<dl>
|
|
14080
15099
|
<dd>
|
|
14081
15100
|
|
|
14082
|
-
Retrieve
|
|
14083
|
-
|
|
14084
|
-
<b>Note</b>: The first time you call this endpoint, omit the <code>from</code> parameter. If there are more results, a <code>next</code> value is included in the response. You can use this for subsequent API calls. When <code>next</code> is no longer included in the response, no further results are remaining.
|
|
15101
|
+
Retrieve a list of directory provisioning configurations of a tenant.
|
|
14085
15102
|
|
|
14086
15103
|
</dd>
|
|
14087
15104
|
</dl>
|
|
@@ -14097,18 +15114,18 @@ Retrieve all clients that have the specified <a href="https://auth0.com/docs/aut
|
|
|
14097
15114
|
<dd>
|
|
14098
15115
|
|
|
14099
15116
|
```typescript
|
|
14100
|
-
const pageableResponse = await client.connections.
|
|
14101
|
-
take: 1,
|
|
15117
|
+
const pageableResponse = await client.connections.directoryProvisioning.list({
|
|
14102
15118
|
from: "from",
|
|
15119
|
+
take: 1,
|
|
14103
15120
|
});
|
|
14104
15121
|
for await (const item of pageableResponse) {
|
|
14105
15122
|
console.log(item);
|
|
14106
15123
|
}
|
|
14107
15124
|
|
|
14108
15125
|
// Or you can manually iterate page-by-page
|
|
14109
|
-
let page = await client.connections.
|
|
14110
|
-
take: 1,
|
|
15126
|
+
let page = await client.connections.directoryProvisioning.list({
|
|
14111
15127
|
from: "from",
|
|
15128
|
+
take: 1,
|
|
14112
15129
|
});
|
|
14113
15130
|
while (page.hasNextPage()) {
|
|
14114
15131
|
page = page.getNextPage();
|
|
@@ -14131,7 +15148,7 @@ const response = page.response;
|
|
|
14131
15148
|
<dl>
|
|
14132
15149
|
<dd>
|
|
14133
15150
|
|
|
14134
|
-
**
|
|
15151
|
+
**request:** `Management.ListDirectoryProvisioningsRequestParameters`
|
|
14135
15152
|
|
|
14136
15153
|
</dd>
|
|
14137
15154
|
</dl>
|
|
@@ -14139,15 +15156,70 @@ const response = page.response;
|
|
|
14139
15156
|
<dl>
|
|
14140
15157
|
<dd>
|
|
14141
15158
|
|
|
14142
|
-
**
|
|
15159
|
+
**requestOptions:** `DirectoryProvisioningClient.RequestOptions`
|
|
15160
|
+
|
|
15161
|
+
</dd>
|
|
15162
|
+
</dl>
|
|
15163
|
+
</dd>
|
|
15164
|
+
</dl>
|
|
14143
15165
|
|
|
14144
15166
|
</dd>
|
|
14145
15167
|
</dl>
|
|
15168
|
+
</details>
|
|
14146
15169
|
|
|
15170
|
+
<details><summary><code>client.connections.directoryProvisioning.<a href="/src/management/api/resources/connections/resources/directoryProvisioning/client/Client.ts">get</a>(id) -> Management.GetDirectoryProvisioningResponseContent</code></summary>
|
|
14147
15171
|
<dl>
|
|
14148
15172
|
<dd>
|
|
14149
15173
|
|
|
14150
|
-
|
|
15174
|
+
#### 📝 Description
|
|
15175
|
+
|
|
15176
|
+
<dl>
|
|
15177
|
+
<dd>
|
|
15178
|
+
|
|
15179
|
+
<dl>
|
|
15180
|
+
<dd>
|
|
15181
|
+
|
|
15182
|
+
Retrieve the directory provisioning configuration of a connection.
|
|
15183
|
+
|
|
15184
|
+
</dd>
|
|
15185
|
+
</dl>
|
|
15186
|
+
</dd>
|
|
15187
|
+
</dl>
|
|
15188
|
+
|
|
15189
|
+
#### 🔌 Usage
|
|
15190
|
+
|
|
15191
|
+
<dl>
|
|
15192
|
+
<dd>
|
|
15193
|
+
|
|
15194
|
+
<dl>
|
|
15195
|
+
<dd>
|
|
15196
|
+
|
|
15197
|
+
```typescript
|
|
15198
|
+
await client.connections.directoryProvisioning.get("id");
|
|
15199
|
+
```
|
|
15200
|
+
|
|
15201
|
+
</dd>
|
|
15202
|
+
</dl>
|
|
15203
|
+
</dd>
|
|
15204
|
+
</dl>
|
|
15205
|
+
|
|
15206
|
+
#### ⚙️ Parameters
|
|
15207
|
+
|
|
15208
|
+
<dl>
|
|
15209
|
+
<dd>
|
|
15210
|
+
|
|
15211
|
+
<dl>
|
|
15212
|
+
<dd>
|
|
15213
|
+
|
|
15214
|
+
**id:** `string` — The id of the connection to retrieve its directory provisioning configuration
|
|
15215
|
+
|
|
15216
|
+
</dd>
|
|
15217
|
+
</dl>
|
|
15218
|
+
|
|
15219
|
+
<dl>
|
|
15220
|
+
<dd>
|
|
15221
|
+
|
|
15222
|
+
**requestOptions:** `DirectoryProvisioningClient.RequestOptions`
|
|
14151
15223
|
|
|
14152
15224
|
</dd>
|
|
14153
15225
|
</dl>
|
|
@@ -14158,10 +15230,25 @@ const response = page.response;
|
|
|
14158
15230
|
</dl>
|
|
14159
15231
|
</details>
|
|
14160
15232
|
|
|
14161
|
-
<details><summary><code>client.connections.
|
|
15233
|
+
<details><summary><code>client.connections.directoryProvisioning.<a href="/src/management/api/resources/connections/resources/directoryProvisioning/client/Client.ts">create</a>(id, { ...params }) -> Management.CreateDirectoryProvisioningResponseContent</code></summary>
|
|
15234
|
+
<dl>
|
|
15235
|
+
<dd>
|
|
15236
|
+
|
|
15237
|
+
#### 📝 Description
|
|
15238
|
+
|
|
15239
|
+
<dl>
|
|
15240
|
+
<dd>
|
|
15241
|
+
|
|
14162
15242
|
<dl>
|
|
14163
15243
|
<dd>
|
|
14164
15244
|
|
|
15245
|
+
Create a directory provisioning configuration for a connection.
|
|
15246
|
+
|
|
15247
|
+
</dd>
|
|
15248
|
+
</dl>
|
|
15249
|
+
</dd>
|
|
15250
|
+
</dl>
|
|
15251
|
+
|
|
14165
15252
|
#### 🔌 Usage
|
|
14166
15253
|
|
|
14167
15254
|
<dl>
|
|
@@ -14171,12 +15258,7 @@ const response = page.response;
|
|
|
14171
15258
|
<dd>
|
|
14172
15259
|
|
|
14173
15260
|
```typescript
|
|
14174
|
-
await client.connections.
|
|
14175
|
-
{
|
|
14176
|
-
client_id: "client_id",
|
|
14177
|
-
status: true,
|
|
14178
|
-
},
|
|
14179
|
-
]);
|
|
15261
|
+
await client.connections.directoryProvisioning.create("id");
|
|
14180
15262
|
```
|
|
14181
15263
|
|
|
14182
15264
|
</dd>
|
|
@@ -14192,7 +15274,7 @@ await client.connections.clients.update("id", [
|
|
|
14192
15274
|
<dl>
|
|
14193
15275
|
<dd>
|
|
14194
15276
|
|
|
14195
|
-
**id:** `string` — The id of the connection to
|
|
15277
|
+
**id:** `string` — The id of the connection to create its directory provisioning configuration
|
|
14196
15278
|
|
|
14197
15279
|
</dd>
|
|
14198
15280
|
</dl>
|
|
@@ -14200,7 +15282,7 @@ await client.connections.clients.update("id", [
|
|
|
14200
15282
|
<dl>
|
|
14201
15283
|
<dd>
|
|
14202
15284
|
|
|
14203
|
-
**request:** `Management.
|
|
15285
|
+
**request:** `Management.CreateDirectoryProvisioningRequestContent | null`
|
|
14204
15286
|
|
|
14205
15287
|
</dd>
|
|
14206
15288
|
</dl>
|
|
@@ -14208,7 +15290,7 @@ await client.connections.clients.update("id", [
|
|
|
14208
15290
|
<dl>
|
|
14209
15291
|
<dd>
|
|
14210
15292
|
|
|
14211
|
-
**requestOptions:** `
|
|
15293
|
+
**requestOptions:** `DirectoryProvisioningClient.RequestOptions`
|
|
14212
15294
|
|
|
14213
15295
|
</dd>
|
|
14214
15296
|
</dl>
|
|
@@ -14219,9 +15301,7 @@ await client.connections.clients.update("id", [
|
|
|
14219
15301
|
</dl>
|
|
14220
15302
|
</details>
|
|
14221
15303
|
|
|
14222
|
-
|
|
14223
|
-
|
|
14224
|
-
<details><summary><code>client.connections.directoryProvisioning.<a href="/src/management/api/resources/connections/resources/directoryProvisioning/client/Client.ts">get</a>(id) -> Management.GetDirectoryProvisioningResponseContent</code></summary>
|
|
15304
|
+
<details><summary><code>client.connections.directoryProvisioning.<a href="/src/management/api/resources/connections/resources/directoryProvisioning/client/Client.ts">delete</a>(id) -> void</code></summary>
|
|
14225
15305
|
<dl>
|
|
14226
15306
|
<dd>
|
|
14227
15307
|
|
|
@@ -14233,7 +15313,7 @@ await client.connections.clients.update("id", [
|
|
|
14233
15313
|
<dl>
|
|
14234
15314
|
<dd>
|
|
14235
15315
|
|
|
14236
|
-
|
|
15316
|
+
Delete the directory provisioning configuration of a connection.
|
|
14237
15317
|
|
|
14238
15318
|
</dd>
|
|
14239
15319
|
</dl>
|
|
@@ -14249,7 +15329,7 @@ Retrieve the directory provisioning configuration of a connection.
|
|
|
14249
15329
|
<dd>
|
|
14250
15330
|
|
|
14251
15331
|
```typescript
|
|
14252
|
-
await client.connections.directoryProvisioning.
|
|
15332
|
+
await client.connections.directoryProvisioning.delete("id");
|
|
14253
15333
|
```
|
|
14254
15334
|
|
|
14255
15335
|
</dd>
|
|
@@ -14265,7 +15345,7 @@ await client.connections.directoryProvisioning.get("id");
|
|
|
14265
15345
|
<dl>
|
|
14266
15346
|
<dd>
|
|
14267
15347
|
|
|
14268
|
-
**id:** `string` — The id of the connection to
|
|
15348
|
+
**id:** `string` — The id of the connection to delete its directory provisioning configuration
|
|
14269
15349
|
|
|
14270
15350
|
</dd>
|
|
14271
15351
|
</dl>
|
|
@@ -14284,7 +15364,7 @@ await client.connections.directoryProvisioning.get("id");
|
|
|
14284
15364
|
</dl>
|
|
14285
15365
|
</details>
|
|
14286
15366
|
|
|
14287
|
-
<details><summary><code>client.connections.directoryProvisioning.<a href="/src/management/api/resources/connections/resources/directoryProvisioning/client/Client.ts">
|
|
15367
|
+
<details><summary><code>client.connections.directoryProvisioning.<a href="/src/management/api/resources/connections/resources/directoryProvisioning/client/Client.ts">update</a>(id, { ...params }) -> Management.UpdateDirectoryProvisioningResponseContent</code></summary>
|
|
14288
15368
|
<dl>
|
|
14289
15369
|
<dd>
|
|
14290
15370
|
|
|
@@ -14296,7 +15376,7 @@ await client.connections.directoryProvisioning.get("id");
|
|
|
14296
15376
|
<dl>
|
|
14297
15377
|
<dd>
|
|
14298
15378
|
|
|
14299
|
-
|
|
15379
|
+
Update the directory provisioning configuration of a connection.
|
|
14300
15380
|
|
|
14301
15381
|
</dd>
|
|
14302
15382
|
</dl>
|
|
@@ -14312,7 +15392,7 @@ Create a directory provisioning configuration for a connection.
|
|
|
14312
15392
|
<dd>
|
|
14313
15393
|
|
|
14314
15394
|
```typescript
|
|
14315
|
-
await client.connections.directoryProvisioning.
|
|
15395
|
+
await client.connections.directoryProvisioning.update("id");
|
|
14316
15396
|
```
|
|
14317
15397
|
|
|
14318
15398
|
</dd>
|
|
@@ -14336,7 +15416,7 @@ await client.connections.directoryProvisioning.create("id");
|
|
|
14336
15416
|
<dl>
|
|
14337
15417
|
<dd>
|
|
14338
15418
|
|
|
14339
|
-
**request:** `Management.
|
|
15419
|
+
**request:** `Management.UpdateDirectoryProvisioningRequestContent | null`
|
|
14340
15420
|
|
|
14341
15421
|
</dd>
|
|
14342
15422
|
</dl>
|
|
@@ -14355,7 +15435,7 @@ await client.connections.directoryProvisioning.create("id");
|
|
|
14355
15435
|
</dl>
|
|
14356
15436
|
</details>
|
|
14357
15437
|
|
|
14358
|
-
<details><summary><code>client.connections.directoryProvisioning.<a href="/src/management/api/resources/connections/resources/directoryProvisioning/client/Client.ts">
|
|
15438
|
+
<details><summary><code>client.connections.directoryProvisioning.<a href="/src/management/api/resources/connections/resources/directoryProvisioning/client/Client.ts">getDefaultMapping</a>(id) -> Management.GetDirectoryProvisioningDefaultMappingResponseContent</code></summary>
|
|
14359
15439
|
<dl>
|
|
14360
15440
|
<dd>
|
|
14361
15441
|
|
|
@@ -14367,7 +15447,7 @@ await client.connections.directoryProvisioning.create("id");
|
|
|
14367
15447
|
<dl>
|
|
14368
15448
|
<dd>
|
|
14369
15449
|
|
|
14370
|
-
|
|
15450
|
+
Retrieve the directory provisioning default attribute mapping of a connection.
|
|
14371
15451
|
|
|
14372
15452
|
</dd>
|
|
14373
15453
|
</dl>
|
|
@@ -14383,7 +15463,7 @@ Delete the directory provisioning configuration of a connection.
|
|
|
14383
15463
|
<dd>
|
|
14384
15464
|
|
|
14385
15465
|
```typescript
|
|
14386
|
-
await client.connections.directoryProvisioning.
|
|
15466
|
+
await client.connections.directoryProvisioning.getDefaultMapping("id");
|
|
14387
15467
|
```
|
|
14388
15468
|
|
|
14389
15469
|
</dd>
|
|
@@ -14399,7 +15479,7 @@ await client.connections.directoryProvisioning.delete("id");
|
|
|
14399
15479
|
<dl>
|
|
14400
15480
|
<dd>
|
|
14401
15481
|
|
|
14402
|
-
**id:** `string` — The id of the connection to
|
|
15482
|
+
**id:** `string` — The id of the connection to retrieve its directory provisioning configuration
|
|
14403
15483
|
|
|
14404
15484
|
</dd>
|
|
14405
15485
|
</dl>
|
|
@@ -14418,7 +15498,9 @@ await client.connections.directoryProvisioning.delete("id");
|
|
|
14418
15498
|
</dl>
|
|
14419
15499
|
</details>
|
|
14420
15500
|
|
|
14421
|
-
|
|
15501
|
+
## Connections Clients
|
|
15502
|
+
|
|
15503
|
+
<details><summary><code>client.connections.clients.<a href="/src/management/api/resources/connections/resources/clients/client/Client.ts">get</a>(id, { ...params }) -> core.Page<Management.ConnectionEnabledClient, Management.GetConnectionEnabledClientsResponseContent></code></summary>
|
|
14422
15504
|
<dl>
|
|
14423
15505
|
<dd>
|
|
14424
15506
|
|
|
@@ -14430,7 +15512,9 @@ await client.connections.directoryProvisioning.delete("id");
|
|
|
14430
15512
|
<dl>
|
|
14431
15513
|
<dd>
|
|
14432
15514
|
|
|
14433
|
-
|
|
15515
|
+
Retrieve all clients that have the specified <a href="https://auth0.com/docs/authenticate/identity-providers">connection</a> enabled.
|
|
15516
|
+
|
|
15517
|
+
<b>Note</b>: The first time you call this endpoint, omit the <code>from</code> parameter. If there are more results, a <code>next</code> value is included in the response. You can use this for subsequent API calls. When <code>next</code> is no longer included in the response, no further results are remaining.
|
|
14434
15518
|
|
|
14435
15519
|
</dd>
|
|
14436
15520
|
</dl>
|
|
@@ -14446,7 +15530,25 @@ Update the directory provisioning configuration of a connection.
|
|
|
14446
15530
|
<dd>
|
|
14447
15531
|
|
|
14448
15532
|
```typescript
|
|
14449
|
-
await client.connections.
|
|
15533
|
+
const pageableResponse = await client.connections.clients.get("id", {
|
|
15534
|
+
take: 1,
|
|
15535
|
+
from: "from",
|
|
15536
|
+
});
|
|
15537
|
+
for await (const item of pageableResponse) {
|
|
15538
|
+
console.log(item);
|
|
15539
|
+
}
|
|
15540
|
+
|
|
15541
|
+
// Or you can manually iterate page-by-page
|
|
15542
|
+
let page = await client.connections.clients.get("id", {
|
|
15543
|
+
take: 1,
|
|
15544
|
+
from: "from",
|
|
15545
|
+
});
|
|
15546
|
+
while (page.hasNextPage()) {
|
|
15547
|
+
page = page.getNextPage();
|
|
15548
|
+
}
|
|
15549
|
+
|
|
15550
|
+
// You can also access the underlying response
|
|
15551
|
+
const response = page.response;
|
|
14450
15552
|
```
|
|
14451
15553
|
|
|
14452
15554
|
</dd>
|
|
@@ -14462,7 +15564,7 @@ await client.connections.directoryProvisioning.update("id");
|
|
|
14462
15564
|
<dl>
|
|
14463
15565
|
<dd>
|
|
14464
15566
|
|
|
14465
|
-
**id:** `string` — The id of the connection
|
|
15567
|
+
**id:** `string` — The id of the connection for which enabled clients are to be retrieved
|
|
14466
15568
|
|
|
14467
15569
|
</dd>
|
|
14468
15570
|
</dl>
|
|
@@ -14470,7 +15572,7 @@ await client.connections.directoryProvisioning.update("id");
|
|
|
14470
15572
|
<dl>
|
|
14471
15573
|
<dd>
|
|
14472
15574
|
|
|
14473
|
-
**request:** `Management.
|
|
15575
|
+
**request:** `Management.GetConnectionEnabledClientsRequestParameters`
|
|
14474
15576
|
|
|
14475
15577
|
</dd>
|
|
14476
15578
|
</dl>
|
|
@@ -14478,7 +15580,7 @@ await client.connections.directoryProvisioning.update("id");
|
|
|
14478
15580
|
<dl>
|
|
14479
15581
|
<dd>
|
|
14480
15582
|
|
|
14481
|
-
**requestOptions:** `
|
|
15583
|
+
**requestOptions:** `ClientsClient.RequestOptions`
|
|
14482
15584
|
|
|
14483
15585
|
</dd>
|
|
14484
15586
|
</dl>
|
|
@@ -14489,25 +15591,10 @@ await client.connections.directoryProvisioning.update("id");
|
|
|
14489
15591
|
</dl>
|
|
14490
15592
|
</details>
|
|
14491
15593
|
|
|
14492
|
-
<details><summary><code>client.connections.
|
|
14493
|
-
<dl>
|
|
14494
|
-
<dd>
|
|
14495
|
-
|
|
14496
|
-
#### 📝 Description
|
|
14497
|
-
|
|
14498
|
-
<dl>
|
|
14499
|
-
<dd>
|
|
14500
|
-
|
|
15594
|
+
<details><summary><code>client.connections.clients.<a href="/src/management/api/resources/connections/resources/clients/client/Client.ts">update</a>(id, { ...params }) -> void</code></summary>
|
|
14501
15595
|
<dl>
|
|
14502
15596
|
<dd>
|
|
14503
15597
|
|
|
14504
|
-
Retrieve the directory provisioning default attribute mapping of a connection.
|
|
14505
|
-
|
|
14506
|
-
</dd>
|
|
14507
|
-
</dl>
|
|
14508
|
-
</dd>
|
|
14509
|
-
</dl>
|
|
14510
|
-
|
|
14511
15598
|
#### 🔌 Usage
|
|
14512
15599
|
|
|
14513
15600
|
<dl>
|
|
@@ -14517,7 +15604,12 @@ Retrieve the directory provisioning default attribute mapping of a connection.
|
|
|
14517
15604
|
<dd>
|
|
14518
15605
|
|
|
14519
15606
|
```typescript
|
|
14520
|
-
await client.connections.
|
|
15607
|
+
await client.connections.clients.update("id", [
|
|
15608
|
+
{
|
|
15609
|
+
client_id: "client_id",
|
|
15610
|
+
status: true,
|
|
15611
|
+
},
|
|
15612
|
+
]);
|
|
14521
15613
|
```
|
|
14522
15614
|
|
|
14523
15615
|
</dd>
|
|
@@ -14533,7 +15625,7 @@ await client.connections.directoryProvisioning.getDefaultMapping("id");
|
|
|
14533
15625
|
<dl>
|
|
14534
15626
|
<dd>
|
|
14535
15627
|
|
|
14536
|
-
**id:** `string` — The id of the connection to
|
|
15628
|
+
**id:** `string` — The id of the connection to modify
|
|
14537
15629
|
|
|
14538
15630
|
</dd>
|
|
14539
15631
|
</dl>
|
|
@@ -14541,7 +15633,15 @@ await client.connections.directoryProvisioning.getDefaultMapping("id");
|
|
|
14541
15633
|
<dl>
|
|
14542
15634
|
<dd>
|
|
14543
15635
|
|
|
14544
|
-
**
|
|
15636
|
+
**request:** `Management.UpdateEnabledClientConnectionsRequestContent`
|
|
15637
|
+
|
|
15638
|
+
</dd>
|
|
15639
|
+
</dl>
|
|
15640
|
+
|
|
15641
|
+
<dl>
|
|
15642
|
+
<dd>
|
|
15643
|
+
|
|
15644
|
+
**requestOptions:** `ClientsClient.RequestOptions`
|
|
14545
15645
|
|
|
14546
15646
|
</dd>
|
|
14547
15647
|
</dl>
|
|
@@ -16414,6 +17514,101 @@ await client.flows.vault.connections.update("id");
|
|
|
16414
17514
|
</dl>
|
|
16415
17515
|
</details>
|
|
16416
17516
|
|
|
17517
|
+
## Groups Members
|
|
17518
|
+
|
|
17519
|
+
<details><summary><code>client.groups.members.<a href="/src/management/api/resources/groups/resources/members/client/Client.ts">get</a>(id, { ...params }) -> core.Page<Management.GroupMember, Management.GetGroupMembersResponseContent></code></summary>
|
|
17520
|
+
<dl>
|
|
17521
|
+
<dd>
|
|
17522
|
+
|
|
17523
|
+
#### 📝 Description
|
|
17524
|
+
|
|
17525
|
+
<dl>
|
|
17526
|
+
<dd>
|
|
17527
|
+
|
|
17528
|
+
<dl>
|
|
17529
|
+
<dd>
|
|
17530
|
+
|
|
17531
|
+
List all users that are a member of this group.
|
|
17532
|
+
|
|
17533
|
+
</dd>
|
|
17534
|
+
</dl>
|
|
17535
|
+
</dd>
|
|
17536
|
+
</dl>
|
|
17537
|
+
|
|
17538
|
+
#### 🔌 Usage
|
|
17539
|
+
|
|
17540
|
+
<dl>
|
|
17541
|
+
<dd>
|
|
17542
|
+
|
|
17543
|
+
<dl>
|
|
17544
|
+
<dd>
|
|
17545
|
+
|
|
17546
|
+
```typescript
|
|
17547
|
+
const pageableResponse = await client.groups.members.get("id", {
|
|
17548
|
+
fields: "fields",
|
|
17549
|
+
include_fields: true,
|
|
17550
|
+
from: "from",
|
|
17551
|
+
take: 1,
|
|
17552
|
+
});
|
|
17553
|
+
for await (const item of pageableResponse) {
|
|
17554
|
+
console.log(item);
|
|
17555
|
+
}
|
|
17556
|
+
|
|
17557
|
+
// Or you can manually iterate page-by-page
|
|
17558
|
+
let page = await client.groups.members.get("id", {
|
|
17559
|
+
fields: "fields",
|
|
17560
|
+
include_fields: true,
|
|
17561
|
+
from: "from",
|
|
17562
|
+
take: 1,
|
|
17563
|
+
});
|
|
17564
|
+
while (page.hasNextPage()) {
|
|
17565
|
+
page = page.getNextPage();
|
|
17566
|
+
}
|
|
17567
|
+
|
|
17568
|
+
// You can also access the underlying response
|
|
17569
|
+
const response = page.response;
|
|
17570
|
+
```
|
|
17571
|
+
|
|
17572
|
+
</dd>
|
|
17573
|
+
</dl>
|
|
17574
|
+
</dd>
|
|
17575
|
+
</dl>
|
|
17576
|
+
|
|
17577
|
+
#### ⚙️ Parameters
|
|
17578
|
+
|
|
17579
|
+
<dl>
|
|
17580
|
+
<dd>
|
|
17581
|
+
|
|
17582
|
+
<dl>
|
|
17583
|
+
<dd>
|
|
17584
|
+
|
|
17585
|
+
**id:** `string` — Unique identifier for the group (service-generated).
|
|
17586
|
+
|
|
17587
|
+
</dd>
|
|
17588
|
+
</dl>
|
|
17589
|
+
|
|
17590
|
+
<dl>
|
|
17591
|
+
<dd>
|
|
17592
|
+
|
|
17593
|
+
**request:** `Management.GetGroupMembersRequestParameters`
|
|
17594
|
+
|
|
17595
|
+
</dd>
|
|
17596
|
+
</dl>
|
|
17597
|
+
|
|
17598
|
+
<dl>
|
|
17599
|
+
<dd>
|
|
17600
|
+
|
|
17601
|
+
**requestOptions:** `MembersClient.RequestOptions`
|
|
17602
|
+
|
|
17603
|
+
</dd>
|
|
17604
|
+
</dl>
|
|
17605
|
+
</dd>
|
|
17606
|
+
</dl>
|
|
17607
|
+
|
|
17608
|
+
</dd>
|
|
17609
|
+
</dl>
|
|
17610
|
+
</details>
|
|
17611
|
+
|
|
16417
17612
|
## Guardian Enrollments
|
|
16418
17613
|
|
|
16419
17614
|
<details><summary><code>client.guardian.enrollments.<a href="/src/management/api/resources/guardian/resources/enrollments/client/Client.ts">createTicket</a>({ ...params }) -> Management.CreateGuardianEnrollmentTicketResponseContent</code></summary>
|
|
@@ -20355,7 +21550,7 @@ const response = page.response;
|
|
|
20355
21550
|
<dl>
|
|
20356
21551
|
<dd>
|
|
20357
21552
|
|
|
20358
|
-
|
|
21553
|
+
Create a new discovery domain for an organization.
|
|
20359
21554
|
|
|
20360
21555
|
</dd>
|
|
20361
21556
|
</dl>
|
|
@@ -20416,6 +21611,77 @@ await client.organizations.discoveryDomains.create("id", {
|
|
|
20416
21611
|
</dl>
|
|
20417
21612
|
</details>
|
|
20418
21613
|
|
|
21614
|
+
<details><summary><code>client.organizations.discoveryDomains.<a href="/src/management/api/resources/organizations/resources/discoveryDomains/client/Client.ts">getByName</a>(id, discovery_domain) -> Management.GetOrganizationDiscoveryDomainByNameResponseContent</code></summary>
|
|
21615
|
+
<dl>
|
|
21616
|
+
<dd>
|
|
21617
|
+
|
|
21618
|
+
#### 📝 Description
|
|
21619
|
+
|
|
21620
|
+
<dl>
|
|
21621
|
+
<dd>
|
|
21622
|
+
|
|
21623
|
+
<dl>
|
|
21624
|
+
<dd>
|
|
21625
|
+
|
|
21626
|
+
Retrieve details about a single organization discovery domain specified by domain name.
|
|
21627
|
+
|
|
21628
|
+
</dd>
|
|
21629
|
+
</dl>
|
|
21630
|
+
</dd>
|
|
21631
|
+
</dl>
|
|
21632
|
+
|
|
21633
|
+
#### 🔌 Usage
|
|
21634
|
+
|
|
21635
|
+
<dl>
|
|
21636
|
+
<dd>
|
|
21637
|
+
|
|
21638
|
+
<dl>
|
|
21639
|
+
<dd>
|
|
21640
|
+
|
|
21641
|
+
```typescript
|
|
21642
|
+
await client.organizations.discoveryDomains.getByName("id", "discovery_domain");
|
|
21643
|
+
```
|
|
21644
|
+
|
|
21645
|
+
</dd>
|
|
21646
|
+
</dl>
|
|
21647
|
+
</dd>
|
|
21648
|
+
</dl>
|
|
21649
|
+
|
|
21650
|
+
#### ⚙️ Parameters
|
|
21651
|
+
|
|
21652
|
+
<dl>
|
|
21653
|
+
<dd>
|
|
21654
|
+
|
|
21655
|
+
<dl>
|
|
21656
|
+
<dd>
|
|
21657
|
+
|
|
21658
|
+
**id:** `string` — ID of the organization.
|
|
21659
|
+
|
|
21660
|
+
</dd>
|
|
21661
|
+
</dl>
|
|
21662
|
+
|
|
21663
|
+
<dl>
|
|
21664
|
+
<dd>
|
|
21665
|
+
|
|
21666
|
+
**discovery_domain:** `string` — Domain name of the discovery domain.
|
|
21667
|
+
|
|
21668
|
+
</dd>
|
|
21669
|
+
</dl>
|
|
21670
|
+
|
|
21671
|
+
<dl>
|
|
21672
|
+
<dd>
|
|
21673
|
+
|
|
21674
|
+
**requestOptions:** `DiscoveryDomainsClient.RequestOptions`
|
|
21675
|
+
|
|
21676
|
+
</dd>
|
|
21677
|
+
</dl>
|
|
21678
|
+
</dd>
|
|
21679
|
+
</dl>
|
|
21680
|
+
|
|
21681
|
+
</dd>
|
|
21682
|
+
</dl>
|
|
21683
|
+
</details>
|
|
21684
|
+
|
|
20419
21685
|
<details><summary><code>client.organizations.discoveryDomains.<a href="/src/management/api/resources/organizations/resources/discoveryDomains/client/Client.ts">get</a>(id, discovery_domain_id) -> Management.GetOrganizationDiscoveryDomainResponseContent</code></summary>
|
|
20420
21686
|
<dl>
|
|
20421
21687
|
<dd>
|
|
@@ -21849,7 +23115,7 @@ await client.organizations.members.roles.delete("id", "user_id", {
|
|
|
21849
23115
|
|
|
21850
23116
|
## Prompts Rendering
|
|
21851
23117
|
|
|
21852
|
-
<details><summary><code>client.prompts.rendering.<a href="/src/management/api/resources/prompts/resources/rendering/client/Client.ts">list</a>({ ...params }) -> core.Page<Management.
|
|
23118
|
+
<details><summary><code>client.prompts.rendering.<a href="/src/management/api/resources/prompts/resources/rendering/client/Client.ts">list</a>({ ...params }) -> core.Page<Management.ListAculsResponseContentItem, Management.ListAculsOffsetPaginatedResponseContent></code></summary>
|
|
21853
23119
|
<dl>
|
|
21854
23120
|
<dd>
|
|
21855
23121
|
|
|
@@ -24433,6 +25699,101 @@ await client.users.federatedConnectionsTokensets.delete("id", "tokenset_id");
|
|
|
24433
25699
|
</dl>
|
|
24434
25700
|
</details>
|
|
24435
25701
|
|
|
25702
|
+
## Users Groups
|
|
25703
|
+
|
|
25704
|
+
<details><summary><code>client.users.groups.<a href="/src/management/api/resources/users/resources/groups/client/Client.ts">get</a>(id, { ...params }) -> core.Page<Management.UserGroupsResponseSchema, Management.GetUserGroupsPaginatedResponseContent></code></summary>
|
|
25705
|
+
<dl>
|
|
25706
|
+
<dd>
|
|
25707
|
+
|
|
25708
|
+
#### 📝 Description
|
|
25709
|
+
|
|
25710
|
+
<dl>
|
|
25711
|
+
<dd>
|
|
25712
|
+
|
|
25713
|
+
<dl>
|
|
25714
|
+
<dd>
|
|
25715
|
+
|
|
25716
|
+
List all groups to which this user belongs.
|
|
25717
|
+
|
|
25718
|
+
</dd>
|
|
25719
|
+
</dl>
|
|
25720
|
+
</dd>
|
|
25721
|
+
</dl>
|
|
25722
|
+
|
|
25723
|
+
#### 🔌 Usage
|
|
25724
|
+
|
|
25725
|
+
<dl>
|
|
25726
|
+
<dd>
|
|
25727
|
+
|
|
25728
|
+
<dl>
|
|
25729
|
+
<dd>
|
|
25730
|
+
|
|
25731
|
+
```typescript
|
|
25732
|
+
const pageableResponse = await client.users.groups.get("id", {
|
|
25733
|
+
fields: "fields",
|
|
25734
|
+
include_fields: true,
|
|
25735
|
+
from: "from",
|
|
25736
|
+
take: 1,
|
|
25737
|
+
});
|
|
25738
|
+
for await (const item of pageableResponse) {
|
|
25739
|
+
console.log(item);
|
|
25740
|
+
}
|
|
25741
|
+
|
|
25742
|
+
// Or you can manually iterate page-by-page
|
|
25743
|
+
let page = await client.users.groups.get("id", {
|
|
25744
|
+
fields: "fields",
|
|
25745
|
+
include_fields: true,
|
|
25746
|
+
from: "from",
|
|
25747
|
+
take: 1,
|
|
25748
|
+
});
|
|
25749
|
+
while (page.hasNextPage()) {
|
|
25750
|
+
page = page.getNextPage();
|
|
25751
|
+
}
|
|
25752
|
+
|
|
25753
|
+
// You can also access the underlying response
|
|
25754
|
+
const response = page.response;
|
|
25755
|
+
```
|
|
25756
|
+
|
|
25757
|
+
</dd>
|
|
25758
|
+
</dl>
|
|
25759
|
+
</dd>
|
|
25760
|
+
</dl>
|
|
25761
|
+
|
|
25762
|
+
#### ⚙️ Parameters
|
|
25763
|
+
|
|
25764
|
+
<dl>
|
|
25765
|
+
<dd>
|
|
25766
|
+
|
|
25767
|
+
<dl>
|
|
25768
|
+
<dd>
|
|
25769
|
+
|
|
25770
|
+
**id:** `string` — ID of the user to list groups for.
|
|
25771
|
+
|
|
25772
|
+
</dd>
|
|
25773
|
+
</dl>
|
|
25774
|
+
|
|
25775
|
+
<dl>
|
|
25776
|
+
<dd>
|
|
25777
|
+
|
|
25778
|
+
**request:** `Management.GetUserGroupsRequestParameters`
|
|
25779
|
+
|
|
25780
|
+
</dd>
|
|
25781
|
+
</dl>
|
|
25782
|
+
|
|
25783
|
+
<dl>
|
|
25784
|
+
<dd>
|
|
25785
|
+
|
|
25786
|
+
**requestOptions:** `GroupsClient.RequestOptions`
|
|
25787
|
+
|
|
25788
|
+
</dd>
|
|
25789
|
+
</dl>
|
|
25790
|
+
</dd>
|
|
25791
|
+
</dl>
|
|
25792
|
+
|
|
25793
|
+
</dd>
|
|
25794
|
+
</dl>
|
|
25795
|
+
</details>
|
|
25796
|
+
|
|
24436
25797
|
## Users Identities
|
|
24437
25798
|
|
|
24438
25799
|
<details><summary><code>client.users.identities.<a href="/src/management/api/resources/users/resources/identities/client/Client.ts">link</a>(id, { ...params }) -> Management.UserIdentity[]</code></summary>
|