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
|
@@ -67,38 +67,30 @@ class ClientsClient {
|
|
|
67
67
|
}
|
|
68
68
|
/**
|
|
69
69
|
* Retrieve clients (applications and SSO integrations) matching provided filters. A list of fields to include or exclude may also be specified.
|
|
70
|
-
* For more information, read
|
|
71
|
-
*
|
|
72
|
-
*
|
|
73
|
-
*
|
|
74
|
-
*
|
|
75
|
-
*
|
|
76
|
-
*
|
|
77
|
-
*
|
|
78
|
-
*
|
|
79
|
-
*
|
|
80
|
-
*
|
|
81
|
-
*
|
|
82
|
-
*
|
|
83
|
-
*
|
|
84
|
-
*
|
|
85
|
-
*
|
|
86
|
-
*
|
|
87
|
-
*
|
|
88
|
-
*
|
|
89
|
-
*
|
|
90
|
-
*
|
|
91
|
-
*
|
|
92
|
-
*
|
|
93
|
-
*
|
|
94
|
-
* </li>
|
|
95
|
-
* <li>
|
|
96
|
-
* The following properties can only be retrieved with the
|
|
97
|
-
* <code>read:client_keys</code> or <code>read:client_credentials</code> scope:
|
|
98
|
-
* <code>encryption_key</code>, <code>encryption_key.pub</code>, <code>encryption_key.cert</code>,
|
|
99
|
-
* <code>client_secret</code>, <code>client_authentication_methods</code> and <code>signing_key</code>.
|
|
100
|
-
* </li>
|
|
101
|
-
* </ul>
|
|
70
|
+
* 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).
|
|
71
|
+
*
|
|
72
|
+
* - The following can be retrieved with any scope:
|
|
73
|
+
* `client_id`, `app_type`, `name`, and `description`.
|
|
74
|
+
* - The following properties can only be retrieved with the `read:clients` or
|
|
75
|
+
* `read:client_keys` scope:
|
|
76
|
+
* `callbacks`, `oidc_logout`, `allowed_origins`,
|
|
77
|
+
* `web_origins`, `tenant`, `global`, `config_route`,
|
|
78
|
+
* `callback_url_template`, `jwt_configuration`,
|
|
79
|
+
* `jwt_configuration.lifetime_in_seconds`, `jwt_configuration.secret_encoded`,
|
|
80
|
+
* `jwt_configuration.scopes`, `jwt_configuration.alg`, `api_type`,
|
|
81
|
+
* `logo_uri`, `allowed_clients`, `owners`, `custom_login_page`,
|
|
82
|
+
* `custom_login_page_off`, `sso`, `addons`, `form_template`,
|
|
83
|
+
* `custom_login_page_codeview`, `resource_servers`, `client_metadata`,
|
|
84
|
+
* `mobile`, `mobile.android`, `mobile.ios`, `allowed_logout_urls`,
|
|
85
|
+
* `token_endpoint_auth_method`, `is_first_party`, `oidc_conformant`,
|
|
86
|
+
* `is_token_endpoint_ip_header_trusted`, `initiate_login_uri`, `grant_types`,
|
|
87
|
+
* `refresh_token`, `refresh_token.rotation_type`, `refresh_token.expiration_type`,
|
|
88
|
+
* `refresh_token.leeway`, `refresh_token.token_lifetime`, `refresh_token.policies`, `organization_usage`,
|
|
89
|
+
* `organization_require_behavior`.
|
|
90
|
+
* - The following properties can only be retrieved with the
|
|
91
|
+
* `read:client_keys` or `read:client_credentials` scope:
|
|
92
|
+
* `encryption_key`, `encryption_key.pub`, `encryption_key.cert`,
|
|
93
|
+
* `client_secret`, `client_authentication_methods` and `signing_key`.
|
|
102
94
|
*
|
|
103
95
|
* @param {Management.ListClientsRequestParameters} request
|
|
104
96
|
* @param {ClientsClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
@@ -197,20 +189,20 @@ class ClientsClient {
|
|
|
197
189
|
});
|
|
198
190
|
}
|
|
199
191
|
/**
|
|
200
|
-
* Create a new client (application or SSO integration). For more information, read
|
|
201
|
-
*
|
|
192
|
+
* 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)
|
|
193
|
+
* [API Endpoints for Single Sign-On](https://www.auth0.com/docs/authenticate/single-sign-on/api-endpoints-for-single-sign-on).
|
|
202
194
|
*
|
|
203
195
|
* Notes:
|
|
204
196
|
* - We recommend leaving the `client_secret` parameter unspecified to allow the generation of a safe secret.
|
|
205
|
-
* - The
|
|
206
|
-
*
|
|
197
|
+
* - The `client_authentication_methods` and `token_endpoint_auth_method` properties are mutually exclusive. Use
|
|
198
|
+
* `client_authentication_methods` to configure the client with Private Key JWT authentication method. Otherwise, use `token_endpoint_auth_method`
|
|
207
199
|
* to configure the client with client secret (basic or post) or with no authentication method (none).
|
|
208
|
-
* - When using
|
|
200
|
+
* - When using `client_authentication_methods` to configure the client with Private Key JWT authentication method, specify fully defined credentials.
|
|
209
201
|
* These credentials will be automatically enabled for Private Key JWT authentication on the client.
|
|
210
|
-
* - To configure
|
|
211
|
-
* - To configure
|
|
202
|
+
* - To configure `client_authentication_methods`, the `create:client_credentials` scope is required.
|
|
203
|
+
* - To configure `client_authentication_methods`, the property `jwt_configuration.alg` must be set to RS256.
|
|
212
204
|
*
|
|
213
|
-
*
|
|
205
|
+
* SSO Integrations created via this endpoint will accept login requests and share user profile information.
|
|
214
206
|
*
|
|
215
207
|
* @param {Management.CreateClientRequestContent} request
|
|
216
208
|
* @param {ClientsClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
@@ -353,16 +345,14 @@ class ClientsClient {
|
|
|
353
345
|
* Idempotent registration for Client ID Metadata Document (CIMD) clients.
|
|
354
346
|
* Uses external_client_id as the unique identifier for upsert operations.
|
|
355
347
|
*
|
|
356
|
-
*
|
|
357
|
-
*
|
|
348
|
+
* **Create:** Returns 201 when a new client is created (requires `create:clients` scope).
|
|
349
|
+
* **Update:** Returns 200 when an existing client is updated (requires `update:clients` scope).
|
|
358
350
|
*
|
|
359
351
|
* This endpoint automatically:
|
|
360
|
-
*
|
|
361
|
-
*
|
|
362
|
-
*
|
|
363
|
-
*
|
|
364
|
-
* <li>Enforces CIMD security policies (HTTPS-only, no shared secrets)</li>
|
|
365
|
-
* </ul>
|
|
352
|
+
* - Fetches and validates the metadata document
|
|
353
|
+
* - Maps CIMD fields to Auth0 client configuration
|
|
354
|
+
* - Creates/rotates credentials from the JWKS
|
|
355
|
+
* - Enforces CIMD security policies (HTTPS-only, no shared secrets)
|
|
366
356
|
*
|
|
367
357
|
* @param {Management.RegisterCimdClientRequestContent} request
|
|
368
358
|
* @param {ClientsClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
@@ -431,36 +421,29 @@ class ClientsClient {
|
|
|
431
421
|
}
|
|
432
422
|
/**
|
|
433
423
|
* 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.
|
|
434
|
-
* For more information, read
|
|
435
|
-
*
|
|
436
|
-
*
|
|
437
|
-
*
|
|
438
|
-
*
|
|
439
|
-
*
|
|
440
|
-
*
|
|
441
|
-
*
|
|
442
|
-
*
|
|
443
|
-
*
|
|
444
|
-
*
|
|
445
|
-
*
|
|
446
|
-
*
|
|
447
|
-
*
|
|
448
|
-
*
|
|
449
|
-
*
|
|
450
|
-
*
|
|
451
|
-
*
|
|
452
|
-
*
|
|
453
|
-
*
|
|
454
|
-
*
|
|
455
|
-
*
|
|
456
|
-
*
|
|
457
|
-
* </li>
|
|
458
|
-
* <li>
|
|
459
|
-
* The following properties can only be retrieved with the <code>read:client_keys</code> or <code>read:client_credentials</code> scopes:
|
|
460
|
-
* <code>encryption_key</code>, <code>encryption_key.pub</code>, <code>encryption_key.cert</code>,
|
|
461
|
-
* <code>client_secret</code>, <code>client_authentication_methods</code> and <code>signing_key</code>.
|
|
462
|
-
* </li>
|
|
463
|
-
* </ul>
|
|
424
|
+
* 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).
|
|
425
|
+
*
|
|
426
|
+
* - The following properties can be retrieved with any of the scopes:
|
|
427
|
+
* `client_id`, `app_type`, `name`, and `description`.
|
|
428
|
+
* - The following properties can only be retrieved with the `read:clients` or
|
|
429
|
+
* `read:client_keys` scopes:
|
|
430
|
+
* `callbacks`, `oidc_logout`, `allowed_origins`,
|
|
431
|
+
* `web_origins`, `tenant`, `global`, `config_route`,
|
|
432
|
+
* `callback_url_template`, `jwt_configuration`,
|
|
433
|
+
* `jwt_configuration.lifetime_in_seconds`, `jwt_configuration.secret_encoded`,
|
|
434
|
+
* `jwt_configuration.scopes`, `jwt_configuration.alg`, `api_type`,
|
|
435
|
+
* `logo_uri`, `allowed_clients`, `owners`, `custom_login_page`,
|
|
436
|
+
* `custom_login_page_off`, `sso`, `addons`, `form_template`,
|
|
437
|
+
* `custom_login_page_codeview`, `resource_servers`, `client_metadata`,
|
|
438
|
+
* `mobile`, `mobile.android`, `mobile.ios`, `allowed_logout_urls`,
|
|
439
|
+
* `token_endpoint_auth_method`, `is_first_party`, `oidc_conformant`,
|
|
440
|
+
* `is_token_endpoint_ip_header_trusted`, `initiate_login_uri`, `grant_types`,
|
|
441
|
+
* `refresh_token`, `refresh_token.rotation_type`, `refresh_token.expiration_type`,
|
|
442
|
+
* `refresh_token.leeway`, `refresh_token.token_lifetime`, `refresh_token.policies`, `organization_usage`,
|
|
443
|
+
* `organization_require_behavior`.
|
|
444
|
+
* - The following properties can only be retrieved with the `read:client_keys` or `read:client_credentials` scopes:
|
|
445
|
+
* `encryption_key`, `encryption_key.pub`, `encryption_key.cert`,
|
|
446
|
+
* `client_secret`, `client_authentication_methods` and `signing_key`.
|
|
464
447
|
*
|
|
465
448
|
* @param {string} id - ID of the client to retrieve.
|
|
466
449
|
* @param {Management.GetClientRequestParameters} request
|
|
@@ -590,15 +573,15 @@ class ClientsClient {
|
|
|
590
573
|
});
|
|
591
574
|
}
|
|
592
575
|
/**
|
|
593
|
-
* Updates a client's settings. For more information, read
|
|
576
|
+
* 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).
|
|
594
577
|
*
|
|
595
578
|
* Notes:
|
|
596
579
|
* - The `client_secret` and `signing_key` attributes can only be updated with the `update:client_keys` scope.
|
|
597
|
-
* - The
|
|
598
|
-
* - When using
|
|
599
|
-
* - To configure
|
|
600
|
-
* - To configure
|
|
601
|
-
* - To change a client's
|
|
580
|
+
* - 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).
|
|
581
|
+
* - 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.
|
|
582
|
+
* - To configure `client_authentication_methods`, the `update:client_credentials` scope is required.
|
|
583
|
+
* - To configure `client_authentication_methods`, the property `jwt_configuration.alg` must be set to RS256.
|
|
584
|
+
* - To change a client's `is_first_party` property to `false`, the `organization_usage` and `organization_require_behavior` properties must be unset.
|
|
602
585
|
*
|
|
603
586
|
* @param {string} id - ID of the client to update.
|
|
604
587
|
* @param {Management.UpdateClientRequestContent} request
|
|
@@ -669,7 +652,7 @@ class ClientsClient {
|
|
|
669
652
|
*
|
|
670
653
|
* 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.
|
|
671
654
|
*
|
|
672
|
-
* For more information, read
|
|
655
|
+
* For more information, read [Rotate Client Secrets](https://www.auth0.com/docs/get-started/applications/rotate-client-secret).
|
|
673
656
|
*
|
|
674
657
|
* @param {string} id - ID of the client that will rotate secrets.
|
|
675
658
|
* @param {ClientsClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
@@ -11,15 +11,10 @@ export declare class ConnectionsClient {
|
|
|
11
11
|
protected readonly _options: NormalizedClientOptionsWithAuth<ConnectionsClient.Options>;
|
|
12
12
|
constructor(options: ConnectionsClient.Options);
|
|
13
13
|
/**
|
|
14
|
-
* Retrieve all connections that are enabled for the specified
|
|
15
|
-
*
|
|
16
|
-
*
|
|
17
|
-
*
|
|
18
|
-
* </li>
|
|
19
|
-
* <li>
|
|
20
|
-
* <b>Note</b>: The first time you call this endpoint, omit the <code>from</code> parameter. If there are more results, a <code>next</code> value is included in the response. You can use this for subsequent API calls. When <code>next</code> is no longer included in the response, no further results are remaining.
|
|
21
|
-
* </li>
|
|
22
|
-
* </ul>
|
|
14
|
+
* Retrieve all connections that are enabled for the specified [Application](https://www.auth0.com/docs/get-started/applications), using checkpoint pagination. A list of fields to include or exclude for each connection may also be specified.
|
|
15
|
+
*
|
|
16
|
+
* - This endpoint requires the `read:connections` scope and any one of `read:clients` or `read:client_summary`.
|
|
17
|
+
* - **Note**: The first time you call this endpoint, omit the `from` parameter. If there are more results, a `next` value is included in the response. You can use this for subsequent API calls. When `next` is no longer included in the response, no further results are remaining.
|
|
23
18
|
*
|
|
24
19
|
* @param {string} id - ID of the client for which to retrieve enabled connections.
|
|
25
20
|
* @param {Management.ConnectionsGetRequest} request
|
|
@@ -56,15 +56,10 @@ class ConnectionsClient {
|
|
|
56
56
|
this._options = (0, BaseClient_js_1.normalizeClientOptionsWithAuth)(options);
|
|
57
57
|
}
|
|
58
58
|
/**
|
|
59
|
-
* Retrieve all connections that are enabled for the specified
|
|
60
|
-
*
|
|
61
|
-
*
|
|
62
|
-
*
|
|
63
|
-
* </li>
|
|
64
|
-
* <li>
|
|
65
|
-
* <b>Note</b>: The first time you call this endpoint, omit the <code>from</code> parameter. If there are more results, a <code>next</code> value is included in the response. You can use this for subsequent API calls. When <code>next</code> is no longer included in the response, no further results are remaining.
|
|
66
|
-
* </li>
|
|
67
|
-
* </ul>
|
|
59
|
+
* Retrieve all connections that are enabled for the specified [Application](https://www.auth0.com/docs/get-started/applications), using checkpoint pagination. A list of fields to include or exclude for each connection may also be specified.
|
|
60
|
+
*
|
|
61
|
+
* - This endpoint requires the `read:connections` scope and any one of `read:clients` or `read:client_summary`.
|
|
62
|
+
* - **Note**: The first time you call this endpoint, omit the `from` parameter. If there are more results, a `next` value is included in the response. You can use this for subsequent API calls. When `next` is no longer included in the response, no further results are remaining.
|
|
68
63
|
*
|
|
69
64
|
* @param {string} id - ID of the client for which to retrieve enabled connections.
|
|
70
65
|
* @param {Management.ConnectionsGetRequest} request
|
|
@@ -13,7 +13,7 @@ export declare class CredentialsClient {
|
|
|
13
13
|
/**
|
|
14
14
|
* Get the details of a client credential.
|
|
15
15
|
*
|
|
16
|
-
*
|
|
16
|
+
* **Important**: To enable credentials to be used for a client authentication method, set the `client_authentication_methods` property on the client. To enable credentials to be used for JWT-Secured Authorization requests set the `signed_request_object` property on the client.
|
|
17
17
|
*
|
|
18
18
|
* @param {string} client_id - ID of the client.
|
|
19
19
|
* @param {CredentialsClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
@@ -31,37 +31,61 @@ export declare class CredentialsClient {
|
|
|
31
31
|
/**
|
|
32
32
|
* Create a client credential associated to your application. Credentials can be used to configure Private Key JWT and mTLS authentication methods, as well as for JWT-secured Authorization requests.
|
|
33
33
|
*
|
|
34
|
-
*
|
|
34
|
+
* **Public Key**
|
|
35
35
|
*
|
|
36
|
-
*
|
|
36
|
+
* Public Key credentials can be used to set up Private Key JWT client authentication and JWT-secured Authorization requests.
|
|
37
|
+
*
|
|
38
|
+
* Sample:
|
|
39
|
+
*
|
|
40
|
+
* ```json
|
|
41
|
+
* {
|
|
37
42
|
* "credential_type": "public_key",
|
|
38
43
|
* "name": "string",
|
|
39
44
|
* "pem": "string",
|
|
40
45
|
* "alg": "RS256",
|
|
41
46
|
* "parse_expiry_from_cert": false,
|
|
42
47
|
* "expires_at": "2022-12-31T23:59:59Z"
|
|
43
|
-
* }
|
|
44
|
-
*
|
|
48
|
+
* }
|
|
49
|
+
* ```
|
|
50
|
+
*
|
|
51
|
+
* **Certificate (CA-signed & self-signed)**
|
|
52
|
+
*
|
|
53
|
+
* Certificate credentials can be used to set up mTLS client authentication. CA-signed certificates can be configured either with a signed certificate or with just the certificate Subject DN.
|
|
54
|
+
*
|
|
55
|
+
* CA-signed Certificate Sample (pem):
|
|
45
56
|
*
|
|
46
|
-
*
|
|
57
|
+
* ```json
|
|
58
|
+
* {
|
|
47
59
|
* "credential_type": "x509_cert",
|
|
48
60
|
* "name": "string",
|
|
49
61
|
* "pem": "string"
|
|
50
|
-
* }
|
|
62
|
+
* }
|
|
63
|
+
* ```
|
|
64
|
+
*
|
|
65
|
+
* CA-signed Certificate Sample (subject_dn):
|
|
66
|
+
*
|
|
67
|
+
* ```json
|
|
68
|
+
* {
|
|
51
69
|
* "credential_type": "cert_subject_dn",
|
|
52
70
|
* "name": "string",
|
|
53
71
|
* "subject_dn": "string"
|
|
54
|
-
* }
|
|
72
|
+
* }
|
|
73
|
+
* ```
|
|
74
|
+
*
|
|
75
|
+
* Self-signed Certificate Sample:
|
|
76
|
+
*
|
|
77
|
+
* ```json
|
|
78
|
+
* {
|
|
55
79
|
* "credential_type": "cert_subject_dn",
|
|
56
80
|
* "name": "string",
|
|
57
81
|
* "pem": "string"
|
|
58
|
-
* }
|
|
82
|
+
* }
|
|
83
|
+
* ```
|
|
59
84
|
*
|
|
60
85
|
* The credential will be created but not yet enabled for use until you set the corresponding properties in the client:
|
|
61
|
-
*
|
|
62
|
-
*
|
|
63
|
-
*
|
|
64
|
-
* </ul>
|
|
86
|
+
*
|
|
87
|
+
* - To enable the credential for Private Key JWT or mTLS authentication methods, set the `client_authentication_methods` property on the client. For more information, read [Configure Private Key JWT Authentication](https://auth0.com/docs/get-started/applications/configure-private-key-jwt) and [Configure mTLS Authentication](https://auth0.com/docs/get-started/applications/configure-mtls)
|
|
88
|
+
* - To enable the credential for JWT-secured Authorization requests, set the `signed_request_object`property on the client. For more information, read [Configure JWT-secured Authorization Requests (JAR)](https://auth0.com/docs/get-started/applications/configure-jar)
|
|
65
89
|
*
|
|
66
90
|
* @param {string} client_id - ID of the client.
|
|
67
91
|
* @param {Management.PostClientCredentialRequestContent} request
|
|
@@ -83,7 +107,7 @@ export declare class CredentialsClient {
|
|
|
83
107
|
/**
|
|
84
108
|
* Get the details of a client credential.
|
|
85
109
|
*
|
|
86
|
-
*
|
|
110
|
+
* **Important**: To enable credentials to be used for a client authentication method, set the `client_authentication_methods` property on the client. To enable credentials to be used for JWT-Secured Authorization requests set the `signed_request_object` property on the client.
|
|
87
111
|
*
|
|
88
112
|
* @param {string} client_id - ID of the client.
|
|
89
113
|
* @param {string} credential_id - ID of the credential.
|
|
@@ -58,7 +58,7 @@ class CredentialsClient {
|
|
|
58
58
|
/**
|
|
59
59
|
* Get the details of a client credential.
|
|
60
60
|
*
|
|
61
|
-
*
|
|
61
|
+
* **Important**: To enable credentials to be used for a client authentication method, set the `client_authentication_methods` property on the client. To enable credentials to be used for JWT-Secured Authorization requests set the `signed_request_object` property on the client.
|
|
62
62
|
*
|
|
63
63
|
* @param {string} client_id - ID of the client.
|
|
64
64
|
* @param {CredentialsClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
@@ -117,37 +117,61 @@ class CredentialsClient {
|
|
|
117
117
|
/**
|
|
118
118
|
* Create a client credential associated to your application. Credentials can be used to configure Private Key JWT and mTLS authentication methods, as well as for JWT-secured Authorization requests.
|
|
119
119
|
*
|
|
120
|
-
*
|
|
120
|
+
* **Public Key**
|
|
121
121
|
*
|
|
122
|
-
*
|
|
122
|
+
* Public Key credentials can be used to set up Private Key JWT client authentication and JWT-secured Authorization requests.
|
|
123
|
+
*
|
|
124
|
+
* Sample:
|
|
125
|
+
*
|
|
126
|
+
* ```json
|
|
127
|
+
* {
|
|
123
128
|
* "credential_type": "public_key",
|
|
124
129
|
* "name": "string",
|
|
125
130
|
* "pem": "string",
|
|
126
131
|
* "alg": "RS256",
|
|
127
132
|
* "parse_expiry_from_cert": false,
|
|
128
133
|
* "expires_at": "2022-12-31T23:59:59Z"
|
|
129
|
-
* }
|
|
130
|
-
*
|
|
134
|
+
* }
|
|
135
|
+
* ```
|
|
136
|
+
*
|
|
137
|
+
* **Certificate (CA-signed & self-signed)**
|
|
138
|
+
*
|
|
139
|
+
* Certificate credentials can be used to set up mTLS client authentication. CA-signed certificates can be configured either with a signed certificate or with just the certificate Subject DN.
|
|
140
|
+
*
|
|
141
|
+
* CA-signed Certificate Sample (pem):
|
|
131
142
|
*
|
|
132
|
-
*
|
|
143
|
+
* ```json
|
|
144
|
+
* {
|
|
133
145
|
* "credential_type": "x509_cert",
|
|
134
146
|
* "name": "string",
|
|
135
147
|
* "pem": "string"
|
|
136
|
-
* }
|
|
148
|
+
* }
|
|
149
|
+
* ```
|
|
150
|
+
*
|
|
151
|
+
* CA-signed Certificate Sample (subject_dn):
|
|
152
|
+
*
|
|
153
|
+
* ```json
|
|
154
|
+
* {
|
|
137
155
|
* "credential_type": "cert_subject_dn",
|
|
138
156
|
* "name": "string",
|
|
139
157
|
* "subject_dn": "string"
|
|
140
|
-
* }
|
|
158
|
+
* }
|
|
159
|
+
* ```
|
|
160
|
+
*
|
|
161
|
+
* Self-signed Certificate Sample:
|
|
162
|
+
*
|
|
163
|
+
* ```json
|
|
164
|
+
* {
|
|
141
165
|
* "credential_type": "cert_subject_dn",
|
|
142
166
|
* "name": "string",
|
|
143
167
|
* "pem": "string"
|
|
144
|
-
* }
|
|
168
|
+
* }
|
|
169
|
+
* ```
|
|
145
170
|
*
|
|
146
171
|
* The credential will be created but not yet enabled for use until you set the corresponding properties in the client:
|
|
147
|
-
*
|
|
148
|
-
*
|
|
149
|
-
*
|
|
150
|
-
* </ul>
|
|
172
|
+
*
|
|
173
|
+
* - To enable the credential for Private Key JWT or mTLS authentication methods, set the `client_authentication_methods` property on the client. For more information, read [Configure Private Key JWT Authentication](https://auth0.com/docs/get-started/applications/configure-private-key-jwt) and [Configure mTLS Authentication](https://auth0.com/docs/get-started/applications/configure-mtls)
|
|
174
|
+
* - To enable the credential for JWT-secured Authorization requests, set the `signed_request_object`property on the client. For more information, read [Configure JWT-secured Authorization Requests (JAR)](https://auth0.com/docs/get-started/applications/configure-jar)
|
|
151
175
|
*
|
|
152
176
|
* @param {string} client_id - ID of the client.
|
|
153
177
|
* @param {Management.PostClientCredentialRequestContent} request
|
|
@@ -218,7 +242,7 @@ class CredentialsClient {
|
|
|
218
242
|
/**
|
|
219
243
|
* Get the details of a client credential.
|
|
220
244
|
*
|
|
221
|
-
*
|
|
245
|
+
* **Important**: To enable credentials to be used for a client authentication method, set the `client_authentication_methods` property on the client. To enable credentials to be used for JWT-Secured Authorization requests set the `signed_request_object` property on the client.
|
|
222
246
|
*
|
|
223
247
|
* @param {string} client_id - ID of the client.
|
|
224
248
|
* @param {string} credential_id - ID of the credential.
|
|
@@ -118,6 +118,7 @@ export declare class ConnectionProfilesClient {
|
|
|
118
118
|
* @throws {@link Management.BadRequestError}
|
|
119
119
|
* @throws {@link Management.UnauthorizedError}
|
|
120
120
|
* @throws {@link Management.ForbiddenError}
|
|
121
|
+
* @throws {@link Management.NotFoundError}
|
|
121
122
|
* @throws {@link Management.TooManyRequestsError}
|
|
122
123
|
*
|
|
123
124
|
* @example
|
|
@@ -444,6 +444,7 @@ class ConnectionProfilesClient {
|
|
|
444
444
|
* @throws {@link Management.BadRequestError}
|
|
445
445
|
* @throws {@link Management.UnauthorizedError}
|
|
446
446
|
* @throws {@link Management.ForbiddenError}
|
|
447
|
+
* @throws {@link Management.NotFoundError}
|
|
447
448
|
* @throws {@link Management.TooManyRequestsError}
|
|
448
449
|
*
|
|
449
450
|
* @example
|
|
@@ -485,6 +486,8 @@ class ConnectionProfilesClient {
|
|
|
485
486
|
throw new Management.UnauthorizedError(_response.error.body, _response.rawResponse);
|
|
486
487
|
case 403:
|
|
487
488
|
throw new Management.ForbiddenError(_response.error.body, _response.rawResponse);
|
|
489
|
+
case 404:
|
|
490
|
+
throw new Management.NotFoundError(_response.error.body, _response.rawResponse);
|
|
488
491
|
case 429:
|
|
489
492
|
throw new Management.TooManyRequestsError(_response.error.body, _response.rawResponse);
|
|
490
493
|
default:
|
|
@@ -20,6 +20,7 @@ export declare class UsersClient {
|
|
|
20
20
|
* @throws {@link Management.BadRequestError}
|
|
21
21
|
* @throws {@link Management.UnauthorizedError}
|
|
22
22
|
* @throws {@link Management.ForbiddenError}
|
|
23
|
+
* @throws {@link Management.NotFoundError}
|
|
23
24
|
* @throws {@link Management.TooManyRequestsError}
|
|
24
25
|
*
|
|
25
26
|
* @example
|
|
@@ -65,6 +65,7 @@ class UsersClient {
|
|
|
65
65
|
* @throws {@link Management.BadRequestError}
|
|
66
66
|
* @throws {@link Management.UnauthorizedError}
|
|
67
67
|
* @throws {@link Management.ForbiddenError}
|
|
68
|
+
* @throws {@link Management.NotFoundError}
|
|
68
69
|
* @throws {@link Management.TooManyRequestsError}
|
|
69
70
|
*
|
|
70
71
|
* @example
|
|
@@ -110,6 +111,8 @@ class UsersClient {
|
|
|
110
111
|
throw new Management.UnauthorizedError(_response.error.body, _response.rawResponse);
|
|
111
112
|
case 403:
|
|
112
113
|
throw new Management.ForbiddenError(_response.error.body, _response.rawResponse);
|
|
114
|
+
case 404:
|
|
115
|
+
throw new Management.NotFoundError(_response.error.body, _response.rawResponse);
|
|
113
116
|
case 429:
|
|
114
117
|
throw new Management.TooManyRequestsError(_response.error.body, _response.rawResponse);
|
|
115
118
|
default:
|
|
@@ -118,6 +118,7 @@ export declare class CustomDomainsClient {
|
|
|
118
118
|
* @throws {@link Management.BadRequestError}
|
|
119
119
|
* @throws {@link Management.UnauthorizedError}
|
|
120
120
|
* @throws {@link Management.ForbiddenError}
|
|
121
|
+
* @throws {@link Management.ConflictError}
|
|
121
122
|
* @throws {@link Management.TooManyRequestsError}
|
|
122
123
|
*
|
|
123
124
|
* @example
|
|
@@ -396,6 +396,7 @@ class CustomDomainsClient {
|
|
|
396
396
|
* @throws {@link Management.BadRequestError}
|
|
397
397
|
* @throws {@link Management.UnauthorizedError}
|
|
398
398
|
* @throws {@link Management.ForbiddenError}
|
|
399
|
+
* @throws {@link Management.ConflictError}
|
|
399
400
|
* @throws {@link Management.TooManyRequestsError}
|
|
400
401
|
*
|
|
401
402
|
* @example
|
|
@@ -431,6 +432,8 @@ class CustomDomainsClient {
|
|
|
431
432
|
throw new Management.UnauthorizedError(_response.error.body, _response.rawResponse);
|
|
432
433
|
case 403:
|
|
433
434
|
throw new Management.ForbiddenError(_response.error.body, _response.rawResponse);
|
|
435
|
+
case 409:
|
|
436
|
+
throw new Management.ConflictError(_response.error.body, _response.rawResponse);
|
|
434
437
|
case 429:
|
|
435
438
|
throw new Management.TooManyRequestsError(_response.error.body, _response.rawResponse);
|
|
436
439
|
default:
|