Skip to content

Commit 0610e60

Browse files
SDK regeneration
1 parent 7985e09 commit 0610e60

12 files changed

Lines changed: 833 additions & 337 deletions

File tree

reference.md

Lines changed: 123 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -746,7 +746,6 @@ Create a client grant for a machine-to-machine login flow. To learn more, read <
746746

747747
```typescript
748748
await client.clientGrants.create({
749-
client_id: "client_id",
750749
audience: "audience",
751750
});
752751
```
@@ -2562,6 +2561,126 @@ await client.customDomains.create({
25622561
</dl>
25632562
</details>
25642563

2564+
<details><summary><code>client.customDomains.<a href="/src/management/api/resources/customDomains/client/Client.ts">getDefault</a>() -> Management.GetDefaultDomainResponseContent</code></summary>
2565+
<dl>
2566+
<dd>
2567+
2568+
#### 📝 Description
2569+
2570+
<dl>
2571+
<dd>
2572+
2573+
<dl>
2574+
<dd>
2575+
2576+
Retrieve the tenant's default domain.
2577+
2578+
</dd>
2579+
</dl>
2580+
</dd>
2581+
</dl>
2582+
2583+
#### 🔌 Usage
2584+
2585+
<dl>
2586+
<dd>
2587+
2588+
<dl>
2589+
<dd>
2590+
2591+
```typescript
2592+
await client.customDomains.getDefault();
2593+
```
2594+
2595+
</dd>
2596+
</dl>
2597+
</dd>
2598+
</dl>
2599+
2600+
#### ⚙️ Parameters
2601+
2602+
<dl>
2603+
<dd>
2604+
2605+
<dl>
2606+
<dd>
2607+
2608+
**requestOptions:** `CustomDomainsClient.RequestOptions`
2609+
2610+
</dd>
2611+
</dl>
2612+
</dd>
2613+
</dl>
2614+
2615+
</dd>
2616+
</dl>
2617+
</details>
2618+
2619+
<details><summary><code>client.customDomains.<a href="/src/management/api/resources/customDomains/client/Client.ts">setDefault</a>({ ...params }) -> Management.UpdateDefaultDomainResponseContent</code></summary>
2620+
<dl>
2621+
<dd>
2622+
2623+
#### 📝 Description
2624+
2625+
<dl>
2626+
<dd>
2627+
2628+
<dl>
2629+
<dd>
2630+
2631+
Set the default custom domain for the tenant.
2632+
2633+
</dd>
2634+
</dl>
2635+
</dd>
2636+
</dl>
2637+
2638+
#### 🔌 Usage
2639+
2640+
<dl>
2641+
<dd>
2642+
2643+
<dl>
2644+
<dd>
2645+
2646+
```typescript
2647+
await client.customDomains.setDefault({
2648+
domain: "domain",
2649+
});
2650+
```
2651+
2652+
</dd>
2653+
</dl>
2654+
</dd>
2655+
</dl>
2656+
2657+
#### ⚙️ Parameters
2658+
2659+
<dl>
2660+
<dd>
2661+
2662+
<dl>
2663+
<dd>
2664+
2665+
**request:** `Management.SetDefaultCustomDomainRequestContent`
2666+
2667+
</dd>
2668+
</dl>
2669+
2670+
<dl>
2671+
<dd>
2672+
2673+
**requestOptions:** `CustomDomainsClient.RequestOptions`
2674+
2675+
</dd>
2676+
</dl>
2677+
</dd>
2678+
</dl>
2679+
2680+
</dd>
2681+
</dl>
2682+
</details>
2683+
25652684
<details><summary><code>client.customDomains.<a href="/src/management/api/resources/customDomains/client/Client.ts">get</a>(id) -> Management.GetCustomDomainResponseContent</code></summary>
25662685
<dl>
25672686
<dd>
@@ -21640,6 +21759,7 @@ await client.organizations.clientGrants.delete("id", "grant_id");
2164021759
<dd>
2164121760

2164221761
Retrieve list of all organization discovery domains associated with the specified organization.
21762+
This endpoint is subject to eventual consistency; newly created, updated, or deleted discovery domains may not immediately appear in the response.
2164321763

2164421764
</dd>
2164521765
</dl>
@@ -21802,6 +21922,7 @@ await client.organizations.discoveryDomains.create("id", {
2180221922
<dd>
2180321923

2180421924
Retrieve details about a single organization discovery domain specified by domain name.
21925+
This endpoint is subject to eventual consistency; newly created, updated, or deleted discovery domains may not immediately appear in the response.
2180521926

2180621927
</dd>
2180721928
</dl>
@@ -21873,6 +21994,7 @@ await client.organizations.discoveryDomains.getByName("id", "discovery_domain");
2187321994
<dd>
2187421995

2187521996
Retrieve details about a single organization discovery domain specified by ID.
21997+
This endpoint is subject to eventual consistency; newly created, updated, or deleted discovery domains may not immediately appear in the response.
2187621998

2187721999
</dd>
2187822000
</dl>

src/management/api/requests/requests.ts

Lines changed: 29 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -144,13 +144,12 @@ export interface ListClientGrantsRequestParameters {
144144
/**
145145
* @example
146146
* {
147-
* client_id: "client_id",
148147
* audience: "audience"
149148
* }
150149
*/
151150
export interface CreateClientGrantRequestContent {
152151
/** ID of the client. */
153-
client_id: string;
152+
client_id?: string;
154153
/** The audience (API identifier) of this client grant */
155154
audience: string;
156155
organization_usage?: Management.ClientGrantOrganizationUsageEnum;
@@ -171,7 +170,7 @@ export interface CreateClientGrantRequestContent {
171170
*/
172171
export interface UpdateClientGrantRequestContent {
173172
/** Scopes allowed for this client grant. */
174-
scope?: string[];
173+
scope?: string[] | null;
175174
organization_usage?: Management.ClientGrantOrganizationNullableUsageEnum | null;
176175
/** Controls allowing any organization to be used with this grant */
177176
allow_any_organization?: boolean | null;
@@ -212,7 +211,7 @@ export interface ListClientsRequestParameters {
212211
is_first_party?: boolean | null;
213212
/** Optional filter by a comma-separated list of application types. */
214213
app_type?: string | null;
215-
/** Advanced Query in <a href="http://www.lucenetutorial.com/lucene-query-syntax.html">Lucene</a> syntax.<br /><b>Permitted Queries</b>:<br /><ul><li><i>client_grant.organization_id:{organization_id}</i></li><li><i>client_grant.allow_any_organization:true</i></li></ul><b>Additional Restrictions</b>:<br /><ul><li>Cannot be used in combination with other filters</li><li>Requires use of the <i>from</i> and <i>take</i> paging parameters (checkpoint paginatinon)</li><li>Reduced rate limits apply. See <a href="https://auth0.com/docs/troubleshoot/customer-support/operational-policies/rate-limit-policy/rate-limit-configurations/enterprise-public">Rate Limit Configurations</a></li></ul><i><b>Note</b>: Recent updates may not be immediately reflected in query results</i> */
214+
/** Advanced Query in <a href="https://lucene.apache.org/core/2_9_4/queryparsersyntax.html">Lucene</a> syntax.<br /><b>Permitted Queries</b>:<br /><ul><li><i>client_grant.organization_id:{organization_id}</i></li><li><i>client_grant.allow_any_organization:true</i></li></ul><b>Additional Restrictions</b>:<br /><ul><li>Cannot be used in combination with other filters</li><li>Requires use of the <i>from</i> and <i>take</i> paging parameters (checkpoint paginatinon)</li><li>Reduced rate limits apply. See <a href="https://auth0.com/docs/troubleshoot/customer-support/operational-policies/rate-limit-policy/rate-limit-configurations/enterprise-public">Rate Limit Configurations</a></li></ul><i><b>Note</b>: Recent updates may not be immediately reflected in query results</i> */
216215
q?: string | null;
217216
}
218217

@@ -393,7 +392,7 @@ export interface UpdateClientRequestContent {
393392
organization_usage?: Management.ClientOrganizationUsagePatchEnum | null;
394393
organization_require_behavior?: Management.ClientOrganizationRequireBehaviorPatchEnum | null;
395394
/** Defines the available methods for organization discovery during the `pre_login_prompt`. Users can discover their organization either by `email`, `organization_name` or both. */
396-
organization_discovery_methods?: Management.ClientOrganizationDiscoveryEnum[];
395+
organization_discovery_methods?: Management.ClientOrganizationDiscoveryEnum[] | null;
397396
client_authentication_methods?: Management.ClientAuthenticationMethod | null;
398397
/** Makes the use of Pushed Authorization Requests mandatory for this client */
399398
require_pushed_authorization_requests?: boolean;
@@ -411,7 +410,9 @@ export interface UpdateClientRequestContent {
411410
/** Specifies how long, in seconds, a Pushed Authorization Request URI remains valid */
412411
par_request_expiry?: number | null;
413412
express_configuration?: Management.ExpressConfigurationOrNull | null;
414-
async_approval_notification_channels?: Management.ClientAsyncApprovalNotificationsChannelsApiPatchConfiguration;
413+
async_approval_notification_channels?:
414+
| (Management.ClientAsyncApprovalNotificationsChannelsApiPatchConfiguration | undefined)
415+
| null;
415416
}
416417

417418
/**
@@ -531,7 +532,7 @@ export interface UpdateConnectionRequestContent {
531532
display_name?: string;
532533
options?: Management.UpdateConnectionOptions | null;
533534
/** DEPRECATED property. Use the PATCH /v2/connections/{id}/clients endpoint to enable or disable the connection for any clients. */
534-
enabled_clients?: string[];
535+
enabled_clients?: string[] | null;
535536
/** <code>true</code> promotes to a domain-level connection so that third-party applications can use it. <code>false</code> does not promote the connection, so only first-party applications with the connection enabled can use it. (Defaults to <code>false</code>.) */
536537
is_domain_connection?: boolean;
537538
/** Enables showing a button for the connection in the login page (new experience only). If false, it will be usable only by HRD. (Defaults to <code>false</code>.) */
@@ -553,7 +554,7 @@ export interface UpdateConnectionRequestContent {
553554
* }
554555
*/
555556
export interface ListCustomDomainsRequestParameters {
556-
/** Query in <a href ="http://www.lucenetutorial.com/lucene-query-syntax.html">Lucene query string syntax</a>. */
557+
/** Query in <a href ="https://lucene.apache.org/core/2_9_4/queryparsersyntax.html">Lucene query string syntax</a>. */
557558
q?: string | null;
558559
/** Comma-separated list of fields to include or exclude (based on value provided for include_fields) in the result. Leave empty to retrieve all fields. */
559560
fields?: string | null;
@@ -582,6 +583,17 @@ export interface CreateCustomDomainRequestContent {
582583
relying_party_identifier?: string;
583584
}
584585

586+
/**
587+
* @example
588+
* {
589+
* domain: "domain"
590+
* }
591+
*/
592+
export interface SetDefaultCustomDomainRequestContent {
593+
/** The domain to set as the default custom domain. Must be a verified custom domain or the canonical domain. */
594+
domain: string;
595+
}
596+
585597
/**
586598
* @example
587599
* {}
@@ -814,7 +826,7 @@ export interface GetFlowRequestParameters {
814826
*/
815827
export interface UpdateFlowRequestContent {
816828
name?: string;
817-
actions?: Management.FlowAction[];
829+
actions?: Management.FlowAction[] | null;
818830
}
819831

820832
/**
@@ -1258,7 +1270,7 @@ export interface CreateResourceServerRequestContent {
12581270
enforce_policies?: boolean;
12591271
token_encryption?: Management.ResourceServerTokenEncryption | null;
12601272
consent_policy?: Management.ResourceServerConsentPolicyEnum | null;
1261-
authorization_details?: unknown[];
1273+
authorization_details?: unknown[] | null;
12621274
proof_of_possession?: Management.ResourceServerProofOfPossession | null;
12631275
subject_type_authorization?: Management.ResourceServerSubjectTypeAuthorization;
12641276
}
@@ -1297,7 +1309,7 @@ export interface UpdateResourceServerRequestContent {
12971309
enforce_policies?: boolean;
12981310
token_encryption?: Management.ResourceServerTokenEncryption | null;
12991311
consent_policy?: Management.ResourceServerConsentPolicyEnum | null;
1300-
authorization_details?: unknown[];
1312+
authorization_details?: unknown[] | null;
13011313
proof_of_possession?: Management.ResourceServerProofOfPossession | null;
13021314
subject_type_authorization?: Management.ResourceServerSubjectTypeAuthorization;
13031315
}
@@ -1727,7 +1739,7 @@ export interface ListUsersRequestParameters {
17271739
fields?: string | null;
17281740
/** Whether specified fields are to be included (true) or excluded (false). */
17291741
include_fields?: boolean | null;
1730-
/** Query in <a target='_new' href ='http://www.lucenetutorial.com/lucene-query-syntax.html'>Lucene query string syntax</a>. Some query types cannot be used on metadata fields, for details see <a href='https://auth0.com/docs/users/search/v3/query-syntax#searchable-fields'>Searchable Fields</a>. */
1742+
/** Query in <a target='_new' href ='https://lucene.apache.org/core/2_9_4/queryparsersyntax.html'>Lucene query string syntax</a>. Some query types cannot be used on metadata fields, for details see <a href='https://auth0.com/docs/users/search/v3/query-syntax#searchable-fields'>Searchable Fields</a>. */
17311743
q?: string | null;
17321744
/** The version of the search engine */
17331745
search_engine?: Management.SearchEngineVersionsEnum | null;
@@ -2370,6 +2382,8 @@ export interface PostClientCredentialRequestContent {
23702382
parse_expiry_from_cert?: boolean;
23712383
/** The ISO 8601 formatted date representing the expiration of the credential. If not specified (not recommended), the credential never expires. Applies to `public_key` credential type. */
23722384
expires_at?: string;
2385+
/** Optional kid (Key ID), used to uniquely identify the credential. If not specified, a kid value will be auto-generated. The kid header parameter in JWTs sent by your client should match this value. Valid format is [0-9a-zA-Z-_]{10,64} */
2386+
kid?: string;
23732387
}
23742388

23752389
/**
@@ -3290,13 +3304,13 @@ export interface BulkUpdateAculRequestContent {
32903304
export interface UpdateAculRequestContent {
32913305
/** Rendering mode */
32923306
rendering_mode?: Management.AculRenderingModeEnum;
3293-
context_configuration?: Management.AculContextConfiguration;
3307+
context_configuration?: (Management.AculContextConfiguration | undefined) | null;
32943308
/** Override Universal Login default head tags */
32953309
default_head_tags_disabled?: boolean | null;
32963310
/** Use page template with ACUL */
32973311
use_page_template?: boolean | null;
32983312
/** An array of head tags */
3299-
head_tags?: Management.AculHeadTag[];
3313+
head_tags?: Management.AculHeadTag[] | null;
33003314
filters?: Management.AculFilters | null;
33013315
}
33023316

@@ -3476,7 +3490,7 @@ export interface UpdateTenantSettingsRequestContent {
34763490
/** Whether to accept an organization name instead of an ID on auth endpoints */
34773491
allow_organization_name_in_authentication_api?: boolean | null;
34783492
/** Supported ACR values */
3479-
acr_values_supported?: string[];
3493+
acr_values_supported?: string[] | null;
34803494
mtls?: Management.TenantSettingsMtls | null;
34813495
/** Enables the use of Pushed Authorization Requests */
34823496
pushed_authorization_requests_supported?: boolean | null;

src/management/api/resources/clientGrants/client/Client.ts

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -155,7 +155,6 @@ export class ClientGrantsClient {
155155
*
156156
* @example
157157
* await client.clientGrants.create({
158-
* client_id: "client_id",
159158
* audience: "audience"
160159
* })
161160
*/

0 commit comments

Comments
 (0)