auth0 7.3.0 → 7.4.0-beta.1
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/README.md +5 -0
- package/dist/cjs/management/api/requests/requests.d.ts +30 -0
- package/dist/cjs/management/api/resources/clients/client/Client.d.ts +37 -0
- package/dist/cjs/management/api/resources/clients/client/Client.js +111 -0
- package/dist/cjs/management/api/types/types.d.ts +135 -0
- package/dist/cjs/management/api/types/types.js +31 -21
- 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 +30 -0
- package/dist/esm/management/api/resources/clients/client/Client.d.mts +37 -0
- package/dist/esm/management/api/resources/clients/client/Client.mjs +111 -0
- package/dist/esm/management/api/types/types.d.mts +135 -0
- package/dist/esm/management/api/types/types.mjs +10 -0
- 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 +101 -0
package/README.md
CHANGED
|
@@ -34,6 +34,11 @@ Using [npm](https://npmjs.org) in your project directory run the following comma
|
|
|
34
34
|
npm install auth0
|
|
35
35
|
```
|
|
36
36
|
|
|
37
|
+
> [!NOTE]
|
|
38
|
+
> **Release channels.** Endpoints move through three maturity tiers: Generally Available, Early Access, and Beta. This package is published on two channels. The stable channel (`npm install auth0`) includes the Generally Available and Early Access endpoints. The beta channel (`npm install auth0@beta`) is a superset that includes all three tiers.
|
|
39
|
+
>
|
|
40
|
+
> Beta prereleases can introduce breaking changes between versions, so pin an exact version if you need reproducible installs.
|
|
41
|
+
|
|
37
42
|
### Configure the SDK
|
|
38
43
|
|
|
39
44
|
#### Authentication
|
|
@@ -369,6 +369,34 @@ export interface RegisterCimdClientRequestContent {
|
|
|
369
369
|
/** URL to the Client ID Metadata Document. Acts as the unique identifier for upsert operations. */
|
|
370
370
|
external_client_id: string;
|
|
371
371
|
}
|
|
372
|
+
/**
|
|
373
|
+
* @example
|
|
374
|
+
* {
|
|
375
|
+
* q: "q",
|
|
376
|
+
* parser: "scim",
|
|
377
|
+
* fields: "fields",
|
|
378
|
+
* include_fields: true,
|
|
379
|
+
* take: 1,
|
|
380
|
+
* from: "from",
|
|
381
|
+
* sort: "name"
|
|
382
|
+
* }
|
|
383
|
+
*/
|
|
384
|
+
export interface SearchClientsRequestParameters {
|
|
385
|
+
/** Filter expression in SCIM or Lucene syntax (depending on parser parameter). SCIM examples: `name eq "Auth0"`, `name sw "auth" and app_type eq "spa"`. SCIM operators: eq, ne, sw, ew, co, pr, gt, ge, lt, le, and, or. <br /><br /><b>Supported Fields</b>:<br /><ul><li><i>client_id</i> - Auth0 client ID (case-sensitive, exact match)</li><li><i>external_client_id</i> - URL of the Client ID Metadata Document (CIMD); case-sensitive, exact match</li><li><i>name</i> - Client name (supports contains, starts-with, ends-with operators; sortable)</li><li><i>app_type</i> - Application type (e.g. "spa", "native", "non_interactive")</li><li><i>is_first_party</i> - Whether the client is first-party (boolean)</li><li><i>updated_at</i> - Last update timestamp (supports date range operators; sortable)</li><li><i>metadata.{key}</i> - Filter by client metadata key-value pairs (max 2-level key depth, values indexed up to 64 characters)</li><li><i>client_grant.organization_id</i> - Filter by associated organization ID</li><li><i>client_grant.allow_any_organization</i> - Filter by allow any organization setting</li></ul>Maximum 5 filter operations per query. Results are eventually consistent and may not reflect recent updates. */
|
|
386
|
+
q?: string | null;
|
|
387
|
+
/** Query parser to use for the filter expression. Use "scim" for SCIM filter syntax or "lucene" for Lucene query syntax (default). */
|
|
388
|
+
parser?: Management.SearchParserEnum | null;
|
|
389
|
+
/** Comma-separated list of fields to include or exclude in the response. Works with the include_fields parameter to control projection mode. Maximum 50 fields. */
|
|
390
|
+
fields?: string | null;
|
|
391
|
+
/** Controls field projection mode. Set to true to include only fields specified in the fields parameter. Set to false to exclude fields specified in the fields parameter. Defaults to true if not specified. */
|
|
392
|
+
include_fields?: boolean | null;
|
|
393
|
+
/** Maximum number of results to return per page (1-100). Defaults to 50. */
|
|
394
|
+
take?: number | null;
|
|
395
|
+
/** Cursor for the next page of results. Use the value from the next field in the previous response. */
|
|
396
|
+
from?: string | null;
|
|
397
|
+
/** Field name to sort results by in ascending order. Defaults to insertion order (oldest first) if not provided. */
|
|
398
|
+
sort?: Management.ClientSortFieldEnum | null;
|
|
399
|
+
}
|
|
372
400
|
/**
|
|
373
401
|
* @example
|
|
374
402
|
* {
|
|
@@ -480,6 +508,7 @@ export interface UpdateClientRequestContent {
|
|
|
480
508
|
async_approval_notification_channels?: (Management.ClientAsyncApprovalNotificationsChannelsApiPatchConfiguration | undefined) | null;
|
|
481
509
|
third_party_security_mode?: Management.ClientThirdPartySecurityModeEnum;
|
|
482
510
|
redirection_policy?: Management.ClientRedirectionPolicyEnum;
|
|
511
|
+
oidc_support?: Management.ClientOidcSupportPatch | null;
|
|
483
512
|
}
|
|
484
513
|
/**
|
|
485
514
|
* @example
|
|
@@ -2256,6 +2285,7 @@ export interface UpdateBruteForceSettingsRequestContent {
|
|
|
2256
2285
|
mode?: Management.BruteForceProtectionModeEnum;
|
|
2257
2286
|
/** Maximum number of unsuccessful attempts. */
|
|
2258
2287
|
max_attempts?: number;
|
|
2288
|
+
form_submission_mode?: Management.BruteForceProtectionFormSubmissionModeEnum;
|
|
2259
2289
|
}
|
|
2260
2290
|
/**
|
|
2261
2291
|
* @example
|
|
@@ -151,6 +151,43 @@ export declare class ClientsClient {
|
|
|
151
151
|
*/
|
|
152
152
|
registerCimdClient(request: Management.RegisterCimdClientRequestContent, requestOptions?: ClientsClient.RequestOptions): core.HttpResponsePromise<Management.RegisterCimdClientResponseContent>;
|
|
153
153
|
private __registerCimdClient;
|
|
154
|
+
/**
|
|
155
|
+
* Search clients using SCIM or Lucene filter syntax with low-latency, eventually consistent results.
|
|
156
|
+
* Use the parser parameter to specify "scim" or "lucene" syntax (default: "lucene").
|
|
157
|
+
* This endpoint provides an alternative to the standard GET /clients endpoint with better performance
|
|
158
|
+
* for complex queries. Results may not reflect recent updates immediately.
|
|
159
|
+
*
|
|
160
|
+
* - This endpoint only supports `read:clients` and `read:client_summary` scopes. The `read:client_keys` and `read:client_credentials` scopes are not supported.
|
|
161
|
+
* - The following fields are never returned by this endpoint:
|
|
162
|
+
* - `client_secret`
|
|
163
|
+
* - `encryption_key`
|
|
164
|
+
* - `signing_keys`
|
|
165
|
+
* - `owners`
|
|
166
|
+
* - `addons`
|
|
167
|
+
*
|
|
168
|
+
* @param {Management.SearchClientsRequestParameters} request
|
|
169
|
+
* @param {ClientsClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
170
|
+
*
|
|
171
|
+
* @throws {@link Management.BadRequestError}
|
|
172
|
+
* @throws {@link Management.UnauthorizedError}
|
|
173
|
+
* @throws {@link Management.ForbiddenError}
|
|
174
|
+
* @throws {@link Management.NotFoundError}
|
|
175
|
+
* @throws {@link Management.TooManyRequestsError}
|
|
176
|
+
* @throws {@link Management.InternalServerError}
|
|
177
|
+
* @throws {@link Management.GatewayTimeoutError}
|
|
178
|
+
*
|
|
179
|
+
* @example
|
|
180
|
+
* await client.clients.search({
|
|
181
|
+
* q: "q",
|
|
182
|
+
* parser: "scim",
|
|
183
|
+
* fields: "fields",
|
|
184
|
+
* include_fields: true,
|
|
185
|
+
* take: 1,
|
|
186
|
+
* from: "from",
|
|
187
|
+
* sort: "name"
|
|
188
|
+
* })
|
|
189
|
+
*/
|
|
190
|
+
search(request?: Management.SearchClientsRequestParameters, requestOptions?: ClientsClient.RequestOptions): Promise<core.Page<Management.ClientSearchResponse, Management.SearchClientsResponseContent>>;
|
|
154
191
|
/**
|
|
155
192
|
* Retrieve client details by ID. Clients are SSO connections or Applications linked with your Auth0 tenant. A list of fields to include or exclude may also be specified.
|
|
156
193
|
* For more information, read [Applications in Auth0](https://www.auth0.com/docs/get-started/applications) and [Single Sign-On](https://www.auth0.com/docs/authenticate/single-sign-on).
|
|
@@ -426,6 +426,117 @@ class ClientsClient {
|
|
|
426
426
|
return (0, handleNonStatusCodeError_js_1.handleNonStatusCodeError)(_response.error, _response.rawResponse, "POST", "/clients/cimd/register");
|
|
427
427
|
});
|
|
428
428
|
}
|
|
429
|
+
/**
|
|
430
|
+
* Search clients using SCIM or Lucene filter syntax with low-latency, eventually consistent results.
|
|
431
|
+
* Use the parser parameter to specify "scim" or "lucene" syntax (default: "lucene").
|
|
432
|
+
* This endpoint provides an alternative to the standard GET /clients endpoint with better performance
|
|
433
|
+
* for complex queries. Results may not reflect recent updates immediately.
|
|
434
|
+
*
|
|
435
|
+
* - This endpoint only supports `read:clients` and `read:client_summary` scopes. The `read:client_keys` and `read:client_credentials` scopes are not supported.
|
|
436
|
+
* - The following fields are never returned by this endpoint:
|
|
437
|
+
* - `client_secret`
|
|
438
|
+
* - `encryption_key`
|
|
439
|
+
* - `signing_keys`
|
|
440
|
+
* - `owners`
|
|
441
|
+
* - `addons`
|
|
442
|
+
*
|
|
443
|
+
* @param {Management.SearchClientsRequestParameters} request
|
|
444
|
+
* @param {ClientsClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
445
|
+
*
|
|
446
|
+
* @throws {@link Management.BadRequestError}
|
|
447
|
+
* @throws {@link Management.UnauthorizedError}
|
|
448
|
+
* @throws {@link Management.ForbiddenError}
|
|
449
|
+
* @throws {@link Management.NotFoundError}
|
|
450
|
+
* @throws {@link Management.TooManyRequestsError}
|
|
451
|
+
* @throws {@link Management.InternalServerError}
|
|
452
|
+
* @throws {@link Management.GatewayTimeoutError}
|
|
453
|
+
*
|
|
454
|
+
* @example
|
|
455
|
+
* await client.clients.search({
|
|
456
|
+
* q: "q",
|
|
457
|
+
* parser: "scim",
|
|
458
|
+
* fields: "fields",
|
|
459
|
+
* include_fields: true,
|
|
460
|
+
* take: 1,
|
|
461
|
+
* from: "from",
|
|
462
|
+
* sort: "name"
|
|
463
|
+
* })
|
|
464
|
+
*/
|
|
465
|
+
search() {
|
|
466
|
+
return __awaiter(this, arguments, void 0, function* (request = {}, requestOptions) {
|
|
467
|
+
const list = core.HttpResponsePromise.interceptFunction((request) => __awaiter(this, void 0, void 0, function* () {
|
|
468
|
+
var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k;
|
|
469
|
+
const { q, parser, fields, include_fields: includeFields, take = 50, from: from_, sort } = request;
|
|
470
|
+
const _queryParams = {
|
|
471
|
+
q,
|
|
472
|
+
parser: parser !== undefined ? parser : undefined,
|
|
473
|
+
fields,
|
|
474
|
+
include_fields: includeFields,
|
|
475
|
+
take,
|
|
476
|
+
from: from_,
|
|
477
|
+
sort: sort !== undefined ? sort : undefined,
|
|
478
|
+
};
|
|
479
|
+
const _authRequest = yield this._options.authProvider.getAuthRequest();
|
|
480
|
+
let _headers = (0, headers_js_1.mergeHeaders)(_authRequest.headers, (_a = this._options) === null || _a === void 0 ? void 0 : _a.headers, requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers);
|
|
481
|
+
const _response = yield ((_b = this._options.fetcher) !== null && _b !== void 0 ? _b : core.fetcher)({
|
|
482
|
+
url: core.url.join((_d = (_c = (yield core.Supplier.get(this._options.baseUrl))) !== null && _c !== void 0 ? _c : (yield core.Supplier.get(this._options.environment))) !== null && _d !== void 0 ? _d : environments.ManagementEnvironment.Default, "clients/search"),
|
|
483
|
+
method: "GET",
|
|
484
|
+
headers: _headers,
|
|
485
|
+
queryString: core.url
|
|
486
|
+
.queryBuilder()
|
|
487
|
+
.addMany(_queryParams)
|
|
488
|
+
.mergeAdditional(requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams)
|
|
489
|
+
.build(),
|
|
490
|
+
timeoutMs: ((_g = (_e = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) !== null && _e !== void 0 ? _e : (_f = this._options) === null || _f === void 0 ? void 0 : _f.timeoutInSeconds) !== null && _g !== void 0 ? _g : 60) * 1000,
|
|
491
|
+
maxRetries: (_h = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.maxRetries) !== null && _h !== void 0 ? _h : (_j = this._options) === null || _j === void 0 ? void 0 : _j.maxRetries,
|
|
492
|
+
abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
|
|
493
|
+
fetchFn: (_k = this._options) === null || _k === void 0 ? void 0 : _k.fetch,
|
|
494
|
+
logging: this._options.logging,
|
|
495
|
+
});
|
|
496
|
+
if (_response.ok) {
|
|
497
|
+
return {
|
|
498
|
+
data: _response.body,
|
|
499
|
+
rawResponse: _response.rawResponse,
|
|
500
|
+
};
|
|
501
|
+
}
|
|
502
|
+
if (_response.error.reason === "status-code") {
|
|
503
|
+
switch (_response.error.statusCode) {
|
|
504
|
+
case 400:
|
|
505
|
+
throw new Management.BadRequestError(_response.error.body, _response.rawResponse);
|
|
506
|
+
case 401:
|
|
507
|
+
throw new Management.UnauthorizedError(_response.error.body, _response.rawResponse);
|
|
508
|
+
case 403:
|
|
509
|
+
throw new Management.ForbiddenError(_response.error.body, _response.rawResponse);
|
|
510
|
+
case 404:
|
|
511
|
+
throw new Management.NotFoundError(_response.error.body, _response.rawResponse);
|
|
512
|
+
case 429:
|
|
513
|
+
throw new Management.TooManyRequestsError(_response.error.body, _response.rawResponse);
|
|
514
|
+
case 500:
|
|
515
|
+
throw new Management.InternalServerError(_response.error.body, _response.rawResponse);
|
|
516
|
+
case 504:
|
|
517
|
+
throw new Management.GatewayTimeoutError(_response.error.body, _response.rawResponse);
|
|
518
|
+
default:
|
|
519
|
+
throw new errors.ManagementError({
|
|
520
|
+
statusCode: _response.error.statusCode,
|
|
521
|
+
body: _response.error.body,
|
|
522
|
+
rawResponse: _response.rawResponse,
|
|
523
|
+
});
|
|
524
|
+
}
|
|
525
|
+
}
|
|
526
|
+
return (0, handleNonStatusCodeError_js_1.handleNonStatusCodeError)(_response.error, _response.rawResponse, "GET", "/clients/search");
|
|
527
|
+
}));
|
|
528
|
+
const dataWithRawResponse = yield list(request).withRawResponse();
|
|
529
|
+
return new core.Page({
|
|
530
|
+
response: dataWithRawResponse.data,
|
|
531
|
+
rawResponse: dataWithRawResponse.rawResponse,
|
|
532
|
+
hasNextPage: (response) => (response === null || response === void 0 ? void 0 : response.next) != null && !(typeof (response === null || response === void 0 ? void 0 : response.next) === "string" && (response === null || response === void 0 ? void 0 : response.next) === ""),
|
|
533
|
+
getItems: (response) => { var _a; return (_a = response === null || response === void 0 ? void 0 : response.clients) !== null && _a !== void 0 ? _a : []; },
|
|
534
|
+
loadPage: (response) => {
|
|
535
|
+
return list(core.setObjectProperty(request, "from", response === null || response === void 0 ? void 0 : response.next));
|
|
536
|
+
},
|
|
537
|
+
});
|
|
538
|
+
});
|
|
539
|
+
}
|
|
429
540
|
/**
|
|
430
541
|
* Retrieve client details by ID. Clients are SSO connections or Applications linked with your Auth0 tenant. A list of fields to include or exclude may also be specified.
|
|
431
542
|
* For more information, read [Applications in Auth0](https://www.auth0.com/docs/get-started/applications) and [Single Sign-On](https://www.auth0.com/docs/authenticate/single-sign-on).
|
|
@@ -1920,6 +1920,12 @@ export interface BreachedPasswordDetectionStage {
|
|
|
1920
1920
|
"pre-user-registration"?: Management.BreachedPasswordDetectionPreUserRegistrationStage | undefined;
|
|
1921
1921
|
"pre-change-password"?: Management.BreachedPasswordDetectionPreChangePasswordStage | undefined;
|
|
1922
1922
|
}
|
|
1923
|
+
/** Controls whether the BFP unblock form is submitted automatically or requires manual interaction. Canonical field; deprecated alias normalized upstream. */
|
|
1924
|
+
export declare const BruteForceProtectionFormSubmissionModeEnum: {
|
|
1925
|
+
readonly Manual: "manual";
|
|
1926
|
+
readonly Auto: "auto";
|
|
1927
|
+
};
|
|
1928
|
+
export type BruteForceProtectionFormSubmissionModeEnum = (typeof BruteForceProtectionFormSubmissionModeEnum)[keyof typeof BruteForceProtectionFormSubmissionModeEnum];
|
|
1923
1929
|
/**
|
|
1924
1930
|
* Account Lockout: Determines whether or not IP address is used when counting failed attempts.
|
|
1925
1931
|
* Possible values: <code>count_per_identifier_and_ip</code>, <code>count_per_identifier</code>.
|
|
@@ -2957,6 +2963,14 @@ export declare const ClientOidcSupportAllowedScopesEnum: {
|
|
|
2957
2963
|
readonly Phone: "phone";
|
|
2958
2964
|
};
|
|
2959
2965
|
export type ClientOidcSupportAllowedScopesEnum = (typeof ClientOidcSupportAllowedScopesEnum)[keyof typeof ClientOidcSupportAllowedScopesEnum];
|
|
2966
|
+
/**
|
|
2967
|
+
* OIDC support configuration for a client. Replaces the stored object entirely; send null to unset it.
|
|
2968
|
+
*/
|
|
2969
|
+
export interface ClientOidcSupportPatch {
|
|
2970
|
+
is_allowed: boolean;
|
|
2971
|
+
allow_all_scopes?: boolean | undefined;
|
|
2972
|
+
allowed_scopes?: Management.ClientOidcSupportAllowedScopesEnum[] | undefined;
|
|
2973
|
+
}
|
|
2960
2974
|
/**
|
|
2961
2975
|
* OIDC support configuration for a client. Controls whether OIDC flows are allowed and which scopes the client may request.
|
|
2962
2976
|
*/
|
|
@@ -3030,6 +3044,113 @@ export interface ClientRefreshTokenPolicy {
|
|
|
3030
3044
|
/** The resource server permissions granted under the Multi Resource Refresh Token Policy, defining the context in which an access token can be used */
|
|
3031
3045
|
scope: string[];
|
|
3032
3046
|
}
|
|
3047
|
+
export interface ClientSearchResponse {
|
|
3048
|
+
/** ID of this client. */
|
|
3049
|
+
client_id?: string | undefined;
|
|
3050
|
+
/** The ISO 8601 timestamp of when this client was created. */
|
|
3051
|
+
created_at?: string | undefined;
|
|
3052
|
+
/** The ISO 8601 timestamp of when this client was last updated. */
|
|
3053
|
+
updated_at?: string | undefined;
|
|
3054
|
+
/** Name of the tenant this client belongs to. */
|
|
3055
|
+
tenant?: string | undefined;
|
|
3056
|
+
/** Name of this client (min length: 1 character, does not allow `<` or `>`). */
|
|
3057
|
+
name?: string | undefined;
|
|
3058
|
+
/** Free text description of this client (max length: 140 characters). */
|
|
3059
|
+
description?: string | undefined;
|
|
3060
|
+
/** Whether this is your global 'All Applications' client representing legacy tenant settings (true) or a regular client (false). */
|
|
3061
|
+
global?: boolean | undefined;
|
|
3062
|
+
app_type?: Management.ClientAppTypeEnum | undefined;
|
|
3063
|
+
/** URL of the logo to display for this client. Recommended size is 150x150 pixels. */
|
|
3064
|
+
logo_uri?: string | undefined;
|
|
3065
|
+
/** Whether this client a first party client (true) or not (false). */
|
|
3066
|
+
is_first_party?: boolean | undefined;
|
|
3067
|
+
/** Whether this client conforms to <a href='https://auth0.com/docs/api-auth/tutorials/adoption'>strict OIDC specifications</a> (true) or uses legacy features (false). */
|
|
3068
|
+
oidc_conformant?: boolean | undefined;
|
|
3069
|
+
/** Comma-separated list of URLs whitelisted for Auth0 to use as a callback to the client after authentication. */
|
|
3070
|
+
callbacks?: string[] | undefined;
|
|
3071
|
+
/** Comma-separated list of URLs allowed to make requests from JavaScript to Auth0 API (typically used with CORS). By default, all your callback URLs will be allowed. This field allows you to enter other origins if necessary. You can also use wildcards at the subdomain level (e.g., https://*.contoso.com). Query strings and hash information are not taken into account when validating these URLs. */
|
|
3072
|
+
allowed_origins?: string[] | undefined;
|
|
3073
|
+
/** Comma-separated list of allowed origins for use with <a href='https://auth0.com/docs/cross-origin-authentication'>Cross-Origin Authentication</a>, <a href='https://auth0.com/docs/flows/concepts/device-auth'>Device Flow</a>, and <a href='https://auth0.com/docs/protocols/oauth2#how-response-mode-works'>web message response mode</a>. */
|
|
3074
|
+
web_origins?: string[] | undefined;
|
|
3075
|
+
/** List of audiences/realms for SAML protocol. Used by the wsfed addon. */
|
|
3076
|
+
client_aliases?: string[] | undefined;
|
|
3077
|
+
/** List of allow clients and API ids that are allowed to make delegation requests. Empty means all all your clients are allowed. */
|
|
3078
|
+
allowed_clients?: string[] | undefined;
|
|
3079
|
+
/** Comma-separated list of URLs that are valid to redirect to after logout from Auth0. Wildcards are allowed for subdomains. */
|
|
3080
|
+
allowed_logout_urls?: string[] | undefined;
|
|
3081
|
+
session_transfer?: (Management.ClientSessionTransferConfiguration | null) | undefined;
|
|
3082
|
+
oidc_logout?: Management.ClientOidcBackchannelLogoutSettings | undefined;
|
|
3083
|
+
/** List of grant types supported for this application. Can include `authorization_code`, `implicit`, `refresh_token`, `client_credentials`, `password`, `http://auth0.com/oauth/grant-type/password-realm`, `http://auth0.com/oauth/grant-type/mfa-oob`, `http://auth0.com/oauth/grant-type/mfa-otp`, `http://auth0.com/oauth/grant-type/mfa-recovery-code`, `urn:openid:params:grant-type:ciba`, `urn:ietf:params:oauth:grant-type:device_code`, and `urn:auth0:params:oauth:grant-type:token-exchange:federated-connection-access-token`. */
|
|
3084
|
+
grant_types?: string[] | undefined;
|
|
3085
|
+
jwt_configuration?: Management.ClientJwtConfiguration | undefined;
|
|
3086
|
+
/** Applies only to SSO clients and determines whether Auth0 will handle Single Sign On (true) or whether the Identity Provider will (false). */
|
|
3087
|
+
sso?: boolean | undefined;
|
|
3088
|
+
/** Whether Single Sign On is disabled (true) or enabled (true). Defaults to true. */
|
|
3089
|
+
sso_disabled?: boolean | undefined;
|
|
3090
|
+
/** Whether this client can be used to make cross-origin authentication requests (true) or it is not allowed to make such requests (false). */
|
|
3091
|
+
cross_origin_authentication?: boolean | undefined;
|
|
3092
|
+
/** URL of the location in your site where the cross origin verification takes place for the cross-origin auth flow when performing Auth in your own domain instead of Auth0 hosted login page. */
|
|
3093
|
+
cross_origin_loc?: string | undefined;
|
|
3094
|
+
/** Whether a custom login page is to be used (true) or the default provided login page (false). */
|
|
3095
|
+
custom_login_page_on?: boolean | undefined;
|
|
3096
|
+
/** The content (HTML, CSS, JS) of the custom login page. */
|
|
3097
|
+
custom_login_page?: string | undefined;
|
|
3098
|
+
/** The content (HTML, CSS, JS) of the custom login page. (Used on Previews) */
|
|
3099
|
+
custom_login_page_preview?: string | undefined;
|
|
3100
|
+
/** HTML form template to be used for WS-Federation. */
|
|
3101
|
+
form_template?: string | undefined;
|
|
3102
|
+
token_endpoint_auth_method?: Management.ClientTokenEndpointAuthMethodEnum | undefined;
|
|
3103
|
+
/** If true, trust that the IP specified in the `auth0-forwarded-for` header is the end-user's IP for brute-force-protection on token endpoint. */
|
|
3104
|
+
is_token_endpoint_ip_header_trusted?: boolean | undefined;
|
|
3105
|
+
client_metadata?: Management.ClientMetadata | undefined;
|
|
3106
|
+
mobile?: Management.ClientMobile | undefined;
|
|
3107
|
+
/** Initiate login uri, must be https */
|
|
3108
|
+
initiate_login_uri?: string | undefined;
|
|
3109
|
+
native_social_login?: Management.NativeSocialLogin | undefined;
|
|
3110
|
+
fedcm_login?: Management.FedCmLogin | undefined;
|
|
3111
|
+
refresh_token?: (Management.ClientRefreshTokenConfiguration | null) | undefined;
|
|
3112
|
+
default_organization?: (Management.ClientDefaultOrganization | null) | undefined;
|
|
3113
|
+
organization_usage?: Management.ClientOrganizationUsageEnum | undefined;
|
|
3114
|
+
organization_require_behavior?: Management.ClientOrganizationRequireBehaviorEnum | undefined;
|
|
3115
|
+
/** Defines the available methods for organization discovery during the `pre_login_prompt`. Users can discover their organization either by `email`, `organization_name` or both. */
|
|
3116
|
+
organization_discovery_methods?: Management.ClientOrganizationDiscoveryEnum[] | undefined;
|
|
3117
|
+
client_authentication_methods?: (Management.ClientAuthenticationMethod | null) | undefined;
|
|
3118
|
+
/** Makes the use of Pushed Authorization Requests mandatory for this client */
|
|
3119
|
+
require_pushed_authorization_requests?: boolean | undefined;
|
|
3120
|
+
/** Makes the use of Proof-of-Possession mandatory for this client */
|
|
3121
|
+
require_proof_of_possession?: boolean | undefined;
|
|
3122
|
+
signed_request_object?: Management.ClientSignedRequestObjectWithCredentialId | undefined;
|
|
3123
|
+
token_vault_privileged_access?: Management.ClientTokenVaultPrivilegedAccessWithCredentialId | undefined;
|
|
3124
|
+
compliance_level?: (Management.ClientComplianceLevelEnum | null) | undefined;
|
|
3125
|
+
/**
|
|
3126
|
+
* Controls whether a confirmation prompt is shown during login flows when the redirect URI uses non-verifiable callback URIs (for example, a custom URI schema such as `myapp://`, or `localhost`).
|
|
3127
|
+
* If set to true, a confirmation prompt will not be shown. We recommend that this is set to false for improved protection from malicious apps.
|
|
3128
|
+
* See https://auth0.com/docs/secure/security-guidance/measures-against-app-impersonation for more information.
|
|
3129
|
+
*/
|
|
3130
|
+
skip_non_verifiable_callback_uri_confirmation_prompt?: boolean | undefined;
|
|
3131
|
+
token_exchange?: Management.ClientTokenExchangeConfiguration | undefined;
|
|
3132
|
+
/** Specifies how long, in seconds, a Pushed Authorization Request URI remains valid */
|
|
3133
|
+
par_request_expiry?: (number | null) | undefined;
|
|
3134
|
+
token_quota?: Management.TokenQuota | undefined;
|
|
3135
|
+
express_configuration?: Management.ExpressConfiguration | undefined;
|
|
3136
|
+
b2b_integration_configuration?: Management.B2BIntegrationConfiguration | undefined;
|
|
3137
|
+
my_organization_configuration?: Management.ClientMyOrganizationResponseConfiguration | undefined;
|
|
3138
|
+
identity_assertion_authorization_grant?: Management.IdentityAssertionAuthorizationGrant | undefined;
|
|
3139
|
+
anonymous_sessions?: Management.AnonymousSessions | undefined;
|
|
3140
|
+
third_party_security_mode?: Management.ClientThirdPartySecurityModeEnum | undefined;
|
|
3141
|
+
redirection_policy?: Management.ClientRedirectionPolicyEnum | undefined;
|
|
3142
|
+
/** The identifier of the resource server that this client is linked to. */
|
|
3143
|
+
resource_server_identifier?: string | undefined;
|
|
3144
|
+
async_approval_notification_channels?: Management.ClientAsyncApprovalNotificationsChannelsApiPostConfiguration | undefined;
|
|
3145
|
+
external_metadata_type?: Management.ClientExternalMetadataTypeEnum | undefined;
|
|
3146
|
+
external_metadata_created_by?: Management.ClientExternalMetadataCreatedByEnum | undefined;
|
|
3147
|
+
/** An alternate client identifier to be used during authorization flows. Only supports CIMD-based client identifiers. */
|
|
3148
|
+
external_client_id?: string | undefined;
|
|
3149
|
+
/** URL for the JSON Web Key Set (JWKS) containing the public keys used for private_key_jwt authentication. Only present for CIMD clients using private_key_jwt authentication. */
|
|
3150
|
+
jwks_uri?: string | undefined;
|
|
3151
|
+
/** Accepts any additional properties */
|
|
3152
|
+
[key: string]: any;
|
|
3153
|
+
}
|
|
3033
3154
|
export declare const ClientSessionTransferAllowedAuthenticationMethodsEnum: {
|
|
3034
3155
|
readonly Cookie: "cookie";
|
|
3035
3156
|
readonly Query: "query";
|
|
@@ -3102,6 +3223,12 @@ export interface ClientSigningKey {
|
|
|
3102
3223
|
* Signing certificates associated with this client.
|
|
3103
3224
|
*/
|
|
3104
3225
|
export type ClientSigningKeys = (Management.ClientSigningKey[] | null) | undefined;
|
|
3226
|
+
/** Field name to sort results by in ascending order. Defaults to insertion order (oldest first) if not provided. */
|
|
3227
|
+
export declare const ClientSortFieldEnum: {
|
|
3228
|
+
readonly Name: "name";
|
|
3229
|
+
readonly UpdatedAt: "updated_at";
|
|
3230
|
+
};
|
|
3231
|
+
export type ClientSortFieldEnum = (typeof ClientSortFieldEnum)[keyof typeof ClientSortFieldEnum];
|
|
3105
3232
|
/** Security mode for third-party clients. `strict` enforces <a href="https://auth0.com/docs/get-started/applications/third-party-applications/security-controls">enhanced security controls</a>: OAuth 2.1 alignment, explicit API authorization, and a curated set of supported features. `permissive` preserves <a href="https://auth0.com/docs/get-started/applications/third-party-applications/permissive-mode">pre-existing behavior</a> and is only available to tenants with prior third-party client usage. Set on creation and cannot be modified. */
|
|
3106
3233
|
export declare const ClientThirdPartySecurityModeEnum: {
|
|
3107
3234
|
readonly Strict: "strict";
|
|
@@ -27524,6 +27651,7 @@ export interface GetBruteForceSettingsResponseContent {
|
|
|
27524
27651
|
mode?: Management.BruteForceProtectionModeEnum | undefined;
|
|
27525
27652
|
/** Maximum number of unsuccessful attempts. */
|
|
27526
27653
|
max_attempts?: number | undefined;
|
|
27654
|
+
form_submission_mode?: Management.BruteForceProtectionFormSubmissionModeEnum | undefined;
|
|
27527
27655
|
}
|
|
27528
27656
|
export interface GetClientCredentialResponseContent {
|
|
27529
27657
|
/** ID of the credential. Generated on creation. */
|
|
@@ -31944,6 +32072,12 @@ export declare const ScreenGroupNameEnum: {
|
|
|
31944
32072
|
readonly AsyncApprovalWrongUser: "async-approval-wrong-user";
|
|
31945
32073
|
};
|
|
31946
32074
|
export type ScreenGroupNameEnum = (typeof ScreenGroupNameEnum)[keyof typeof ScreenGroupNameEnum];
|
|
32075
|
+
export interface SearchClientsResponseContent {
|
|
32076
|
+
/** Array of client objects matching the search criteria. */
|
|
32077
|
+
clients: Management.ClientSearchResponse[];
|
|
32078
|
+
/** Cursor for retrieving the next page of results. Absent when no more results are available. */
|
|
32079
|
+
next?: string | undefined;
|
|
32080
|
+
}
|
|
31947
32081
|
/** The version of the search engine */
|
|
31948
32082
|
export declare const SearchEngineVersionsEnum: {
|
|
31949
32083
|
readonly V1: "v1";
|
|
@@ -33348,6 +33482,7 @@ export interface UpdateBruteForceSettingsResponseContent {
|
|
|
33348
33482
|
mode?: Management.BruteForceProtectionModeEnum | undefined;
|
|
33349
33483
|
/** Maximum number of unsuccessful attempts. */
|
|
33350
33484
|
max_attempts?: number | undefined;
|
|
33485
|
+
form_submission_mode?: Management.BruteForceProtectionFormSubmissionModeEnum | undefined;
|
|
33351
33486
|
}
|
|
33352
33487
|
export interface UpdateClientGrantResponseContent {
|
|
33353
33488
|
/** ID of the client grant. */
|