auth0 7.4.0-beta.2 → 7.5.0-beta.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/cjs/management/api/requests/requests.d.ts +73 -22
- package/dist/cjs/management/api/resources/attackProtection/client/Client.d.ts +3 -0
- package/dist/cjs/management/api/resources/attackProtection/client/Client.js +9 -4
- package/dist/cjs/management/api/resources/attackProtection/resources/captchaPolicies/client/Client.d.ts +105 -0
- package/dist/cjs/management/api/resources/attackProtection/resources/captchaPolicies/client/Client.js +388 -0
- package/dist/cjs/management/api/resources/attackProtection/resources/captchaPolicies/client/index.d.ts +1 -0
- package/dist/cjs/management/api/resources/attackProtection/resources/captchaPolicies/client/index.js +2 -0
- package/dist/cjs/management/api/resources/attackProtection/resources/captchaPolicies/exports.d.ts +2 -0
- package/dist/cjs/management/api/resources/attackProtection/resources/captchaPolicies/exports.js +21 -0
- package/dist/cjs/management/api/resources/attackProtection/resources/captchaPolicies/index.d.ts +1 -0
- package/dist/cjs/management/api/resources/attackProtection/resources/captchaPolicies/index.js +17 -0
- package/dist/cjs/management/api/resources/attackProtection/resources/index.d.ts +1 -0
- package/dist/cjs/management/api/resources/attackProtection/resources/index.js +2 -1
- package/dist/cjs/management/api/resources/clientGrants/client/Client.d.ts +27 -0
- package/dist/cjs/management/api/resources/clientGrants/client/Client.js +101 -0
- package/dist/cjs/management/api/resources/clients/client/Client.d.ts +1 -0
- package/dist/cjs/management/api/resources/clients/client/Client.js +3 -0
- package/dist/cjs/management/api/resources/experimentation/resources/experiments/client/Client.d.ts +0 -22
- package/dist/cjs/management/api/resources/experimentation/resources/experiments/client/Client.js +0 -75
- package/dist/cjs/management/api/resources/experimentation/resources/featureFlags/client/Client.d.ts +0 -20
- package/dist/cjs/management/api/resources/experimentation/resources/featureFlags/client/Client.js +0 -69
- package/dist/cjs/management/api/resources/experimentation/resources/featureFlags/resources/variations/client/Client.d.ts +0 -1
- package/dist/cjs/management/api/resources/experimentation/resources/featureFlags/resources/variations/client/Client.js +0 -3
- package/dist/cjs/management/api/resources/roles/client/Client.d.ts +1 -1
- package/dist/cjs/management/api/resources/roles/client/Client.js +1 -1
- package/dist/cjs/management/api/types/types.d.ts +1364 -566
- package/dist/cjs/management/api/types/types.js +101 -174
- package/dist/cjs/management/version.d.ts +1 -1
- package/dist/cjs/management/version.js +1 -1
- package/dist/esm/management/api/requests/requests.d.mts +73 -22
- package/dist/esm/management/api/resources/attackProtection/client/Client.d.mts +3 -0
- package/dist/esm/management/api/resources/attackProtection/client/Client.mjs +5 -0
- package/dist/esm/management/api/resources/attackProtection/resources/captchaPolicies/client/Client.d.mts +105 -0
- package/dist/esm/management/api/resources/attackProtection/resources/captchaPolicies/client/Client.mjs +351 -0
- package/dist/esm/management/api/resources/attackProtection/resources/captchaPolicies/client/index.d.mts +1 -0
- package/dist/esm/management/api/resources/attackProtection/resources/captchaPolicies/client/index.mjs +1 -0
- package/dist/esm/management/api/resources/attackProtection/resources/captchaPolicies/exports.d.mts +2 -0
- package/dist/esm/management/api/resources/attackProtection/resources/captchaPolicies/exports.mjs +3 -0
- package/dist/esm/management/api/resources/attackProtection/resources/captchaPolicies/index.d.mts +1 -0
- package/dist/esm/management/api/resources/attackProtection/resources/captchaPolicies/index.mjs +1 -0
- package/dist/esm/management/api/resources/attackProtection/resources/index.d.mts +1 -0
- package/dist/esm/management/api/resources/attackProtection/resources/index.mjs +1 -0
- package/dist/esm/management/api/resources/clientGrants/client/Client.d.mts +27 -0
- package/dist/esm/management/api/resources/clientGrants/client/Client.mjs +101 -0
- package/dist/esm/management/api/resources/clients/client/Client.d.mts +1 -0
- package/dist/esm/management/api/resources/clients/client/Client.mjs +3 -0
- package/dist/esm/management/api/resources/experimentation/resources/experiments/client/Client.d.mts +0 -22
- package/dist/esm/management/api/resources/experimentation/resources/experiments/client/Client.mjs +0 -75
- package/dist/esm/management/api/resources/experimentation/resources/featureFlags/client/Client.d.mts +0 -20
- package/dist/esm/management/api/resources/experimentation/resources/featureFlags/client/Client.mjs +0 -69
- package/dist/esm/management/api/resources/experimentation/resources/featureFlags/resources/variations/client/Client.d.mts +0 -1
- package/dist/esm/management/api/resources/experimentation/resources/featureFlags/resources/variations/client/Client.mjs +0 -3
- package/dist/esm/management/api/resources/roles/client/Client.d.mts +1 -1
- package/dist/esm/management/api/resources/roles/client/Client.mjs +1 -1
- package/dist/esm/management/api/types/types.d.mts +1364 -566
- package/dist/esm/management/api/types/types.mjs +80 -153
- package/dist/esm/management/version.d.mts +1 -1
- package/dist/esm/management/version.mjs +1 -1
- package/package.json +12 -1
- package/reference.md +514 -246
package/reference.md
CHANGED
|
@@ -1131,6 +1131,98 @@ await client.clientGrants.create({
|
|
|
1131
1131
|
</dl>
|
|
1132
1132
|
</details>
|
|
1133
1133
|
|
|
1134
|
+
<details><summary><code>client.clientGrants.<a href="/src/management/api/resources/clientGrants/client/Client.ts">search</a>({ ...params }) -> core.Page<Management.ClientGrantResponseContent, Management.SearchClientGrantsResponseContent></code></summary>
|
|
1135
|
+
<dl>
|
|
1136
|
+
<dd>
|
|
1137
|
+
|
|
1138
|
+
#### 📝 Description
|
|
1139
|
+
|
|
1140
|
+
<dl>
|
|
1141
|
+
<dd>
|
|
1142
|
+
|
|
1143
|
+
<dl>
|
|
1144
|
+
<dd>
|
|
1145
|
+
|
|
1146
|
+
Search client grants using SCIM or Lucene filter syntax with low-latency, eventually consistent results. Use the parser parameter to specify "scim" or "lucene" syntax (default: "lucene"). This endpoint provides an alternative to the standard GET /client-grants endpoint with better performance for complex queries.
|
|
1147
|
+
Results may not reflect recent updates immediately.
|
|
1148
|
+
|
|
1149
|
+
</dd>
|
|
1150
|
+
</dl>
|
|
1151
|
+
</dd>
|
|
1152
|
+
</dl>
|
|
1153
|
+
|
|
1154
|
+
#### 🔌 Usage
|
|
1155
|
+
|
|
1156
|
+
<dl>
|
|
1157
|
+
<dd>
|
|
1158
|
+
|
|
1159
|
+
<dl>
|
|
1160
|
+
<dd>
|
|
1161
|
+
|
|
1162
|
+
```typescript
|
|
1163
|
+
const pageableResponse = await client.clientGrants.search({
|
|
1164
|
+
q: "q",
|
|
1165
|
+
parser: "scim",
|
|
1166
|
+
fields: "fields",
|
|
1167
|
+
include_fields: true,
|
|
1168
|
+
take: 1,
|
|
1169
|
+
from: "from",
|
|
1170
|
+
sort: "audience",
|
|
1171
|
+
});
|
|
1172
|
+
for await (const item of pageableResponse) {
|
|
1173
|
+
console.log(item);
|
|
1174
|
+
}
|
|
1175
|
+
|
|
1176
|
+
// Or you can manually iterate page-by-page
|
|
1177
|
+
let page = await client.clientGrants.search({
|
|
1178
|
+
q: "q",
|
|
1179
|
+
parser: "scim",
|
|
1180
|
+
fields: "fields",
|
|
1181
|
+
include_fields: true,
|
|
1182
|
+
take: 1,
|
|
1183
|
+
from: "from",
|
|
1184
|
+
sort: "audience",
|
|
1185
|
+
});
|
|
1186
|
+
while (page.hasNextPage()) {
|
|
1187
|
+
page = page.getNextPage();
|
|
1188
|
+
}
|
|
1189
|
+
|
|
1190
|
+
// You can also access the underlying response
|
|
1191
|
+
const response = page.response;
|
|
1192
|
+
```
|
|
1193
|
+
|
|
1194
|
+
</dd>
|
|
1195
|
+
</dl>
|
|
1196
|
+
</dd>
|
|
1197
|
+
</dl>
|
|
1198
|
+
|
|
1199
|
+
#### ⚙️ Parameters
|
|
1200
|
+
|
|
1201
|
+
<dl>
|
|
1202
|
+
<dd>
|
|
1203
|
+
|
|
1204
|
+
<dl>
|
|
1205
|
+
<dd>
|
|
1206
|
+
|
|
1207
|
+
**request:** `Management.SearchClientGrantsRequestParameters`
|
|
1208
|
+
|
|
1209
|
+
</dd>
|
|
1210
|
+
</dl>
|
|
1211
|
+
|
|
1212
|
+
<dl>
|
|
1213
|
+
<dd>
|
|
1214
|
+
|
|
1215
|
+
**requestOptions:** `ClientGrantsClient.RequestOptions`
|
|
1216
|
+
|
|
1217
|
+
</dd>
|
|
1218
|
+
</dl>
|
|
1219
|
+
</dd>
|
|
1220
|
+
</dl>
|
|
1221
|
+
|
|
1222
|
+
</dd>
|
|
1223
|
+
</dl>
|
|
1224
|
+
</details>
|
|
1225
|
+
|
|
1134
1226
|
<details><summary><code>client.clientGrants.<a href="/src/management/api/resources/clientGrants/client/Client.ts">get</a>(id) -> Management.GetClientGrantResponseContent</code></summary>
|
|
1135
1227
|
<dl>
|
|
1136
1228
|
<dd>
|
|
@@ -9293,7 +9385,7 @@ await client.resourceServers.update("id");
|
|
|
9293
9385
|
<dl>
|
|
9294
9386
|
<dd>
|
|
9295
9387
|
|
|
9296
|
-
Retrieve
|
|
9388
|
+
Retrieve a list of roles. Includes roles created in your tenant and, when `owner_id=auth0` is supplied, Auth0-managed System Roles.
|
|
9297
9389
|
|
|
9298
9390
|
**Note**: The returned list does not include standard roles available for tenant members, such as Admin or Support Access.
|
|
9299
9391
|
|
|
@@ -14843,9 +14935,9 @@ await client.attackProtection.captcha.update();
|
|
|
14843
14935
|
</dl>
|
|
14844
14936
|
</details>
|
|
14845
14937
|
|
|
14846
|
-
## AttackProtection
|
|
14938
|
+
## AttackProtection CaptchaPolicies
|
|
14847
14939
|
|
|
14848
|
-
<details><summary><code>client.attackProtection.
|
|
14940
|
+
<details><summary><code>client.attackProtection.captchaPolicies.<a href="/src/management/api/resources/attackProtection/resources/captchaPolicies/client/Client.ts">list</a>() -> Management.ListAttackProtectionCaptchaPoliciesResponseContent</code></summary>
|
|
14849
14941
|
<dl>
|
|
14850
14942
|
<dd>
|
|
14851
14943
|
|
|
@@ -14857,7 +14949,7 @@ await client.attackProtection.captcha.update();
|
|
|
14857
14949
|
<dl>
|
|
14858
14950
|
<dd>
|
|
14859
14951
|
|
|
14860
|
-
|
|
14952
|
+
Retrieve all CAPTCHA attack protection policies for the tenant, sorted by priority ascending.
|
|
14861
14953
|
|
|
14862
14954
|
</dd>
|
|
14863
14955
|
</dl>
|
|
@@ -14873,7 +14965,7 @@ Get the phone provider protection configuration for a tenant.
|
|
|
14873
14965
|
<dd>
|
|
14874
14966
|
|
|
14875
14967
|
```typescript
|
|
14876
|
-
await client.attackProtection.
|
|
14968
|
+
await client.attackProtection.captchaPolicies.list();
|
|
14877
14969
|
```
|
|
14878
14970
|
|
|
14879
14971
|
</dd>
|
|
@@ -14889,7 +14981,7 @@ await client.attackProtection.phoneProviderProtection.get();
|
|
|
14889
14981
|
<dl>
|
|
14890
14982
|
<dd>
|
|
14891
14983
|
|
|
14892
|
-
**requestOptions:** `
|
|
14984
|
+
**requestOptions:** `CaptchaPoliciesClient.RequestOptions`
|
|
14893
14985
|
|
|
14894
14986
|
</dd>
|
|
14895
14987
|
</dl>
|
|
@@ -14900,7 +14992,7 @@ await client.attackProtection.phoneProviderProtection.get();
|
|
|
14900
14992
|
</dl>
|
|
14901
14993
|
</details>
|
|
14902
14994
|
|
|
14903
|
-
<details><summary><code>client.attackProtection.
|
|
14995
|
+
<details><summary><code>client.attackProtection.captchaPolicies.<a href="/src/management/api/resources/attackProtection/resources/captchaPolicies/client/Client.ts">create</a>({ ...params }) -> Management.AttackProtectionCaptchaPolicy</code></summary>
|
|
14904
14996
|
<dl>
|
|
14905
14997
|
<dd>
|
|
14906
14998
|
|
|
@@ -14912,7 +15004,7 @@ await client.attackProtection.phoneProviderProtection.get();
|
|
|
14912
15004
|
<dl>
|
|
14913
15005
|
<dd>
|
|
14914
15006
|
|
|
14915
|
-
|
|
15007
|
+
Create a new CAPTCHA attack protection policy for the tenant. The maximum number of policies per tenant is determined by the tenant's subscription.
|
|
14916
15008
|
|
|
14917
15009
|
</dd>
|
|
14918
15010
|
</dl>
|
|
@@ -14928,8 +15020,11 @@ Update the phone provider protection configuration for a tenant.
|
|
|
14928
15020
|
<dd>
|
|
14929
15021
|
|
|
14930
15022
|
```typescript
|
|
14931
|
-
await client.attackProtection.
|
|
14932
|
-
|
|
15023
|
+
await client.attackProtection.captchaPolicies.create({
|
|
15024
|
+
name: "name",
|
|
15025
|
+
priority: 1,
|
|
15026
|
+
match: {},
|
|
15027
|
+
action: {},
|
|
14933
15028
|
});
|
|
14934
15029
|
```
|
|
14935
15030
|
|
|
@@ -14946,7 +15041,7 @@ await client.attackProtection.phoneProviderProtection.patch({
|
|
|
14946
15041
|
<dl>
|
|
14947
15042
|
<dd>
|
|
14948
15043
|
|
|
14949
|
-
**request:** `Management.
|
|
15044
|
+
**request:** `Management.CreateAttackProtectionCaptchaPolicyRequestContent`
|
|
14950
15045
|
|
|
14951
15046
|
</dd>
|
|
14952
15047
|
</dl>
|
|
@@ -14954,7 +15049,7 @@ await client.attackProtection.phoneProviderProtection.patch({
|
|
|
14954
15049
|
<dl>
|
|
14955
15050
|
<dd>
|
|
14956
15051
|
|
|
14957
|
-
**requestOptions:** `
|
|
15052
|
+
**requestOptions:** `CaptchaPoliciesClient.RequestOptions`
|
|
14958
15053
|
|
|
14959
15054
|
</dd>
|
|
14960
15055
|
</dl>
|
|
@@ -14965,9 +15060,7 @@ await client.attackProtection.phoneProviderProtection.patch({
|
|
|
14965
15060
|
</dl>
|
|
14966
15061
|
</details>
|
|
14967
15062
|
|
|
14968
|
-
|
|
14969
|
-
|
|
14970
|
-
<details><summary><code>client.attackProtection.suspiciousIpThrottling.<a href="/src/management/api/resources/attackProtection/resources/suspiciousIpThrottling/client/Client.ts">get</a>() -> Management.GetSuspiciousIpThrottlingSettingsResponseContent</code></summary>
|
|
15063
|
+
<details><summary><code>client.attackProtection.captchaPolicies.<a href="/src/management/api/resources/attackProtection/resources/captchaPolicies/client/Client.ts">get</a>(id) -> Management.AttackProtectionCaptchaPolicy</code></summary>
|
|
14971
15064
|
<dl>
|
|
14972
15065
|
<dd>
|
|
14973
15066
|
|
|
@@ -14979,7 +15072,7 @@ await client.attackProtection.phoneProviderProtection.patch({
|
|
|
14979
15072
|
<dl>
|
|
14980
15073
|
<dd>
|
|
14981
15074
|
|
|
14982
|
-
Retrieve
|
|
15075
|
+
Retrieve a single CAPTCHA attack protection policy for the tenant by ID.
|
|
14983
15076
|
|
|
14984
15077
|
</dd>
|
|
14985
15078
|
</dl>
|
|
@@ -14995,7 +15088,7 @@ Retrieve details of the Suspicious IP Throttling configuration of your tenant.
|
|
|
14995
15088
|
<dd>
|
|
14996
15089
|
|
|
14997
15090
|
```typescript
|
|
14998
|
-
await client.attackProtection.
|
|
15091
|
+
await client.attackProtection.captchaPolicies.get("id");
|
|
14999
15092
|
```
|
|
15000
15093
|
|
|
15001
15094
|
</dd>
|
|
@@ -15011,7 +15104,15 @@ await client.attackProtection.suspiciousIpThrottling.get();
|
|
|
15011
15104
|
<dl>
|
|
15012
15105
|
<dd>
|
|
15013
15106
|
|
|
15014
|
-
**
|
|
15107
|
+
**id:** `string` — ID of the CAPTCHA attack protection policy.
|
|
15108
|
+
|
|
15109
|
+
</dd>
|
|
15110
|
+
</dl>
|
|
15111
|
+
|
|
15112
|
+
<dl>
|
|
15113
|
+
<dd>
|
|
15114
|
+
|
|
15115
|
+
**requestOptions:** `CaptchaPoliciesClient.RequestOptions`
|
|
15015
15116
|
|
|
15016
15117
|
</dd>
|
|
15017
15118
|
</dl>
|
|
@@ -15022,7 +15123,7 @@ await client.attackProtection.suspiciousIpThrottling.get();
|
|
|
15022
15123
|
</dl>
|
|
15023
15124
|
</details>
|
|
15024
15125
|
|
|
15025
|
-
<details><summary><code>client.attackProtection.
|
|
15126
|
+
<details><summary><code>client.attackProtection.captchaPolicies.<a href="/src/management/api/resources/attackProtection/resources/captchaPolicies/client/Client.ts">delete</a>(id) -> void</code></summary>
|
|
15026
15127
|
<dl>
|
|
15027
15128
|
<dd>
|
|
15028
15129
|
|
|
@@ -15034,7 +15135,7 @@ await client.attackProtection.suspiciousIpThrottling.get();
|
|
|
15034
15135
|
<dl>
|
|
15035
15136
|
<dd>
|
|
15036
15137
|
|
|
15037
|
-
|
|
15138
|
+
Delete a CAPTCHA attack protection policy for the tenant.
|
|
15038
15139
|
|
|
15039
15140
|
</dd>
|
|
15040
15141
|
</dl>
|
|
@@ -15050,7 +15151,7 @@ Update the details of the Suspicious IP Throttling configuration of your tenant.
|
|
|
15050
15151
|
<dd>
|
|
15051
15152
|
|
|
15052
15153
|
```typescript
|
|
15053
|
-
await client.attackProtection.
|
|
15154
|
+
await client.attackProtection.captchaPolicies.delete("id");
|
|
15054
15155
|
```
|
|
15055
15156
|
|
|
15056
15157
|
</dd>
|
|
@@ -15066,7 +15167,7 @@ await client.attackProtection.suspiciousIpThrottling.update();
|
|
|
15066
15167
|
<dl>
|
|
15067
15168
|
<dd>
|
|
15068
15169
|
|
|
15069
|
-
**
|
|
15170
|
+
**id:** `string` — ID of the CAPTCHA attack protection policy.
|
|
15070
15171
|
|
|
15071
15172
|
</dd>
|
|
15072
15173
|
</dl>
|
|
@@ -15074,7 +15175,7 @@ await client.attackProtection.suspiciousIpThrottling.update();
|
|
|
15074
15175
|
<dl>
|
|
15075
15176
|
<dd>
|
|
15076
15177
|
|
|
15077
|
-
**requestOptions:** `
|
|
15178
|
+
**requestOptions:** `CaptchaPoliciesClient.RequestOptions`
|
|
15078
15179
|
|
|
15079
15180
|
</dd>
|
|
15080
15181
|
</dl>
|
|
@@ -15085,12 +15186,25 @@ await client.attackProtection.suspiciousIpThrottling.update();
|
|
|
15085
15186
|
</dl>
|
|
15086
15187
|
</details>
|
|
15087
15188
|
|
|
15088
|
-
|
|
15189
|
+
<details><summary><code>client.attackProtection.captchaPolicies.<a href="/src/management/api/resources/attackProtection/resources/captchaPolicies/client/Client.ts">update</a>(id, { ...params }) -> Management.AttackProtectionCaptchaPolicy</code></summary>
|
|
15190
|
+
<dl>
|
|
15191
|
+
<dd>
|
|
15192
|
+
|
|
15193
|
+
#### 📝 Description
|
|
15194
|
+
|
|
15195
|
+
<dl>
|
|
15196
|
+
<dd>
|
|
15089
15197
|
|
|
15090
|
-
<details><summary><code>client.branding.templates.<a href="/src/management/api/resources/branding/resources/templates/client/Client.ts">getUniversalLogin</a>() -> Management.GetUniversalLoginTemplateResponseContent</code></summary>
|
|
15091
15198
|
<dl>
|
|
15092
15199
|
<dd>
|
|
15093
15200
|
|
|
15201
|
+
Partially update a CAPTCHA attack protection policy. Only the provided fields are modified. A provided match or action replaces the stored value in full rather than merging with it; within action, a provider secret or API key that is omitted from a provided provider block keeps its stored value.
|
|
15202
|
+
|
|
15203
|
+
</dd>
|
|
15204
|
+
</dl>
|
|
15205
|
+
</dd>
|
|
15206
|
+
</dl>
|
|
15207
|
+
|
|
15094
15208
|
#### 🔌 Usage
|
|
15095
15209
|
|
|
15096
15210
|
<dl>
|
|
@@ -15100,7 +15214,7 @@ await client.attackProtection.suspiciousIpThrottling.update();
|
|
|
15100
15214
|
<dd>
|
|
15101
15215
|
|
|
15102
15216
|
```typescript
|
|
15103
|
-
await client.
|
|
15217
|
+
await client.attackProtection.captchaPolicies.update("id");
|
|
15104
15218
|
```
|
|
15105
15219
|
|
|
15106
15220
|
</dd>
|
|
@@ -15116,7 +15230,23 @@ await client.branding.templates.getUniversalLogin();
|
|
|
15116
15230
|
<dl>
|
|
15117
15231
|
<dd>
|
|
15118
15232
|
|
|
15119
|
-
**
|
|
15233
|
+
**id:** `string` — ID of the CAPTCHA attack protection policy.
|
|
15234
|
+
|
|
15235
|
+
</dd>
|
|
15236
|
+
</dl>
|
|
15237
|
+
|
|
15238
|
+
<dl>
|
|
15239
|
+
<dd>
|
|
15240
|
+
|
|
15241
|
+
**request:** `Management.UpdateAttackProtectionCaptchaPolicyRequestContent`
|
|
15242
|
+
|
|
15243
|
+
</dd>
|
|
15244
|
+
</dl>
|
|
15245
|
+
|
|
15246
|
+
<dl>
|
|
15247
|
+
<dd>
|
|
15248
|
+
|
|
15249
|
+
**requestOptions:** `CaptchaPoliciesClient.RequestOptions`
|
|
15120
15250
|
|
|
15121
15251
|
</dd>
|
|
15122
15252
|
</dl>
|
|
@@ -15127,7 +15257,9 @@ await client.branding.templates.getUniversalLogin();
|
|
|
15127
15257
|
</dl>
|
|
15128
15258
|
</details>
|
|
15129
15259
|
|
|
15130
|
-
|
|
15260
|
+
## AttackProtection PhoneProviderProtection
|
|
15261
|
+
|
|
15262
|
+
<details><summary><code>client.attackProtection.phoneProviderProtection.<a href="/src/management/api/resources/attackProtection/resources/phoneProviderProtection/client/Client.ts">get</a>() -> Management.GetPhoneProviderProtectionResponseContent</code></summary>
|
|
15131
15263
|
<dl>
|
|
15132
15264
|
<dd>
|
|
15133
15265
|
|
|
@@ -15139,30 +15271,7 @@ await client.branding.templates.getUniversalLogin();
|
|
|
15139
15271
|
<dl>
|
|
15140
15272
|
<dd>
|
|
15141
15273
|
|
|
15142
|
-
|
|
15143
|
-
|
|
15144
|
-
When `content-type` header is set to `application/json`:
|
|
15145
|
-
|
|
15146
|
-
```json
|
|
15147
|
-
{
|
|
15148
|
-
"template": "<!DOCTYPE html>{% assign resolved_dir = dir | default: \"auto\" %}<html lang=\"{{locale}}\" dir=\"{{resolved_dir}}\"><head>{%- auth0:head -%}</head><body class=\"_widget-auto-layout\">{%- auth0:widget -%}</body></html>"
|
|
15149
|
-
}
|
|
15150
|
-
```
|
|
15151
|
-
|
|
15152
|
-
When `content-type` header is set to `text/html`:
|
|
15153
|
-
|
|
15154
|
-
```html
|
|
15155
|
-
<!DOCTYPE html>
|
|
15156
|
-
{% assign resolved_dir = dir | default: "auto" %}
|
|
15157
|
-
<html lang="{{locale}}" dir="{{resolved_dir}}">
|
|
15158
|
-
<head>
|
|
15159
|
-
{%- auth0:head -%}
|
|
15160
|
-
</head>
|
|
15161
|
-
<body class="_widget-auto-layout">
|
|
15162
|
-
{%- auth0:widget -%}
|
|
15163
|
-
</body>
|
|
15164
|
-
</html>
|
|
15165
|
-
```
|
|
15274
|
+
Get the phone provider protection configuration for a tenant.
|
|
15166
15275
|
|
|
15167
15276
|
</dd>
|
|
15168
15277
|
</dl>
|
|
@@ -15178,7 +15287,7 @@ When `content-type` header is set to `text/html`:
|
|
|
15178
15287
|
<dd>
|
|
15179
15288
|
|
|
15180
15289
|
```typescript
|
|
15181
|
-
await client.
|
|
15290
|
+
await client.attackProtection.phoneProviderProtection.get();
|
|
15182
15291
|
```
|
|
15183
15292
|
|
|
15184
15293
|
</dd>
|
|
@@ -15194,15 +15303,7 @@ await client.branding.templates.updateUniversalLogin("string");
|
|
|
15194
15303
|
<dl>
|
|
15195
15304
|
<dd>
|
|
15196
15305
|
|
|
15197
|
-
**
|
|
15198
|
-
|
|
15199
|
-
</dd>
|
|
15200
|
-
</dl>
|
|
15201
|
-
|
|
15202
|
-
<dl>
|
|
15203
|
-
<dd>
|
|
15204
|
-
|
|
15205
|
-
**requestOptions:** `TemplatesClient.RequestOptions`
|
|
15306
|
+
**requestOptions:** `PhoneProviderProtectionClient.RequestOptions`
|
|
15206
15307
|
|
|
15207
15308
|
</dd>
|
|
15208
15309
|
</dl>
|
|
@@ -15213,10 +15314,25 @@ await client.branding.templates.updateUniversalLogin("string");
|
|
|
15213
15314
|
</dl>
|
|
15214
15315
|
</details>
|
|
15215
15316
|
|
|
15216
|
-
<details><summary><code>client.
|
|
15317
|
+
<details><summary><code>client.attackProtection.phoneProviderProtection.<a href="/src/management/api/resources/attackProtection/resources/phoneProviderProtection/client/Client.ts">patch</a>({ ...params }) -> Management.PatchPhoneProviderProtectionResponseContent</code></summary>
|
|
15318
|
+
<dl>
|
|
15319
|
+
<dd>
|
|
15320
|
+
|
|
15321
|
+
#### 📝 Description
|
|
15322
|
+
|
|
15323
|
+
<dl>
|
|
15324
|
+
<dd>
|
|
15325
|
+
|
|
15217
15326
|
<dl>
|
|
15218
15327
|
<dd>
|
|
15219
15328
|
|
|
15329
|
+
Update the phone provider protection configuration for a tenant.
|
|
15330
|
+
|
|
15331
|
+
</dd>
|
|
15332
|
+
</dl>
|
|
15333
|
+
</dd>
|
|
15334
|
+
</dl>
|
|
15335
|
+
|
|
15220
15336
|
#### 🔌 Usage
|
|
15221
15337
|
|
|
15222
15338
|
<dl>
|
|
@@ -15226,7 +15342,9 @@ await client.branding.templates.updateUniversalLogin("string");
|
|
|
15226
15342
|
<dd>
|
|
15227
15343
|
|
|
15228
15344
|
```typescript
|
|
15229
|
-
await client.
|
|
15345
|
+
await client.attackProtection.phoneProviderProtection.patch({
|
|
15346
|
+
type: "exponential",
|
|
15347
|
+
});
|
|
15230
15348
|
```
|
|
15231
15349
|
|
|
15232
15350
|
</dd>
|
|
@@ -15242,7 +15360,15 @@ await client.branding.templates.deleteUniversalLogin();
|
|
|
15242
15360
|
<dl>
|
|
15243
15361
|
<dd>
|
|
15244
15362
|
|
|
15245
|
-
**
|
|
15363
|
+
**request:** `Management.PatchPhoneProviderProtectionRequestContent`
|
|
15364
|
+
|
|
15365
|
+
</dd>
|
|
15366
|
+
</dl>
|
|
15367
|
+
|
|
15368
|
+
<dl>
|
|
15369
|
+
<dd>
|
|
15370
|
+
|
|
15371
|
+
**requestOptions:** `PhoneProviderProtectionClient.RequestOptions`
|
|
15246
15372
|
|
|
15247
15373
|
</dd>
|
|
15248
15374
|
</dl>
|
|
@@ -15253,9 +15379,9 @@ await client.branding.templates.deleteUniversalLogin();
|
|
|
15253
15379
|
</dl>
|
|
15254
15380
|
</details>
|
|
15255
15381
|
|
|
15256
|
-
##
|
|
15382
|
+
## AttackProtection SuspiciousIpThrottling
|
|
15257
15383
|
|
|
15258
|
-
<details><summary><code>client.
|
|
15384
|
+
<details><summary><code>client.attackProtection.suspiciousIpThrottling.<a href="/src/management/api/resources/attackProtection/resources/suspiciousIpThrottling/client/Client.ts">get</a>() -> Management.GetSuspiciousIpThrottlingSettingsResponseContent</code></summary>
|
|
15259
15385
|
<dl>
|
|
15260
15386
|
<dd>
|
|
15261
15387
|
|
|
@@ -15267,7 +15393,7 @@ await client.branding.templates.deleteUniversalLogin();
|
|
|
15267
15393
|
<dl>
|
|
15268
15394
|
<dd>
|
|
15269
15395
|
|
|
15270
|
-
|
|
15396
|
+
Retrieve details of the Suspicious IP Throttling configuration of your tenant.
|
|
15271
15397
|
|
|
15272
15398
|
</dd>
|
|
15273
15399
|
</dl>
|
|
@@ -15283,38 +15409,326 @@ Create branding theme.
|
|
|
15283
15409
|
<dd>
|
|
15284
15410
|
|
|
15285
15411
|
```typescript
|
|
15286
|
-
await client.
|
|
15287
|
-
|
|
15288
|
-
|
|
15289
|
-
|
|
15290
|
-
|
|
15291
|
-
|
|
15292
|
-
|
|
15293
|
-
|
|
15294
|
-
|
|
15295
|
-
|
|
15296
|
-
|
|
15297
|
-
|
|
15298
|
-
|
|
15299
|
-
|
|
15300
|
-
|
|
15301
|
-
|
|
15302
|
-
|
|
15303
|
-
|
|
15304
|
-
|
|
15305
|
-
|
|
15306
|
-
|
|
15307
|
-
|
|
15308
|
-
|
|
15309
|
-
|
|
15310
|
-
|
|
15311
|
-
|
|
15312
|
-
|
|
15313
|
-
|
|
15314
|
-
|
|
15315
|
-
|
|
15316
|
-
|
|
15317
|
-
|
|
15412
|
+
await client.attackProtection.suspiciousIpThrottling.get();
|
|
15413
|
+
```
|
|
15414
|
+
|
|
15415
|
+
</dd>
|
|
15416
|
+
</dl>
|
|
15417
|
+
</dd>
|
|
15418
|
+
</dl>
|
|
15419
|
+
|
|
15420
|
+
#### ⚙️ Parameters
|
|
15421
|
+
|
|
15422
|
+
<dl>
|
|
15423
|
+
<dd>
|
|
15424
|
+
|
|
15425
|
+
<dl>
|
|
15426
|
+
<dd>
|
|
15427
|
+
|
|
15428
|
+
**requestOptions:** `SuspiciousIpThrottlingClient.RequestOptions`
|
|
15429
|
+
|
|
15430
|
+
</dd>
|
|
15431
|
+
</dl>
|
|
15432
|
+
</dd>
|
|
15433
|
+
</dl>
|
|
15434
|
+
|
|
15435
|
+
</dd>
|
|
15436
|
+
</dl>
|
|
15437
|
+
</details>
|
|
15438
|
+
|
|
15439
|
+
<details><summary><code>client.attackProtection.suspiciousIpThrottling.<a href="/src/management/api/resources/attackProtection/resources/suspiciousIpThrottling/client/Client.ts">update</a>({ ...params }) -> Management.UpdateSuspiciousIpThrottlingSettingsResponseContent</code></summary>
|
|
15440
|
+
<dl>
|
|
15441
|
+
<dd>
|
|
15442
|
+
|
|
15443
|
+
#### 📝 Description
|
|
15444
|
+
|
|
15445
|
+
<dl>
|
|
15446
|
+
<dd>
|
|
15447
|
+
|
|
15448
|
+
<dl>
|
|
15449
|
+
<dd>
|
|
15450
|
+
|
|
15451
|
+
Update the details of the Suspicious IP Throttling configuration of your tenant.
|
|
15452
|
+
|
|
15453
|
+
</dd>
|
|
15454
|
+
</dl>
|
|
15455
|
+
</dd>
|
|
15456
|
+
</dl>
|
|
15457
|
+
|
|
15458
|
+
#### 🔌 Usage
|
|
15459
|
+
|
|
15460
|
+
<dl>
|
|
15461
|
+
<dd>
|
|
15462
|
+
|
|
15463
|
+
<dl>
|
|
15464
|
+
<dd>
|
|
15465
|
+
|
|
15466
|
+
```typescript
|
|
15467
|
+
await client.attackProtection.suspiciousIpThrottling.update();
|
|
15468
|
+
```
|
|
15469
|
+
|
|
15470
|
+
</dd>
|
|
15471
|
+
</dl>
|
|
15472
|
+
</dd>
|
|
15473
|
+
</dl>
|
|
15474
|
+
|
|
15475
|
+
#### ⚙️ Parameters
|
|
15476
|
+
|
|
15477
|
+
<dl>
|
|
15478
|
+
<dd>
|
|
15479
|
+
|
|
15480
|
+
<dl>
|
|
15481
|
+
<dd>
|
|
15482
|
+
|
|
15483
|
+
**request:** `Management.UpdateSuspiciousIpThrottlingSettingsRequestContent`
|
|
15484
|
+
|
|
15485
|
+
</dd>
|
|
15486
|
+
</dl>
|
|
15487
|
+
|
|
15488
|
+
<dl>
|
|
15489
|
+
<dd>
|
|
15490
|
+
|
|
15491
|
+
**requestOptions:** `SuspiciousIpThrottlingClient.RequestOptions`
|
|
15492
|
+
|
|
15493
|
+
</dd>
|
|
15494
|
+
</dl>
|
|
15495
|
+
</dd>
|
|
15496
|
+
</dl>
|
|
15497
|
+
|
|
15498
|
+
</dd>
|
|
15499
|
+
</dl>
|
|
15500
|
+
</details>
|
|
15501
|
+
|
|
15502
|
+
## Branding Templates
|
|
15503
|
+
|
|
15504
|
+
<details><summary><code>client.branding.templates.<a href="/src/management/api/resources/branding/resources/templates/client/Client.ts">getUniversalLogin</a>() -> Management.GetUniversalLoginTemplateResponseContent</code></summary>
|
|
15505
|
+
<dl>
|
|
15506
|
+
<dd>
|
|
15507
|
+
|
|
15508
|
+
#### 🔌 Usage
|
|
15509
|
+
|
|
15510
|
+
<dl>
|
|
15511
|
+
<dd>
|
|
15512
|
+
|
|
15513
|
+
<dl>
|
|
15514
|
+
<dd>
|
|
15515
|
+
|
|
15516
|
+
```typescript
|
|
15517
|
+
await client.branding.templates.getUniversalLogin();
|
|
15518
|
+
```
|
|
15519
|
+
|
|
15520
|
+
</dd>
|
|
15521
|
+
</dl>
|
|
15522
|
+
</dd>
|
|
15523
|
+
</dl>
|
|
15524
|
+
|
|
15525
|
+
#### ⚙️ Parameters
|
|
15526
|
+
|
|
15527
|
+
<dl>
|
|
15528
|
+
<dd>
|
|
15529
|
+
|
|
15530
|
+
<dl>
|
|
15531
|
+
<dd>
|
|
15532
|
+
|
|
15533
|
+
**requestOptions:** `TemplatesClient.RequestOptions`
|
|
15534
|
+
|
|
15535
|
+
</dd>
|
|
15536
|
+
</dl>
|
|
15537
|
+
</dd>
|
|
15538
|
+
</dl>
|
|
15539
|
+
|
|
15540
|
+
</dd>
|
|
15541
|
+
</dl>
|
|
15542
|
+
</details>
|
|
15543
|
+
|
|
15544
|
+
<details><summary><code>client.branding.templates.<a href="/src/management/api/resources/branding/resources/templates/client/Client.ts">updateUniversalLogin</a>({ ...params }) -> void</code></summary>
|
|
15545
|
+
<dl>
|
|
15546
|
+
<dd>
|
|
15547
|
+
|
|
15548
|
+
#### 📝 Description
|
|
15549
|
+
|
|
15550
|
+
<dl>
|
|
15551
|
+
<dd>
|
|
15552
|
+
|
|
15553
|
+
<dl>
|
|
15554
|
+
<dd>
|
|
15555
|
+
|
|
15556
|
+
Update the Universal Login branding template.
|
|
15557
|
+
|
|
15558
|
+
When `content-type` header is set to `application/json`:
|
|
15559
|
+
|
|
15560
|
+
```json
|
|
15561
|
+
{
|
|
15562
|
+
"template": "<!DOCTYPE html>{% assign resolved_dir = dir | default: \"auto\" %}<html lang=\"{{locale}}\" dir=\"{{resolved_dir}}\"><head>{%- auth0:head -%}</head><body class=\"_widget-auto-layout\">{%- auth0:widget -%}</body></html>"
|
|
15563
|
+
}
|
|
15564
|
+
```
|
|
15565
|
+
|
|
15566
|
+
When `content-type` header is set to `text/html`:
|
|
15567
|
+
|
|
15568
|
+
```html
|
|
15569
|
+
<!DOCTYPE html>
|
|
15570
|
+
{% assign resolved_dir = dir | default: "auto" %}
|
|
15571
|
+
<html lang="{{locale}}" dir="{{resolved_dir}}">
|
|
15572
|
+
<head>
|
|
15573
|
+
{%- auth0:head -%}
|
|
15574
|
+
</head>
|
|
15575
|
+
<body class="_widget-auto-layout">
|
|
15576
|
+
{%- auth0:widget -%}
|
|
15577
|
+
</body>
|
|
15578
|
+
</html>
|
|
15579
|
+
```
|
|
15580
|
+
|
|
15581
|
+
</dd>
|
|
15582
|
+
</dl>
|
|
15583
|
+
</dd>
|
|
15584
|
+
</dl>
|
|
15585
|
+
|
|
15586
|
+
#### 🔌 Usage
|
|
15587
|
+
|
|
15588
|
+
<dl>
|
|
15589
|
+
<dd>
|
|
15590
|
+
|
|
15591
|
+
<dl>
|
|
15592
|
+
<dd>
|
|
15593
|
+
|
|
15594
|
+
```typescript
|
|
15595
|
+
await client.branding.templates.updateUniversalLogin("string");
|
|
15596
|
+
```
|
|
15597
|
+
|
|
15598
|
+
</dd>
|
|
15599
|
+
</dl>
|
|
15600
|
+
</dd>
|
|
15601
|
+
</dl>
|
|
15602
|
+
|
|
15603
|
+
#### ⚙️ Parameters
|
|
15604
|
+
|
|
15605
|
+
<dl>
|
|
15606
|
+
<dd>
|
|
15607
|
+
|
|
15608
|
+
<dl>
|
|
15609
|
+
<dd>
|
|
15610
|
+
|
|
15611
|
+
**request:** `Management.UpdateUniversalLoginTemplateRequestContent`
|
|
15612
|
+
|
|
15613
|
+
</dd>
|
|
15614
|
+
</dl>
|
|
15615
|
+
|
|
15616
|
+
<dl>
|
|
15617
|
+
<dd>
|
|
15618
|
+
|
|
15619
|
+
**requestOptions:** `TemplatesClient.RequestOptions`
|
|
15620
|
+
|
|
15621
|
+
</dd>
|
|
15622
|
+
</dl>
|
|
15623
|
+
</dd>
|
|
15624
|
+
</dl>
|
|
15625
|
+
|
|
15626
|
+
</dd>
|
|
15627
|
+
</dl>
|
|
15628
|
+
</details>
|
|
15629
|
+
|
|
15630
|
+
<details><summary><code>client.branding.templates.<a href="/src/management/api/resources/branding/resources/templates/client/Client.ts">deleteUniversalLogin</a>() -> void</code></summary>
|
|
15631
|
+
<dl>
|
|
15632
|
+
<dd>
|
|
15633
|
+
|
|
15634
|
+
#### 🔌 Usage
|
|
15635
|
+
|
|
15636
|
+
<dl>
|
|
15637
|
+
<dd>
|
|
15638
|
+
|
|
15639
|
+
<dl>
|
|
15640
|
+
<dd>
|
|
15641
|
+
|
|
15642
|
+
```typescript
|
|
15643
|
+
await client.branding.templates.deleteUniversalLogin();
|
|
15644
|
+
```
|
|
15645
|
+
|
|
15646
|
+
</dd>
|
|
15647
|
+
</dl>
|
|
15648
|
+
</dd>
|
|
15649
|
+
</dl>
|
|
15650
|
+
|
|
15651
|
+
#### ⚙️ Parameters
|
|
15652
|
+
|
|
15653
|
+
<dl>
|
|
15654
|
+
<dd>
|
|
15655
|
+
|
|
15656
|
+
<dl>
|
|
15657
|
+
<dd>
|
|
15658
|
+
|
|
15659
|
+
**requestOptions:** `TemplatesClient.RequestOptions`
|
|
15660
|
+
|
|
15661
|
+
</dd>
|
|
15662
|
+
</dl>
|
|
15663
|
+
</dd>
|
|
15664
|
+
</dl>
|
|
15665
|
+
|
|
15666
|
+
</dd>
|
|
15667
|
+
</dl>
|
|
15668
|
+
</details>
|
|
15669
|
+
|
|
15670
|
+
## Branding Themes
|
|
15671
|
+
|
|
15672
|
+
<details><summary><code>client.branding.themes.<a href="/src/management/api/resources/branding/resources/themes/client/Client.ts">create</a>({ ...params }) -> Management.CreateBrandingThemeResponseContent</code></summary>
|
|
15673
|
+
<dl>
|
|
15674
|
+
<dd>
|
|
15675
|
+
|
|
15676
|
+
#### 📝 Description
|
|
15677
|
+
|
|
15678
|
+
<dl>
|
|
15679
|
+
<dd>
|
|
15680
|
+
|
|
15681
|
+
<dl>
|
|
15682
|
+
<dd>
|
|
15683
|
+
|
|
15684
|
+
Create branding theme.
|
|
15685
|
+
|
|
15686
|
+
</dd>
|
|
15687
|
+
</dl>
|
|
15688
|
+
</dd>
|
|
15689
|
+
</dl>
|
|
15690
|
+
|
|
15691
|
+
#### 🔌 Usage
|
|
15692
|
+
|
|
15693
|
+
<dl>
|
|
15694
|
+
<dd>
|
|
15695
|
+
|
|
15696
|
+
<dl>
|
|
15697
|
+
<dd>
|
|
15698
|
+
|
|
15699
|
+
```typescript
|
|
15700
|
+
await client.branding.themes.create({
|
|
15701
|
+
borders: {
|
|
15702
|
+
button_border_radius: 1.1,
|
|
15703
|
+
button_border_weight: 1.1,
|
|
15704
|
+
buttons_style: "pill",
|
|
15705
|
+
input_border_radius: 1.1,
|
|
15706
|
+
input_border_weight: 1.1,
|
|
15707
|
+
inputs_style: "pill",
|
|
15708
|
+
show_widget_shadow: true,
|
|
15709
|
+
widget_border_weight: 1.1,
|
|
15710
|
+
widget_corner_radius: 1.1,
|
|
15711
|
+
},
|
|
15712
|
+
colors: {
|
|
15713
|
+
body_text: "body_text",
|
|
15714
|
+
error: "error",
|
|
15715
|
+
header: "header",
|
|
15716
|
+
icons: "icons",
|
|
15717
|
+
input_background: "input_background",
|
|
15718
|
+
input_border: "input_border",
|
|
15719
|
+
input_filled_text: "input_filled_text",
|
|
15720
|
+
input_labels_placeholders: "input_labels_placeholders",
|
|
15721
|
+
links_focused_components: "links_focused_components",
|
|
15722
|
+
primary_button: "primary_button",
|
|
15723
|
+
primary_button_label: "primary_button_label",
|
|
15724
|
+
secondary_button_border: "secondary_button_border",
|
|
15725
|
+
secondary_button_label: "secondary_button_label",
|
|
15726
|
+
success: "success",
|
|
15727
|
+
widget_background: "widget_background",
|
|
15728
|
+
widget_border: "widget_border",
|
|
15729
|
+
},
|
|
15730
|
+
fonts: {
|
|
15731
|
+
body_text: {
|
|
15318
15732
|
bold: true,
|
|
15319
15733
|
size: 1.1,
|
|
15320
15734
|
},
|
|
@@ -19907,79 +20321,6 @@ await client.experimentation.experiments.advanceRamp("id", {
|
|
|
19907
20321
|
</dl>
|
|
19908
20322
|
</details>
|
|
19909
20323
|
|
|
19910
|
-
<details><summary><code>client.experimentation.experiments.<a href="/src/management/api/resources/experimentation/resources/experiments/client/Client.ts">updateStatus</a>(id, { ...params }) -> Management.UpdateExperimentStatusResponseContent</code></summary>
|
|
19911
|
-
<dl>
|
|
19912
|
-
<dd>
|
|
19913
|
-
|
|
19914
|
-
#### 📝 Description
|
|
19915
|
-
|
|
19916
|
-
<dl>
|
|
19917
|
-
<dd>
|
|
19918
|
-
|
|
19919
|
-
<dl>
|
|
19920
|
-
<dd>
|
|
19921
|
-
|
|
19922
|
-
Transitions an experiment through its lifecycle: draft → active, active → paused, paused → active, active/paused → completed. Activation runs full readiness validation.
|
|
19923
|
-
|
|
19924
|
-
</dd>
|
|
19925
|
-
</dl>
|
|
19926
|
-
</dd>
|
|
19927
|
-
</dl>
|
|
19928
|
-
|
|
19929
|
-
#### 🔌 Usage
|
|
19930
|
-
|
|
19931
|
-
<dl>
|
|
19932
|
-
<dd>
|
|
19933
|
-
|
|
19934
|
-
<dl>
|
|
19935
|
-
<dd>
|
|
19936
|
-
|
|
19937
|
-
```typescript
|
|
19938
|
-
await client.experimentation.experiments.updateStatus("id", {
|
|
19939
|
-
status: "active",
|
|
19940
|
-
});
|
|
19941
|
-
```
|
|
19942
|
-
|
|
19943
|
-
</dd>
|
|
19944
|
-
</dl>
|
|
19945
|
-
</dd>
|
|
19946
|
-
</dl>
|
|
19947
|
-
|
|
19948
|
-
#### ⚙️ Parameters
|
|
19949
|
-
|
|
19950
|
-
<dl>
|
|
19951
|
-
<dd>
|
|
19952
|
-
|
|
19953
|
-
<dl>
|
|
19954
|
-
<dd>
|
|
19955
|
-
|
|
19956
|
-
**id:** `string` — The ID of the experiment to transition.
|
|
19957
|
-
|
|
19958
|
-
</dd>
|
|
19959
|
-
</dl>
|
|
19960
|
-
|
|
19961
|
-
<dl>
|
|
19962
|
-
<dd>
|
|
19963
|
-
|
|
19964
|
-
**request:** `Management.UpdateExperimentStatusRequestContent`
|
|
19965
|
-
|
|
19966
|
-
</dd>
|
|
19967
|
-
</dl>
|
|
19968
|
-
|
|
19969
|
-
<dl>
|
|
19970
|
-
<dd>
|
|
19971
|
-
|
|
19972
|
-
**requestOptions:** `ExperimentsClient.RequestOptions`
|
|
19973
|
-
|
|
19974
|
-
</dd>
|
|
19975
|
-
</dl>
|
|
19976
|
-
</dd>
|
|
19977
|
-
</dl>
|
|
19978
|
-
|
|
19979
|
-
</dd>
|
|
19980
|
-
</dl>
|
|
19981
|
-
</details>
|
|
19982
|
-
|
|
19983
20324
|
<details><summary><code>client.experimentation.experiments.<a href="/src/management/api/resources/experimentation/resources/experiments/client/Client.ts">validate</a>(id) -> Management.ValidateExperimentResponseContent</code></summary>
|
|
19984
20325
|
<dl>
|
|
19985
20326
|
<dd>
|
|
@@ -20393,79 +20734,6 @@ await client.experimentation.featureFlags.update("id");
|
|
|
20393
20734
|
</dl>
|
|
20394
20735
|
</details>
|
|
20395
20736
|
|
|
20396
|
-
<details><summary><code>client.experimentation.featureFlags.<a href="/src/management/api/resources/experimentation/resources/featureFlags/client/Client.ts">updateStatus</a>(id, { ...params }) -> Management.UpdateFeatureFlagStatusResponseContent</code></summary>
|
|
20397
|
-
<dl>
|
|
20398
|
-
<dd>
|
|
20399
|
-
|
|
20400
|
-
#### 📝 Description
|
|
20401
|
-
|
|
20402
|
-
<dl>
|
|
20403
|
-
<dd>
|
|
20404
|
-
|
|
20405
|
-
<dl>
|
|
20406
|
-
<dd>
|
|
20407
|
-
|
|
20408
|
-
Transitions a feature flag through its lifecycle states: draft → active, draft → archived, active → archived.
|
|
20409
|
-
|
|
20410
|
-
</dd>
|
|
20411
|
-
</dl>
|
|
20412
|
-
</dd>
|
|
20413
|
-
</dl>
|
|
20414
|
-
|
|
20415
|
-
#### 🔌 Usage
|
|
20416
|
-
|
|
20417
|
-
<dl>
|
|
20418
|
-
<dd>
|
|
20419
|
-
|
|
20420
|
-
<dl>
|
|
20421
|
-
<dd>
|
|
20422
|
-
|
|
20423
|
-
```typescript
|
|
20424
|
-
await client.experimentation.featureFlags.updateStatus("id", {
|
|
20425
|
-
status: "draft",
|
|
20426
|
-
});
|
|
20427
|
-
```
|
|
20428
|
-
|
|
20429
|
-
</dd>
|
|
20430
|
-
</dl>
|
|
20431
|
-
</dd>
|
|
20432
|
-
</dl>
|
|
20433
|
-
|
|
20434
|
-
#### ⚙️ Parameters
|
|
20435
|
-
|
|
20436
|
-
<dl>
|
|
20437
|
-
<dd>
|
|
20438
|
-
|
|
20439
|
-
<dl>
|
|
20440
|
-
<dd>
|
|
20441
|
-
|
|
20442
|
-
**id:** `string` — The ID of the feature flag to transition.
|
|
20443
|
-
|
|
20444
|
-
</dd>
|
|
20445
|
-
</dl>
|
|
20446
|
-
|
|
20447
|
-
<dl>
|
|
20448
|
-
<dd>
|
|
20449
|
-
|
|
20450
|
-
**request:** `Management.UpdateFeatureFlagStatusRequestContent`
|
|
20451
|
-
|
|
20452
|
-
</dd>
|
|
20453
|
-
</dl>
|
|
20454
|
-
|
|
20455
|
-
<dl>
|
|
20456
|
-
<dd>
|
|
20457
|
-
|
|
20458
|
-
**requestOptions:** `FeatureFlagsClient.RequestOptions`
|
|
20459
|
-
|
|
20460
|
-
</dd>
|
|
20461
|
-
</dl>
|
|
20462
|
-
</dd>
|
|
20463
|
-
</dl>
|
|
20464
|
-
|
|
20465
|
-
</dd>
|
|
20466
|
-
</dl>
|
|
20467
|
-
</details>
|
|
20468
|
-
|
|
20469
20737
|
## Experimentation Segments
|
|
20470
20738
|
|
|
20471
20739
|
<details><summary><code>client.experimentation.segments.<a href="/src/management/api/resources/experimentation/resources/segments/client/Client.ts">list</a>({ ...params }) -> core.Page<Management.Segment, Management.ListSegmentsResponseContent></code></summary>
|