auth0 5.11.0 → 5.12.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/lib/retry.d.ts +7 -2
- package/dist/cjs/lib/retry.js +35 -5
- package/dist/cjs/management/api/requests/requests.d.ts +12 -2
- package/dist/cjs/management/api/resources/branding/resources/phone/resources/providers/client/Client.d.ts +6 -6
- package/dist/cjs/management/api/resources/branding/resources/phone/resources/providers/client/Client.js +6 -6
- package/dist/cjs/management/api/resources/clientGrants/client/Client.d.ts +4 -4
- package/dist/cjs/management/api/resources/clientGrants/client/Client.js +4 -4
- package/dist/cjs/management/api/resources/clientGrants/resources/organizations/client/Client.d.ts +1 -0
- package/dist/cjs/management/api/resources/clientGrants/resources/organizations/client/Client.js +3 -0
- package/dist/cjs/management/api/resources/clients/client/Client.d.ts +68 -85
- package/dist/cjs/management/api/resources/clients/client/Client.js +68 -85
- package/dist/cjs/management/api/resources/clients/resources/connections/client/Client.d.ts +4 -9
- package/dist/cjs/management/api/resources/clients/resources/connections/client/Client.js +4 -9
- package/dist/cjs/management/api/resources/clients/resources/credentials/client/Client.d.ts +38 -14
- package/dist/cjs/management/api/resources/clients/resources/credentials/client/Client.js +38 -14
- package/dist/cjs/management/api/resources/connectionProfiles/client/Client.d.ts +1 -0
- package/dist/cjs/management/api/resources/connectionProfiles/client/Client.js +3 -0
- package/dist/cjs/management/api/resources/connections/resources/users/client/Client.d.ts +1 -0
- package/dist/cjs/management/api/resources/connections/resources/users/client/Client.js +3 -0
- package/dist/cjs/management/api/resources/customDomains/client/Client.d.ts +1 -0
- package/dist/cjs/management/api/resources/customDomains/client/Client.js +3 -0
- package/dist/cjs/management/api/resources/emails/resources/provider/client/Client.d.ts +50 -81
- package/dist/cjs/management/api/resources/emails/resources/provider/client/Client.js +50 -81
- package/dist/cjs/management/api/resources/groups/resources/members/client/Client.d.ts +1 -0
- package/dist/cjs/management/api/resources/groups/resources/members/client/Client.js +3 -0
- package/dist/cjs/management/api/resources/groups/resources/roles/client/Client.d.ts +5 -3
- package/dist/cjs/management/api/resources/groups/resources/roles/client/Client.js +9 -3
- package/dist/cjs/management/api/resources/organizations/client/Client.d.ts +2 -0
- package/dist/cjs/management/api/resources/organizations/client/Client.js +6 -0
- package/dist/cjs/management/api/resources/organizations/resources/connections/client/Client.d.ts +1 -0
- package/dist/cjs/management/api/resources/organizations/resources/connections/client/Client.js +3 -0
- package/dist/cjs/management/api/resources/organizations/resources/enabledConnections/client/Client.d.ts +5 -0
- package/dist/cjs/management/api/resources/organizations/resources/enabledConnections/client/Client.js +15 -0
- package/dist/cjs/management/api/resources/organizations/resources/groups/client/Client.d.ts +1 -0
- package/dist/cjs/management/api/resources/organizations/resources/groups/client/Client.js +3 -0
- package/dist/cjs/management/api/resources/organizations/resources/groups/resources/roles/client/Client.d.ts +3 -0
- package/dist/cjs/management/api/resources/organizations/resources/groups/resources/roles/client/Client.js +9 -0
- package/dist/cjs/management/api/resources/organizations/resources/members/client/Client.d.ts +1 -0
- package/dist/cjs/management/api/resources/organizations/resources/members/client/Client.js +3 -0
- package/dist/cjs/management/api/resources/organizations/resources/members/resources/effectiveRoles/client/Client.d.ts +1 -0
- package/dist/cjs/management/api/resources/organizations/resources/members/resources/effectiveRoles/client/Client.js +3 -0
- package/dist/cjs/management/api/resources/organizations/resources/members/resources/effectiveRoles/resources/sources/resources/groups/client/Client.d.ts +1 -0
- package/dist/cjs/management/api/resources/organizations/resources/members/resources/effectiveRoles/resources/sources/resources/groups/client/Client.js +3 -0
- package/dist/cjs/management/api/resources/organizations/resources/members/resources/roles/client/Client.d.ts +1 -0
- package/dist/cjs/management/api/resources/organizations/resources/members/resources/roles/client/Client.js +3 -0
- package/dist/cjs/management/api/resources/refreshTokens/client/Client.d.ts +1 -1
- package/dist/cjs/management/api/resources/refreshTokens/client/Client.js +1 -1
- package/dist/cjs/management/api/resources/roles/resources/groups/client/Client.d.ts +2 -0
- package/dist/cjs/management/api/resources/roles/resources/groups/client/Client.js +6 -0
- package/dist/cjs/management/api/resources/roles/resources/permissions/client/Client.d.ts +1 -0
- package/dist/cjs/management/api/resources/roles/resources/permissions/client/Client.js +3 -0
- package/dist/cjs/management/api/resources/selfServiceProfiles/resources/ssoTicket/client/Client.d.ts +1 -0
- package/dist/cjs/management/api/resources/selfServiceProfiles/resources/ssoTicket/client/Client.js +3 -0
- package/dist/cjs/management/api/resources/tokenExchangeProfiles/client/Client.d.ts +10 -12
- package/dist/cjs/management/api/resources/tokenExchangeProfiles/client/Client.js +12 -12
- package/dist/cjs/management/api/resources/userAttributeProfiles/client/Client.d.ts +1 -0
- package/dist/cjs/management/api/resources/userAttributeProfiles/client/Client.js +3 -0
- package/dist/cjs/management/api/resources/userGrants/client/Client.d.ts +1 -1
- package/dist/cjs/management/api/resources/userGrants/client/Client.js +1 -1
- package/dist/cjs/management/api/resources/users/resources/effectiveRoles/client/Client.d.ts +1 -0
- package/dist/cjs/management/api/resources/users/resources/effectiveRoles/client/Client.js +3 -0
- package/dist/cjs/management/api/resources/users/resources/effectiveRoles/resources/sources/resources/groups/client/Client.d.ts +1 -0
- package/dist/cjs/management/api/resources/users/resources/effectiveRoles/resources/sources/resources/groups/client/Client.js +3 -0
- package/dist/cjs/management/api/resources/users/resources/groups/client/Client.d.ts +1 -0
- package/dist/cjs/management/api/resources/users/resources/groups/client/Client.js +3 -0
- package/dist/cjs/management/api/resources/users/resources/organizations/client/Client.d.ts +1 -0
- package/dist/cjs/management/api/resources/users/resources/organizations/client/Client.js +3 -0
- package/dist/cjs/management/api/resources/users/resources/permissions/client/Client.d.ts +2 -0
- package/dist/cjs/management/api/resources/users/resources/permissions/client/Client.js +6 -0
- package/dist/cjs/management/api/resources/users/resources/roles/client/Client.d.ts +2 -0
- package/dist/cjs/management/api/resources/users/resources/roles/client/Client.js +6 -0
- package/dist/cjs/management/api/types/types.d.ts +131 -77
- package/dist/cjs/management/api/types/types.js +29 -45
- package/dist/cjs/management/version.d.ts +1 -1
- package/dist/cjs/management/version.js +1 -1
- package/dist/esm/lib/retry.d.mts +7 -2
- package/dist/esm/lib/retry.mjs +35 -5
- package/dist/esm/management/api/requests/requests.d.mts +12 -2
- package/dist/esm/management/api/resources/branding/resources/phone/resources/providers/client/Client.d.mts +6 -6
- package/dist/esm/management/api/resources/branding/resources/phone/resources/providers/client/Client.mjs +6 -6
- package/dist/esm/management/api/resources/clientGrants/client/Client.d.mts +4 -4
- package/dist/esm/management/api/resources/clientGrants/client/Client.mjs +4 -4
- package/dist/esm/management/api/resources/clientGrants/resources/organizations/client/Client.d.mts +1 -0
- package/dist/esm/management/api/resources/clientGrants/resources/organizations/client/Client.mjs +3 -0
- package/dist/esm/management/api/resources/clients/client/Client.d.mts +68 -85
- package/dist/esm/management/api/resources/clients/client/Client.mjs +68 -85
- package/dist/esm/management/api/resources/clients/resources/connections/client/Client.d.mts +4 -9
- package/dist/esm/management/api/resources/clients/resources/connections/client/Client.mjs +4 -9
- package/dist/esm/management/api/resources/clients/resources/credentials/client/Client.d.mts +38 -14
- package/dist/esm/management/api/resources/clients/resources/credentials/client/Client.mjs +38 -14
- package/dist/esm/management/api/resources/connectionProfiles/client/Client.d.mts +1 -0
- package/dist/esm/management/api/resources/connectionProfiles/client/Client.mjs +3 -0
- package/dist/esm/management/api/resources/connections/resources/users/client/Client.d.mts +1 -0
- package/dist/esm/management/api/resources/connections/resources/users/client/Client.mjs +3 -0
- package/dist/esm/management/api/resources/customDomains/client/Client.d.mts +1 -0
- package/dist/esm/management/api/resources/customDomains/client/Client.mjs +3 -0
- package/dist/esm/management/api/resources/emails/resources/provider/client/Client.d.mts +50 -81
- package/dist/esm/management/api/resources/emails/resources/provider/client/Client.mjs +50 -81
- package/dist/esm/management/api/resources/groups/resources/members/client/Client.d.mts +1 -0
- package/dist/esm/management/api/resources/groups/resources/members/client/Client.mjs +3 -0
- package/dist/esm/management/api/resources/groups/resources/roles/client/Client.d.mts +5 -3
- package/dist/esm/management/api/resources/groups/resources/roles/client/Client.mjs +9 -3
- package/dist/esm/management/api/resources/organizations/client/Client.d.mts +2 -0
- package/dist/esm/management/api/resources/organizations/client/Client.mjs +6 -0
- package/dist/esm/management/api/resources/organizations/resources/connections/client/Client.d.mts +1 -0
- package/dist/esm/management/api/resources/organizations/resources/connections/client/Client.mjs +3 -0
- package/dist/esm/management/api/resources/organizations/resources/enabledConnections/client/Client.d.mts +5 -0
- package/dist/esm/management/api/resources/organizations/resources/enabledConnections/client/Client.mjs +15 -0
- package/dist/esm/management/api/resources/organizations/resources/groups/client/Client.d.mts +1 -0
- package/dist/esm/management/api/resources/organizations/resources/groups/client/Client.mjs +3 -0
- package/dist/esm/management/api/resources/organizations/resources/groups/resources/roles/client/Client.d.mts +3 -0
- package/dist/esm/management/api/resources/organizations/resources/groups/resources/roles/client/Client.mjs +9 -0
- package/dist/esm/management/api/resources/organizations/resources/members/client/Client.d.mts +1 -0
- package/dist/esm/management/api/resources/organizations/resources/members/client/Client.mjs +3 -0
- package/dist/esm/management/api/resources/organizations/resources/members/resources/effectiveRoles/client/Client.d.mts +1 -0
- package/dist/esm/management/api/resources/organizations/resources/members/resources/effectiveRoles/client/Client.mjs +3 -0
- package/dist/esm/management/api/resources/organizations/resources/members/resources/effectiveRoles/resources/sources/resources/groups/client/Client.d.mts +1 -0
- package/dist/esm/management/api/resources/organizations/resources/members/resources/effectiveRoles/resources/sources/resources/groups/client/Client.mjs +3 -0
- package/dist/esm/management/api/resources/organizations/resources/members/resources/roles/client/Client.d.mts +1 -0
- package/dist/esm/management/api/resources/organizations/resources/members/resources/roles/client/Client.mjs +3 -0
- package/dist/esm/management/api/resources/refreshTokens/client/Client.d.mts +1 -1
- package/dist/esm/management/api/resources/refreshTokens/client/Client.mjs +1 -1
- package/dist/esm/management/api/resources/roles/resources/groups/client/Client.d.mts +2 -0
- package/dist/esm/management/api/resources/roles/resources/groups/client/Client.mjs +6 -0
- package/dist/esm/management/api/resources/roles/resources/permissions/client/Client.d.mts +1 -0
- package/dist/esm/management/api/resources/roles/resources/permissions/client/Client.mjs +3 -0
- package/dist/esm/management/api/resources/selfServiceProfiles/resources/ssoTicket/client/Client.d.mts +1 -0
- package/dist/esm/management/api/resources/selfServiceProfiles/resources/ssoTicket/client/Client.mjs +3 -0
- package/dist/esm/management/api/resources/tokenExchangeProfiles/client/Client.d.mts +10 -12
- package/dist/esm/management/api/resources/tokenExchangeProfiles/client/Client.mjs +12 -12
- package/dist/esm/management/api/resources/userAttributeProfiles/client/Client.d.mts +1 -0
- package/dist/esm/management/api/resources/userAttributeProfiles/client/Client.mjs +3 -0
- package/dist/esm/management/api/resources/userGrants/client/Client.d.mts +1 -1
- package/dist/esm/management/api/resources/userGrants/client/Client.mjs +1 -1
- package/dist/esm/management/api/resources/users/resources/effectiveRoles/client/Client.d.mts +1 -0
- package/dist/esm/management/api/resources/users/resources/effectiveRoles/client/Client.mjs +3 -0
- package/dist/esm/management/api/resources/users/resources/effectiveRoles/resources/sources/resources/groups/client/Client.d.mts +1 -0
- package/dist/esm/management/api/resources/users/resources/effectiveRoles/resources/sources/resources/groups/client/Client.mjs +3 -0
- package/dist/esm/management/api/resources/users/resources/groups/client/Client.d.mts +1 -0
- package/dist/esm/management/api/resources/users/resources/groups/client/Client.mjs +3 -0
- package/dist/esm/management/api/resources/users/resources/organizations/client/Client.d.mts +1 -0
- package/dist/esm/management/api/resources/users/resources/organizations/client/Client.mjs +3 -0
- package/dist/esm/management/api/resources/users/resources/permissions/client/Client.d.mts +2 -0
- package/dist/esm/management/api/resources/users/resources/permissions/client/Client.mjs +6 -0
- package/dist/esm/management/api/resources/users/resources/roles/client/Client.d.mts +2 -0
- package/dist/esm/management/api/resources/users/resources/roles/client/Client.mjs +6 -0
- package/dist/esm/management/api/types/types.d.mts +131 -77
- package/dist/esm/management/api/types/types.mjs +16 -32
- 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 +223 -261
package/dist/cjs/lib/retry.d.ts
CHANGED
|
@@ -10,11 +10,16 @@ export interface RetryConfiguration {
|
|
|
10
10
|
enabled?: boolean;
|
|
11
11
|
/**
|
|
12
12
|
* Configure the max amount of retries the SDK should do.
|
|
13
|
-
* Defaults to
|
|
13
|
+
* Defaults to 3.
|
|
14
|
+
* Note: this budget is shared between HTTP status code retries (e.g. 429) and
|
|
15
|
+
* transient network error retries (e.g. ECONNRESET). For example, with maxRetries: 3,
|
|
16
|
+
* 2 network retries and 1 status code retry would exhaust the full budget.
|
|
14
17
|
*/
|
|
15
18
|
maxRetries?: number;
|
|
16
19
|
/**
|
|
17
|
-
* Status Codes on which the SDK should trigger retries.
|
|
20
|
+
* HTTP Status Codes on which the SDK should trigger retries.
|
|
21
|
+
* Note: transient network errors (ECONNRESET, EPIPE, ECONNABORTED) are always retried
|
|
22
|
+
* up to maxRetries regardless of this setting. Use `enabled: false` to disable all retries.
|
|
18
23
|
* Defaults to [429].
|
|
19
24
|
*/
|
|
20
25
|
retryWhen?: number[];
|
package/dist/cjs/lib/retry.js
CHANGED
|
@@ -10,6 +10,7 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
|
|
|
10
10
|
};
|
|
11
11
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
12
12
|
exports.retry = retry;
|
|
13
|
+
const errors_js_1 = require("./errors.js");
|
|
13
14
|
const MAX_REQUEST_RETRY_JITTER = 250;
|
|
14
15
|
const MAX_REQUEST_RETRY_DELAY = 10000;
|
|
15
16
|
const DEFAULT_NUMBER_RETRIES = 3;
|
|
@@ -38,6 +39,25 @@ function pause(delay) {
|
|
|
38
39
|
return new Promise((resolve) => setTimeout(resolve, delay));
|
|
39
40
|
});
|
|
40
41
|
}
|
|
42
|
+
// Transient network errors that are safe to retry — failures that can self-heal
|
|
43
|
+
// without any config change (socket reset, broken pipe, aborted connection).
|
|
44
|
+
// Deliberately excludes ENOTFOUND, ECONNREFUSED, cert errors — those won't self-heal.
|
|
45
|
+
const RETRYABLE_ERROR_CODES = new Set(["ECONNRESET", "EPIPE", "ECONNABORTED"]);
|
|
46
|
+
function isRetryableNetworkError(e) {
|
|
47
|
+
var _a, _b, _c;
|
|
48
|
+
if (typeof e !== "object" || e === null)
|
|
49
|
+
return false;
|
|
50
|
+
// Check both e.code (old request-lib / nock shape) and e.cause.code
|
|
51
|
+
// (native fetch / undici shape: TypeError: fetch failed { cause: { code } })
|
|
52
|
+
const err = e;
|
|
53
|
+
const code = (_c = (_a = err.code) !== null && _a !== void 0 ? _a : (_b = err.cause) === null || _b === void 0 ? void 0 : _b.code) !== null && _c !== void 0 ? _c : "";
|
|
54
|
+
return RETRYABLE_ERROR_CODES.has(code);
|
|
55
|
+
}
|
|
56
|
+
function calculateWait(nrOfTries) {
|
|
57
|
+
let wait = BASE_DELAY * Math.pow(2, nrOfTries - 1);
|
|
58
|
+
wait = getRandomInt(wait + 1, wait + MAX_REQUEST_RETRY_JITTER);
|
|
59
|
+
return Math.min(wait, MAX_REQUEST_RETRY_DELAY);
|
|
60
|
+
}
|
|
41
61
|
/**
|
|
42
62
|
* @private
|
|
43
63
|
* Function that retries the provided action callback for a configurable amount of time, defaults to 3.
|
|
@@ -47,13 +67,23 @@ function retry(action, { maxRetries, retryWhen }) {
|
|
|
47
67
|
let nrOfTries = 0;
|
|
48
68
|
const retryAndWait = () => __awaiter(this, void 0, void 0, function* () {
|
|
49
69
|
let result;
|
|
50
|
-
|
|
70
|
+
try {
|
|
71
|
+
result = yield action();
|
|
72
|
+
}
|
|
73
|
+
catch (e) {
|
|
74
|
+
if (e instanceof errors_js_1.TimeoutError) {
|
|
75
|
+
throw e;
|
|
76
|
+
}
|
|
77
|
+
if (isRetryableNetworkError(e) && nrOfTries < nrOfTriesToAttempt) {
|
|
78
|
+
nrOfTries++;
|
|
79
|
+
yield pause(calculateWait(nrOfTries));
|
|
80
|
+
return retryAndWait();
|
|
81
|
+
}
|
|
82
|
+
throw e;
|
|
83
|
+
}
|
|
51
84
|
if ((retryWhen || [429]).includes(result.status) && nrOfTries < nrOfTriesToAttempt) {
|
|
52
85
|
nrOfTries++;
|
|
53
|
-
|
|
54
|
-
wait = getRandomInt(wait + 1, wait + MAX_REQUEST_RETRY_JITTER);
|
|
55
|
-
wait = Math.min(wait, MAX_REQUEST_RETRY_DELAY);
|
|
56
|
-
yield pause(wait);
|
|
86
|
+
yield pause(calculateWait(nrOfTries));
|
|
57
87
|
result = yield retryAndWait();
|
|
58
88
|
}
|
|
59
89
|
return result;
|
|
@@ -103,7 +103,6 @@ export interface UpdateBrandingRequestContent {
|
|
|
103
103
|
favicon_url?: string | null;
|
|
104
104
|
/** URL for the logo. Must use HTTPS. */
|
|
105
105
|
logo_url?: string | null;
|
|
106
|
-
identifiers?: Management.UpdateBrandingIdentifiers | null;
|
|
107
106
|
font?: Management.UpdateBrandingFont | null;
|
|
108
107
|
}
|
|
109
108
|
/**
|
|
@@ -1286,7 +1285,7 @@ export interface RevokeRefreshTokensRequestContent {
|
|
|
1286
1285
|
ids?: string[];
|
|
1287
1286
|
/** Revoke all refresh tokens for this user. */
|
|
1288
1287
|
user_id?: string;
|
|
1289
|
-
/** Revoke
|
|
1288
|
+
/** Revoke refresh tokens for this client. Must be paired with `user_id`; optionally narrowed further with `audience`. */
|
|
1290
1289
|
client_id?: string;
|
|
1291
1290
|
/** Resource server identifier (audience) to scope the revocation. Must be used with both `user_id` and `client_id`. */
|
|
1292
1291
|
audience?: string;
|
|
@@ -3648,12 +3647,20 @@ export interface UpdateTenantSettingsRequestContent {
|
|
|
3648
3647
|
allowed_logout_urls?: string[];
|
|
3649
3648
|
/** Number of hours a session will stay valid. */
|
|
3650
3649
|
session_lifetime?: number;
|
|
3650
|
+
/** Number of minutes a session will stay valid. Cannot be specified together with `session_lifetime`. */
|
|
3651
|
+
session_lifetime_in_minutes?: number;
|
|
3651
3652
|
/** Number of hours for which a session can be inactive before the user must log in again. */
|
|
3652
3653
|
idle_session_lifetime?: number;
|
|
3654
|
+
/** Number of minutes a session can be inactive before the user must log in again. Cannot be specified together with `idle_session_lifetime`. */
|
|
3655
|
+
idle_session_lifetime_in_minutes?: number;
|
|
3653
3656
|
/** Number of hours an ephemeral (non-persistent) session will stay valid. */
|
|
3654
3657
|
ephemeral_session_lifetime?: number;
|
|
3655
3658
|
/** Number of hours for which an ephemeral (non-persistent) session can be inactive before the user must log in again. */
|
|
3656
3659
|
idle_ephemeral_session_lifetime?: number;
|
|
3660
|
+
/** Number of minutes an ephemeral (non-persistent) session will stay valid. Cannot be specified together with `ephemeral_session_lifetime`. */
|
|
3661
|
+
ephemeral_session_lifetime_in_minutes?: number;
|
|
3662
|
+
/** Number of minutes an ephemeral (non-persistent) session can be inactive before the user must log in again. Cannot be specified together with `idle_ephemeral_session_lifetime`. */
|
|
3663
|
+
idle_ephemeral_session_lifetime_in_minutes?: number;
|
|
3657
3664
|
/** Selected sandbox version for the extensibility environment */
|
|
3658
3665
|
sandbox_version?: string;
|
|
3659
3666
|
/** Selected legacy sandbox version for the extensibility environment */
|
|
@@ -3662,6 +3669,7 @@ export interface UpdateTenantSettingsRequestContent {
|
|
|
3662
3669
|
default_redirection_uri?: string;
|
|
3663
3670
|
/** Supported locales for the user interface */
|
|
3664
3671
|
enabled_locales?: Management.TenantSettingsSupportedLocalesEnum[];
|
|
3672
|
+
security_headers?: Management.TenantSettingsNullableSecurityHeaders | null;
|
|
3665
3673
|
session_cookie?: Management.SessionCookieSchema | null;
|
|
3666
3674
|
sessions?: Management.TenantSettingsSessions | null;
|
|
3667
3675
|
oidc_logout?: Management.TenantOidcLogoutSettings;
|
|
@@ -3689,6 +3697,8 @@ export interface UpdateTenantSettingsRequestContent {
|
|
|
3689
3697
|
enable_ai_guide?: boolean;
|
|
3690
3698
|
/** Whether Phone Consolidated Experience is enabled for this tenant. */
|
|
3691
3699
|
phone_consolidated_experience?: boolean;
|
|
3700
|
+
/** Whether session metadata is included in specific tenant logs (slo, oidc_backchannel_logout_failed, oidc_backchannel_logout_succeeded). */
|
|
3701
|
+
include_session_metadata_in_tenant_logs?: boolean;
|
|
3692
3702
|
dynamic_client_registration_security_mode?: Management.TenantSettingsDynamicClientRegistrationSecurityMode;
|
|
3693
3703
|
country_codes?: Management.TenantSettingsCountryCodes | null;
|
|
3694
3704
|
}
|
|
@@ -11,7 +11,7 @@ export declare class ProvidersClient {
|
|
|
11
11
|
protected readonly _options: NormalizedClientOptionsWithAuth<ProvidersClient.Options>;
|
|
12
12
|
constructor(options: ProvidersClient.Options);
|
|
13
13
|
/**
|
|
14
|
-
* Retrieve a list of
|
|
14
|
+
* Retrieve a list of [phone providers](https://auth0.com/docs/customize/phone-messages/configure-phone-messaging-providers) details set for a Tenant. A list of fields to include or exclude may also be specified.
|
|
15
15
|
*
|
|
16
16
|
* @param {Management.ListBrandingPhoneProvidersRequestParameters} request
|
|
17
17
|
* @param {ProvidersClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
@@ -29,8 +29,8 @@ export declare class ProvidersClient {
|
|
|
29
29
|
list(request?: Management.ListBrandingPhoneProvidersRequestParameters, requestOptions?: ProvidersClient.RequestOptions): core.HttpResponsePromise<Management.ListBrandingPhoneProvidersResponseContent>;
|
|
30
30
|
private __list;
|
|
31
31
|
/**
|
|
32
|
-
* Create a
|
|
33
|
-
* The
|
|
32
|
+
* Create a [phone provider](https://auth0.com/docs/customize/phone-messages/configure-phone-messaging-providers).
|
|
33
|
+
* The `credentials` object requires different properties depending on the phone provider (which is specified using the `name` property).
|
|
34
34
|
*
|
|
35
35
|
* @param {Management.CreateBrandingPhoneProviderRequestContent} request
|
|
36
36
|
* @param {ProvidersClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
@@ -52,7 +52,7 @@ export declare class ProvidersClient {
|
|
|
52
52
|
create(request: Management.CreateBrandingPhoneProviderRequestContent, requestOptions?: ProvidersClient.RequestOptions): core.HttpResponsePromise<Management.CreateBrandingPhoneProviderResponseContent>;
|
|
53
53
|
private __create;
|
|
54
54
|
/**
|
|
55
|
-
* Retrieve
|
|
55
|
+
* Retrieve [phone provider](https://auth0.com/docs/customize/phone-messages/configure-phone-messaging-providers) details. A list of fields to include or exclude may also be specified.
|
|
56
56
|
*
|
|
57
57
|
* @param {string} id
|
|
58
58
|
* @param {ProvidersClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
@@ -85,8 +85,8 @@ export declare class ProvidersClient {
|
|
|
85
85
|
delete(id: string, requestOptions?: ProvidersClient.RequestOptions): core.HttpResponsePromise<void>;
|
|
86
86
|
private __delete;
|
|
87
87
|
/**
|
|
88
|
-
* Update a
|
|
89
|
-
* The
|
|
88
|
+
* Update a [phone provider](https://auth0.com/docs/customize/phone-messages/configure-phone-messaging-providers).
|
|
89
|
+
* The `credentials` object requires different properties depending on the phone provider (which is specified using the `name` property).
|
|
90
90
|
*
|
|
91
91
|
* @param {string} id
|
|
92
92
|
* @param {Management.UpdateBrandingPhoneProviderRequestContent} request
|
|
@@ -56,7 +56,7 @@ class ProvidersClient {
|
|
|
56
56
|
this._options = (0, BaseClient_js_1.normalizeClientOptionsWithAuth)(options);
|
|
57
57
|
}
|
|
58
58
|
/**
|
|
59
|
-
* Retrieve a list of
|
|
59
|
+
* Retrieve a list of [phone providers](https://auth0.com/docs/customize/phone-messages/configure-phone-messaging-providers) details set for a Tenant. A list of fields to include or exclude may also be specified.
|
|
60
60
|
*
|
|
61
61
|
* @param {Management.ListBrandingPhoneProvidersRequestParameters} request
|
|
62
62
|
* @param {ProvidersClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
@@ -126,8 +126,8 @@ class ProvidersClient {
|
|
|
126
126
|
});
|
|
127
127
|
}
|
|
128
128
|
/**
|
|
129
|
-
* Create a
|
|
130
|
-
* The
|
|
129
|
+
* Create a [phone provider](https://auth0.com/docs/customize/phone-messages/configure-phone-messaging-providers).
|
|
130
|
+
* The `credentials` object requires different properties depending on the phone provider (which is specified using the `name` property).
|
|
131
131
|
*
|
|
132
132
|
* @param {Management.CreateBrandingPhoneProviderRequestContent} request
|
|
133
133
|
* @param {ProvidersClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
@@ -198,7 +198,7 @@ class ProvidersClient {
|
|
|
198
198
|
});
|
|
199
199
|
}
|
|
200
200
|
/**
|
|
201
|
-
* Retrieve
|
|
201
|
+
* Retrieve [phone provider](https://auth0.com/docs/customize/phone-messages/configure-phone-messaging-providers) details. A list of fields to include or exclude may also be specified.
|
|
202
202
|
*
|
|
203
203
|
* @param {string} id
|
|
204
204
|
* @param {ProvidersClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
@@ -318,8 +318,8 @@ class ProvidersClient {
|
|
|
318
318
|
});
|
|
319
319
|
}
|
|
320
320
|
/**
|
|
321
|
-
* Update a
|
|
322
|
-
* The
|
|
321
|
+
* Update a [phone provider](https://auth0.com/docs/customize/phone-messages/configure-phone-messaging-providers).
|
|
322
|
+
* The `credentials` object requires different properties depending on the phone provider (which is specified using the `name` property).
|
|
323
323
|
*
|
|
324
324
|
* @param {string} id
|
|
325
325
|
* @param {Management.UpdateBrandingPhoneProviderRequestContent} request
|
|
@@ -14,7 +14,7 @@ export declare class ClientGrantsClient {
|
|
|
14
14
|
constructor(options: ClientGrantsClient.Options);
|
|
15
15
|
get organizations(): OrganizationsClient;
|
|
16
16
|
/**
|
|
17
|
-
* Retrieve a list of
|
|
17
|
+
* Retrieve a list of [client grants](https://auth0.com/docs/get-started/applications/application-access-to-apis-client-grants), including the scopes associated with the application/API pair.
|
|
18
18
|
*
|
|
19
19
|
* @param {Management.ListClientGrantsRequestParameters} request
|
|
20
20
|
* @param {ClientGrantsClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
@@ -36,7 +36,7 @@ export declare class ClientGrantsClient {
|
|
|
36
36
|
*/
|
|
37
37
|
list(request?: Management.ListClientGrantsRequestParameters, requestOptions?: ClientGrantsClient.RequestOptions): Promise<core.Page<Management.ClientGrantResponseContent, Management.ListClientGrantPaginatedResponseContent>>;
|
|
38
38
|
/**
|
|
39
|
-
* Create a client grant for a machine-to-machine login flow. To learn more, read
|
|
39
|
+
* Create a client grant for a machine-to-machine login flow. To learn more, read [Client Credential Flow](https://www.auth0.com/docs/get-started/authentication-and-authorization-flow/client-credentials-flow).
|
|
40
40
|
*
|
|
41
41
|
* @param {Management.CreateClientGrantRequestContent} request
|
|
42
42
|
* @param {ClientGrantsClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
@@ -56,7 +56,7 @@ export declare class ClientGrantsClient {
|
|
|
56
56
|
create(request: Management.CreateClientGrantRequestContent, requestOptions?: ClientGrantsClient.RequestOptions): core.HttpResponsePromise<Management.CreateClientGrantResponseContent>;
|
|
57
57
|
private __create;
|
|
58
58
|
/**
|
|
59
|
-
* Retrieve a single
|
|
59
|
+
* Retrieve a single [client grant](https://auth0.com/docs/get-started/applications/application-access-to-apis-client-grants), including the
|
|
60
60
|
* scopes associated with the application/API pair.
|
|
61
61
|
*
|
|
62
62
|
* @param {string} id - The ID of the client grant to retrieve.
|
|
@@ -73,7 +73,7 @@ export declare class ClientGrantsClient {
|
|
|
73
73
|
get(id: string, requestOptions?: ClientGrantsClient.RequestOptions): core.HttpResponsePromise<Management.GetClientGrantResponseContent>;
|
|
74
74
|
private __get;
|
|
75
75
|
/**
|
|
76
|
-
* Delete the
|
|
76
|
+
* Delete the [Client Credential Flow](https://www.auth0.com/docs/get-started/authentication-and-authorization-flow/client-credentials-flow) from your machine-to-machine application.
|
|
77
77
|
*
|
|
78
78
|
* @param {string} id - ID of the client grant to delete.
|
|
79
79
|
* @param {ClientGrantsClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
@@ -61,7 +61,7 @@ class ClientGrantsClient {
|
|
|
61
61
|
return ((_a = this._organizations) !== null && _a !== void 0 ? _a : (this._organizations = new Client_js_1.OrganizationsClient(this._options)));
|
|
62
62
|
}
|
|
63
63
|
/**
|
|
64
|
-
* Retrieve a list of
|
|
64
|
+
* Retrieve a list of [client grants](https://auth0.com/docs/get-started/applications/application-access-to-apis-client-grants), including the scopes associated with the application/API pair.
|
|
65
65
|
*
|
|
66
66
|
* @param {Management.ListClientGrantsRequestParameters} request
|
|
67
67
|
* @param {ClientGrantsClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
@@ -149,7 +149,7 @@ class ClientGrantsClient {
|
|
|
149
149
|
});
|
|
150
150
|
}
|
|
151
151
|
/**
|
|
152
|
-
* Create a client grant for a machine-to-machine login flow. To learn more, read
|
|
152
|
+
* Create a client grant for a machine-to-machine login flow. To learn more, read [Client Credential Flow](https://www.auth0.com/docs/get-started/authentication-and-authorization-flow/client-credentials-flow).
|
|
153
153
|
*
|
|
154
154
|
* @param {Management.CreateClientGrantRequestContent} request
|
|
155
155
|
* @param {ClientGrantsClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
@@ -220,7 +220,7 @@ class ClientGrantsClient {
|
|
|
220
220
|
});
|
|
221
221
|
}
|
|
222
222
|
/**
|
|
223
|
-
* Retrieve a single
|
|
223
|
+
* Retrieve a single [client grant](https://auth0.com/docs/get-started/applications/application-access-to-apis-client-grants), including the
|
|
224
224
|
* scopes associated with the application/API pair.
|
|
225
225
|
*
|
|
226
226
|
* @param {string} id - The ID of the client grant to retrieve.
|
|
@@ -281,7 +281,7 @@ class ClientGrantsClient {
|
|
|
281
281
|
});
|
|
282
282
|
}
|
|
283
283
|
/**
|
|
284
|
-
* Delete the
|
|
284
|
+
* Delete the [Client Credential Flow](https://www.auth0.com/docs/get-started/authentication-and-authorization-flow/client-credentials-flow) from your machine-to-machine application.
|
|
285
285
|
*
|
|
286
286
|
* @param {string} id - ID of the client grant to delete.
|
|
287
287
|
* @param {ClientGrantsClient.RequestOptions} requestOptions - Request-specific configuration.
|
package/dist/cjs/management/api/resources/clientGrants/resources/organizations/client/Client.d.ts
CHANGED
|
@@ -18,6 +18,7 @@ export declare class OrganizationsClient {
|
|
|
18
18
|
* @throws {@link Management.BadRequestError}
|
|
19
19
|
* @throws {@link Management.UnauthorizedError}
|
|
20
20
|
* @throws {@link Management.ForbiddenError}
|
|
21
|
+
* @throws {@link Management.NotFoundError}
|
|
21
22
|
* @throws {@link Management.TooManyRequestsError}
|
|
22
23
|
*
|
|
23
24
|
* @example
|
package/dist/cjs/management/api/resources/clientGrants/resources/organizations/client/Client.js
CHANGED
|
@@ -63,6 +63,7 @@ class OrganizationsClient {
|
|
|
63
63
|
* @throws {@link Management.BadRequestError}
|
|
64
64
|
* @throws {@link Management.UnauthorizedError}
|
|
65
65
|
* @throws {@link Management.ForbiddenError}
|
|
66
|
+
* @throws {@link Management.NotFoundError}
|
|
66
67
|
* @throws {@link Management.TooManyRequestsError}
|
|
67
68
|
*
|
|
68
69
|
* @example
|
|
@@ -111,6 +112,8 @@ class OrganizationsClient {
|
|
|
111
112
|
throw new Management.UnauthorizedError(_response.error.body, _response.rawResponse);
|
|
112
113
|
case 403:
|
|
113
114
|
throw new Management.ForbiddenError(_response.error.body, _response.rawResponse);
|
|
115
|
+
case 404:
|
|
116
|
+
throw new Management.NotFoundError(_response.error.body, _response.rawResponse);
|
|
114
117
|
case 429:
|
|
115
118
|
throw new Management.TooManyRequestsError(_response.error.body, _response.rawResponse);
|
|
116
119
|
default:
|
|
@@ -18,38 +18,30 @@ export declare class ClientsClient {
|
|
|
18
18
|
get connections(): ConnectionsClient;
|
|
19
19
|
/**
|
|
20
20
|
* Retrieve clients (applications and SSO integrations) matching provided filters. A list of fields to include or exclude may also be specified.
|
|
21
|
-
* For more information, read
|
|
22
|
-
*
|
|
23
|
-
*
|
|
24
|
-
*
|
|
25
|
-
*
|
|
26
|
-
*
|
|
27
|
-
*
|
|
28
|
-
*
|
|
29
|
-
*
|
|
30
|
-
*
|
|
31
|
-
*
|
|
32
|
-
*
|
|
33
|
-
*
|
|
34
|
-
*
|
|
35
|
-
*
|
|
36
|
-
*
|
|
37
|
-
*
|
|
38
|
-
*
|
|
39
|
-
*
|
|
40
|
-
*
|
|
41
|
-
*
|
|
42
|
-
*
|
|
43
|
-
*
|
|
44
|
-
*
|
|
45
|
-
* </li>
|
|
46
|
-
* <li>
|
|
47
|
-
* The following properties can only be retrieved with the
|
|
48
|
-
* <code>read:client_keys</code> or <code>read:client_credentials</code> scope:
|
|
49
|
-
* <code>encryption_key</code>, <code>encryption_key.pub</code>, <code>encryption_key.cert</code>,
|
|
50
|
-
* <code>client_secret</code>, <code>client_authentication_methods</code> and <code>signing_key</code>.
|
|
51
|
-
* </li>
|
|
52
|
-
* </ul>
|
|
21
|
+
* 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).
|
|
22
|
+
*
|
|
23
|
+
* - The following can be retrieved with any scope:
|
|
24
|
+
* `client_id`, `app_type`, `name`, and `description`.
|
|
25
|
+
* - The following properties can only be retrieved with the `read:clients` or
|
|
26
|
+
* `read:client_keys` scope:
|
|
27
|
+
* `callbacks`, `oidc_logout`, `allowed_origins`,
|
|
28
|
+
* `web_origins`, `tenant`, `global`, `config_route`,
|
|
29
|
+
* `callback_url_template`, `jwt_configuration`,
|
|
30
|
+
* `jwt_configuration.lifetime_in_seconds`, `jwt_configuration.secret_encoded`,
|
|
31
|
+
* `jwt_configuration.scopes`, `jwt_configuration.alg`, `api_type`,
|
|
32
|
+
* `logo_uri`, `allowed_clients`, `owners`, `custom_login_page`,
|
|
33
|
+
* `custom_login_page_off`, `sso`, `addons`, `form_template`,
|
|
34
|
+
* `custom_login_page_codeview`, `resource_servers`, `client_metadata`,
|
|
35
|
+
* `mobile`, `mobile.android`, `mobile.ios`, `allowed_logout_urls`,
|
|
36
|
+
* `token_endpoint_auth_method`, `is_first_party`, `oidc_conformant`,
|
|
37
|
+
* `is_token_endpoint_ip_header_trusted`, `initiate_login_uri`, `grant_types`,
|
|
38
|
+
* `refresh_token`, `refresh_token.rotation_type`, `refresh_token.expiration_type`,
|
|
39
|
+
* `refresh_token.leeway`, `refresh_token.token_lifetime`, `refresh_token.policies`, `organization_usage`,
|
|
40
|
+
* `organization_require_behavior`.
|
|
41
|
+
* - The following properties can only be retrieved with the
|
|
42
|
+
* `read:client_keys` or `read:client_credentials` scope:
|
|
43
|
+
* `encryption_key`, `encryption_key.pub`, `encryption_key.cert`,
|
|
44
|
+
* `client_secret`, `client_authentication_methods` and `signing_key`.
|
|
53
45
|
*
|
|
54
46
|
* @param {Management.ListClientsRequestParameters} request
|
|
55
47
|
* @param {ClientsClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
@@ -75,20 +67,20 @@ export declare class ClientsClient {
|
|
|
75
67
|
*/
|
|
76
68
|
list(request?: Management.ListClientsRequestParameters, requestOptions?: ClientsClient.RequestOptions): Promise<core.Page<Management.Client, Management.ListClientsOffsetPaginatedResponseContent>>;
|
|
77
69
|
/**
|
|
78
|
-
* Create a new client (application or SSO integration). For more information, read
|
|
79
|
-
*
|
|
70
|
+
* Create a new client (application or SSO integration). For more information, read [Create Applications](https://www.auth0.com/docs/get-started/auth0-overview/create-applications)
|
|
71
|
+
* [API Endpoints for Single Sign-On](https://www.auth0.com/docs/authenticate/single-sign-on/api-endpoints-for-single-sign-on).
|
|
80
72
|
*
|
|
81
73
|
* Notes:
|
|
82
74
|
* - We recommend leaving the `client_secret` parameter unspecified to allow the generation of a safe secret.
|
|
83
|
-
* - The
|
|
84
|
-
*
|
|
75
|
+
* - The `client_authentication_methods` and `token_endpoint_auth_method` properties are mutually exclusive. Use
|
|
76
|
+
* `client_authentication_methods` to configure the client with Private Key JWT authentication method. Otherwise, use `token_endpoint_auth_method`
|
|
85
77
|
* to configure the client with client secret (basic or post) or with no authentication method (none).
|
|
86
|
-
* - When using
|
|
78
|
+
* - When using `client_authentication_methods` to configure the client with Private Key JWT authentication method, specify fully defined credentials.
|
|
87
79
|
* These credentials will be automatically enabled for Private Key JWT authentication on the client.
|
|
88
|
-
* - To configure
|
|
89
|
-
* - To configure
|
|
80
|
+
* - To configure `client_authentication_methods`, the `create:client_credentials` scope is required.
|
|
81
|
+
* - To configure `client_authentication_methods`, the property `jwt_configuration.alg` must be set to RS256.
|
|
90
82
|
*
|
|
91
|
-
*
|
|
83
|
+
* SSO Integrations created via this endpoint will accept login requests and share user profile information.
|
|
92
84
|
*
|
|
93
85
|
* @param {Management.CreateClientRequestContent} request
|
|
94
86
|
* @param {ClientsClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
@@ -133,16 +125,14 @@ export declare class ClientsClient {
|
|
|
133
125
|
* Idempotent registration for Client ID Metadata Document (CIMD) clients.
|
|
134
126
|
* Uses external_client_id as the unique identifier for upsert operations.
|
|
135
127
|
*
|
|
136
|
-
*
|
|
137
|
-
*
|
|
128
|
+
* **Create:** Returns 201 when a new client is created (requires `create:clients` scope).
|
|
129
|
+
* **Update:** Returns 200 when an existing client is updated (requires `update:clients` scope).
|
|
138
130
|
*
|
|
139
131
|
* This endpoint automatically:
|
|
140
|
-
*
|
|
141
|
-
*
|
|
142
|
-
*
|
|
143
|
-
*
|
|
144
|
-
* <li>Enforces CIMD security policies (HTTPS-only, no shared secrets)</li>
|
|
145
|
-
* </ul>
|
|
132
|
+
* - Fetches and validates the metadata document
|
|
133
|
+
* - Maps CIMD fields to Auth0 client configuration
|
|
134
|
+
* - Creates/rotates credentials from the JWKS
|
|
135
|
+
* - Enforces CIMD security policies (HTTPS-only, no shared secrets)
|
|
146
136
|
*
|
|
147
137
|
* @param {Management.RegisterCimdClientRequestContent} request
|
|
148
138
|
* @param {ClientsClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
@@ -162,36 +152,29 @@ export declare class ClientsClient {
|
|
|
162
152
|
private __registerCimdClient;
|
|
163
153
|
/**
|
|
164
154
|
* 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.
|
|
165
|
-
* For more information, read
|
|
166
|
-
*
|
|
167
|
-
*
|
|
168
|
-
*
|
|
169
|
-
*
|
|
170
|
-
*
|
|
171
|
-
*
|
|
172
|
-
*
|
|
173
|
-
*
|
|
174
|
-
*
|
|
175
|
-
*
|
|
176
|
-
*
|
|
177
|
-
*
|
|
178
|
-
*
|
|
179
|
-
*
|
|
180
|
-
*
|
|
181
|
-
*
|
|
182
|
-
*
|
|
183
|
-
*
|
|
184
|
-
*
|
|
185
|
-
*
|
|
186
|
-
*
|
|
187
|
-
*
|
|
188
|
-
* </li>
|
|
189
|
-
* <li>
|
|
190
|
-
* The following properties can only be retrieved with the <code>read:client_keys</code> or <code>read:client_credentials</code> scopes:
|
|
191
|
-
* <code>encryption_key</code>, <code>encryption_key.pub</code>, <code>encryption_key.cert</code>,
|
|
192
|
-
* <code>client_secret</code>, <code>client_authentication_methods</code> and <code>signing_key</code>.
|
|
193
|
-
* </li>
|
|
194
|
-
* </ul>
|
|
155
|
+
* 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).
|
|
156
|
+
*
|
|
157
|
+
* - The following properties can be retrieved with any of the scopes:
|
|
158
|
+
* `client_id`, `app_type`, `name`, and `description`.
|
|
159
|
+
* - The following properties can only be retrieved with the `read:clients` or
|
|
160
|
+
* `read:client_keys` scopes:
|
|
161
|
+
* `callbacks`, `oidc_logout`, `allowed_origins`,
|
|
162
|
+
* `web_origins`, `tenant`, `global`, `config_route`,
|
|
163
|
+
* `callback_url_template`, `jwt_configuration`,
|
|
164
|
+
* `jwt_configuration.lifetime_in_seconds`, `jwt_configuration.secret_encoded`,
|
|
165
|
+
* `jwt_configuration.scopes`, `jwt_configuration.alg`, `api_type`,
|
|
166
|
+
* `logo_uri`, `allowed_clients`, `owners`, `custom_login_page`,
|
|
167
|
+
* `custom_login_page_off`, `sso`, `addons`, `form_template`,
|
|
168
|
+
* `custom_login_page_codeview`, `resource_servers`, `client_metadata`,
|
|
169
|
+
* `mobile`, `mobile.android`, `mobile.ios`, `allowed_logout_urls`,
|
|
170
|
+
* `token_endpoint_auth_method`, `is_first_party`, `oidc_conformant`,
|
|
171
|
+
* `is_token_endpoint_ip_header_trusted`, `initiate_login_uri`, `grant_types`,
|
|
172
|
+
* `refresh_token`, `refresh_token.rotation_type`, `refresh_token.expiration_type`,
|
|
173
|
+
* `refresh_token.leeway`, `refresh_token.token_lifetime`, `refresh_token.policies`, `organization_usage`,
|
|
174
|
+
* `organization_require_behavior`.
|
|
175
|
+
* - The following properties can only be retrieved with the `read:client_keys` or `read:client_credentials` scopes:
|
|
176
|
+
* `encryption_key`, `encryption_key.pub`, `encryption_key.cert`,
|
|
177
|
+
* `client_secret`, `client_authentication_methods` and `signing_key`.
|
|
195
178
|
*
|
|
196
179
|
* @param {string} id - ID of the client to retrieve.
|
|
197
180
|
* @param {Management.GetClientRequestParameters} request
|
|
@@ -228,15 +211,15 @@ export declare class ClientsClient {
|
|
|
228
211
|
delete(id: string, requestOptions?: ClientsClient.RequestOptions): core.HttpResponsePromise<void>;
|
|
229
212
|
private __delete;
|
|
230
213
|
/**
|
|
231
|
-
* Updates a client's settings. For more information, read
|
|
214
|
+
* Updates a client's settings. 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).
|
|
232
215
|
*
|
|
233
216
|
* Notes:
|
|
234
217
|
* - The `client_secret` and `signing_key` attributes can only be updated with the `update:client_keys` scope.
|
|
235
|
-
* - The
|
|
236
|
-
* - When using
|
|
237
|
-
* - To configure
|
|
238
|
-
* - To configure
|
|
239
|
-
* - To change a client's
|
|
218
|
+
* - The `client_authentication_methods` and `token_endpoint_auth_method` properties are mutually exclusive. Use `client_authentication_methods` to configure the client with Private Key JWT authentication method. Otherwise, use `token_endpoint_auth_method` to configure the client with client secret (basic or post) or with no authentication method (none).
|
|
219
|
+
* - When using `client_authentication_methods` to configure the client with Private Key JWT authentication method, only specify the credential IDs that were generated when creating the credentials on the client.
|
|
220
|
+
* - To configure `client_authentication_methods`, the `update:client_credentials` scope is required.
|
|
221
|
+
* - To configure `client_authentication_methods`, the property `jwt_configuration.alg` must be set to RS256.
|
|
222
|
+
* - To change a client's `is_first_party` property to `false`, the `organization_usage` and `organization_require_behavior` properties must be unset.
|
|
240
223
|
*
|
|
241
224
|
* @param {string} id - ID of the client to update.
|
|
242
225
|
* @param {Management.UpdateClientRequestContent} request
|
|
@@ -258,7 +241,7 @@ export declare class ClientsClient {
|
|
|
258
241
|
*
|
|
259
242
|
* This endpoint cannot be used with clients configured with Private Key JWT authentication method (client_authentication_methods configured with private_key_jwt). The generated secret is NOT base64 encoded.
|
|
260
243
|
*
|
|
261
|
-
* For more information, read
|
|
244
|
+
* For more information, read [Rotate Client Secrets](https://www.auth0.com/docs/get-started/applications/rotate-client-secret).
|
|
262
245
|
*
|
|
263
246
|
* @param {string} id - ID of the client that will rotate secrets.
|
|
264
247
|
* @param {ClientsClient.RequestOptions} requestOptions - Request-specific configuration.
|