auth0 4.0.0-beta.5 → 4.0.0-beta.6

package/dist/types/management/__generated/managers/clients-manager.d.ts

@@ -1,6 +1,6 @@
 import * as runtime from '../../../lib/runtime.js';
 import type { InitOverride, ApiResponse } from '../../../lib/runtime.js';
-import type { Client, ClientCreate, ClientUpdate, DeleteClientsByIdRequest, GetClientsRequest, GetClientsByIdRequest, PatchClientsByIdRequest, PostRotateSecretRequest } from '../models/index.js';
+import type { Client, ClientCreate, ClientUpdate, GetCredentials200ResponseInner, PatchCredentialsByCredentialIdRequest, PostCredentialsRequest, DeleteClientsByIdRequest, DeleteCredentialsByCredentialIdRequest, GetClientsRequest, GetClientsByIdRequest, GetCredentialsRequest, GetCredentialsByCredentialIdRequest, PatchClientsByIdRequest, PatchCredentialsByCredentialIdOperationRequest, PostCredentialsOperationRequest, PostRotateSecretRequest } from '../models/index.js';
 declare const BaseAPI: typeof runtime.BaseAPI;
 /**
  *
@@ -13,6 +13,12 @@ export declare class ClientsManager extends BaseAPI {
      * @throws {RequiredError}
      */
     delete(requestParameters: DeleteClientsByIdRequest, initOverrides?: InitOverride): Promise<ApiResponse<void>>;
+    /**
+     * Delete a client credential
+     *
+     * @throws {RequiredError}
+     */
+    deleteCredential(requestParameters: DeleteCredentialsByCredentialIdRequest, initOverrides?: InitOverride): Promise<ApiResponse<void>>;
     /**
      * Retrieve clients (applications and SSO integrations) matching provided filters. A list of fields to include or exclude
      * may also be specified. Note:
@@ -32,13 +38,14 @@ export declare class ClientsManager extends BaseAPI {
      *     <code>token_endpoint_auth_method</code>, <code>is_first_party</code>, <code>oidc_conformant</code>,
      *     <code>is_token_endpoint_ip_header_trusted</code>, <code>initiate_login_uri</code>, <code>grant_types</code>,
      *     <code>refresh_token</code>, <code>refresh_token.rotation_type</code>, <code>refresh_token.expiration_type</code>,
-     *     <code>refresh_token.leeway</code>, <code>refresh_token.token_lifetime</code>, <code>organization_usage</code>, and
-     *     <code>organization_require_behavior</code> properties can only be retrieved with the <code>read:clients</code> or
+     *     <code>refresh_token.leeway</code>, <code>refresh_token.token_lifetime</code>, <code>organization_usage</code>,
+     *     <code>organization_require_behavior</code>
+     *     properties can only be retrieved with the <code>read:clients</code> or
      *     <code>read:client_keys</code> scope.
      *   </li>
      *   <li><code>encryption_key</code>, <code>encryption_key.pub</code>, <code>encryption_key.cert</code>,
-     *     <code>client_secret</code>, and <code>signing_key</code> properties can only be retrieved with the
-     *     <code>read:client_keys</code> scope.
+     *     <code>client_secret</code>, <code>client_authentication_methods</code> and <code>signing_key</code> properties can only be retrieved with the
+     *     <code>read:client_keys</code> or <code>read:client_credentials</code> scope.
      *   </li>
      * </ul>
      *
@@ -65,13 +72,14 @@ export declare class ClientsManager extends BaseAPI {
      *     <code>token_endpoint_auth_method</code>, <code>is_first_party</code>, <code>oidc_conformant</code>,
      *     <code>is_token_endpoint_ip_header_trusted</code>, <code>initiate_login_uri</code>, <code>grant_types</code>,
      *     <code>refresh_token</code>, <code>refresh_token.rotation_type</code>, <code>refresh_token.expiration_type</code>,
-     *     <code>refresh_token.leeway</code>, <code>refresh_token.token_lifetime</code>, <code>organization_usage</code>, and
-     *     <code>organization_require_behavior</code> properties can only be retrieved with the <code>read:clients</code> or
+     *     <code>refresh_token.leeway</code>, <code>refresh_token.token_lifetime</code>, <code>organization_usage</code>,
+     *     <code>organization_require_behavior</code>
+     *     properties can only be retrieved with the <code>read:clients</code> or
      *     <code>read:client_keys</code> scope.
      *   </li>
      *   <li><code>encryption_key</code>, <code>encryption_key.pub</code>, <code>encryption_key.cert</code>,
-     *     <code>client_secret</code>, and <code>signing_key</code> properties can only be retrieved with the
-     *     <code>read:client_keys</code> scope.
+     *     <code>client_secret</code>, <code>client_authentication_methods</code> and <code>signing_key</code> properties can only be retrieved with the
+     *     <code>read:client_keys</code> or <code>read:client_credentials</code> scope.
      *   </li>
      * </ul>
      *
@@ -81,16 +89,54 @@ export declare class ClientsManager extends BaseAPI {
      */
     get(requestParameters: GetClientsByIdRequest, initOverrides?: InitOverride): Promise<ApiResponse<Client>>;
     /**
-     * Note: The `client_secret` and `signing_key` attributes can only be updated with the `update:client_keys` scope.
+     * Get the list of client credentials that are associated to the client.
+     *
+     * Important: To enable credentials to be used for Private Key JWT authentication method, set the <code>client_authentication_methods</code> property on the client.
+     * Get client credentials
+     *
+     * @throws {RequiredError}
+     */
+    getCredentials(requestParameters: GetCredentialsRequest, initOverrides?: InitOverride): Promise<ApiResponse<Array<GetCredentials200ResponseInner>>>;
+    /**
+     * Get the details of a client credential.
+     * Get client credential
+     *
+     * @throws {RequiredError}
+     */
+    getCredential(requestParameters: GetCredentialsByCredentialIdRequest, initOverrides?: InitOverride): Promise<ApiResponse<GetCredentials200ResponseInner>>;
+    /**
+     * Notes:
+     * - The `client_secret` and `signing_key` attributes can only be updated with the `update:client_keys` scope.
+     * - The <code>client_authentication_methods</code> and <code>token_endpoint_auth_method</code> properties are mutually exclusive. Use
+     * <code>client_authentication_methods</code> to configure the client with Private Key JWT authentication method. Otherwise, use <code>token_endpoint_auth_method</code>
+     * to configure the client with client secret (basic or post) or with no authentication method (none).
+     * - When using <code>client_authentication_methods</code> 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.
+     * - To configure <code>client_authentication_methods</code>, the <code>update:client_credentials</code> scope is required.
+     * - To configure <code>client_authentication_methods</code>, the property <code>jwt_configuration.alg</code> must be set to RS256.
      * Update a client
      *
      * @throws {RequiredError}
      */
     update(requestParameters: PatchClientsByIdRequest, bodyParameters: ClientUpdate, initOverrides?: InitOverride): Promise<ApiResponse<Client>>;
+    /**
+     * Update a client credential
+     *
+     * @throws {RequiredError}
+     */
+    updateCredential(requestParameters: PatchCredentialsByCredentialIdOperationRequest, bodyParameters: PatchCredentialsByCredentialIdRequest, initOverrides?: InitOverride): Promise<ApiResponse<GetCredentials200ResponseInner>>;
     /**
      * Create a new client (application or SSO integration).
      *
-     * Note: We recommend leaving the `client_secret` parameter unspecified to allow the generation of a safe secret.
+     * Notes:
+     * - We recommend leaving the `client_secret` parameter unspecified to allow the generation of a safe secret.
+     * - The <code>client_authentication_methods</code> and <code>token_endpoint_auth_method</code> properties are mutually exclusive. Use
+     * <code>client_authentication_methods</code> to configure the client with Private Key JWT authentication method. Otherwise, use <code>token_endpoint_auth_method</code>
+     * to configure the client with client secret (basic or post) or with no authentication method (none).
+     * - When using <code>client_authentication_methods</code> to configure the client with Private Key JWT authentication method, specify fully defined credentials.
+     * These credentials will be automatically enabled for Private Key JWT authentication on the client.
+     * - To configure <code>client_authentication_methods</code>, the <code>create:client_credentials</code> scope is required.
+     * - To configure <code>client_authentication_methods</code>, the property <code>jwt_configuration.alg</code> must be set to RS256.
      *
      * <div class="alert alert-warning">SSO Integrations created via this endpoint will accept login requests and share user profile information.</div>
      *
@@ -99,9 +145,18 @@ export declare class ClientsManager extends BaseAPI {
      * @throws {RequiredError}
      */
     create(bodyParameters: ClientCreate, initOverrides?: InitOverride): Promise<ApiResponse<Client>>;
+    /**
+     * Create a client credential associated to the client. The credential will be created but not yet enabled for use with Private Key JWT authentication method. To enable the credential, set the <code>client_authentication_methods</code> property on the client.
+     * Create a client credential
+     *
+     * @throws {RequiredError}
+     */
+    createCredential(requestParameters: PostCredentialsOperationRequest, bodyParameters: PostCredentialsRequest, initOverrides?: InitOverride): Promise<ApiResponse<GetCredentials200ResponseInner>>;
     /**
      * Rotate a client secret.
      *
+     * This endpoint cannot be used with clients configured with Private Key JWT authentication method (client_authentication_methods configured with private_key_jwt).
+     *
      * Note: The generated secret is NOT base64 encoded.
      *
      * Rotate a client secret

package/dist/types/management/__generated/managers/connections-manager.d.ts

@@ -24,7 +24,23 @@ export declare class ConnectionsManager extends BaseAPI {
     deleteUserByEmail(requestParameters: DeleteUsersByEmailRequest, initOverrides?: InitOverride): Promise<ApiResponse<void>>;
     /**
      * Retrieves every connection matching the specified strategy. All connections are retrieved if no strategy is being specified. Accepts a list of fields to include or exclude in the resulting list of connection objects.
+     * This endpoint supports two types of pagination:
+     * - Offset pagination
+     * - Checkpoint pagination
      *
+     * Checkpoint pagination should be used if you need to retrieve more than 1000 connections.
+     *
+     * <h2>Checkpoint Pagination</h2>
+     *
+     * To search by checkpoint, use the following parameters:
+     * - from: Optional id from which to start selection.
+     * - take: The total amount of entries to retrieve when using the from parameter. Defaults to 50.
+     *
+     * The first time you call this endpoint using Checkpoint Pagination, you should omit the <code>from</code> parameter.
+     * If there are more results, a <code>next</code> value will be included in the response. You can use this for subsequent API calls.
+     * When <code>next</code> is no longer included in the response, this indicates there are no more pages remaining.
+     *
+     * Note: The <code>include_totals</code> parameter is not supported when using checkpoint pagination.
      * Get all connections
      *
      * @throws {RequiredError}

package/dist/types/management/__generated/managers/hooks-manager.d.ts

@@ -67,9 +67,7 @@ export declare class HooksManager extends BaseAPI {
      */
     updateSecrets(requestParameters: PatchSecretsRequest, bodyParameters: {
         [key: string]: any;
-    }, initOverrides?: InitOverride): Promise<ApiResponse<{
-        [key: string]: any;
-    }>>;
+    }, initOverrides?: InitOverride): Promise<ApiResponse<void>>;
     /**
      * Create a new hook.
      *
@@ -87,8 +85,6 @@ export declare class HooksManager extends BaseAPI {
      */
     addSecrets(requestParameters: PostSecretsRequest, bodyParameters: {
         [key: string]: any;
-    }, initOverrides?: InitOverride): Promise<ApiResponse<{
-        [key: string]: any;
-    }>>;
+    }, initOverrides?: InitOverride): Promise<ApiResponse<void>>;
 }
 export {};

package/dist/types/management/__generated/managers/roles-manager.d.ts

@@ -13,7 +13,7 @@ export declare class RolesManager extends BaseAPI {
      *
      * @throws {RequiredError}
      */
-    deletePermissions(requestParameters: DeleteRolePermissionAssignmentRequest, bodyParameters: PostRolePermissionAssignmentRequest, initOverrides?: InitOverride): Promise<ApiResponse<any>>;
+    deletePermissions(requestParameters: DeleteRolePermissionAssignmentRequest, bodyParameters: PostRolePermissionAssignmentRequest, initOverrides?: InitOverride): Promise<ApiResponse<void>>;
     /**
      * Delete a role.
      *
@@ -90,14 +90,14 @@ export declare class RolesManager extends BaseAPI {
      *
      * @throws {RequiredError}
      */
-    addPermissions(requestParameters: PostRolePermissionAssignmentOperationRequest, bodyParameters: PostRolePermissionAssignmentRequest, initOverrides?: InitOverride): Promise<ApiResponse<any>>;
+    addPermissions(requestParameters: PostRolePermissionAssignmentOperationRequest, bodyParameters: PostRolePermissionAssignmentRequest, initOverrides?: InitOverride): Promise<ApiResponse<void>>;
     /**
      * Assign users to a role.
      * Assign users to a role
      *
      * @throws {RequiredError}
      */
-    assignUsers(requestParameters: PostRoleUsersOperationRequest, bodyParameters: PostRoleUsersRequest, initOverrides?: InitOverride): Promise<ApiResponse<any>>;
+    assignUsers(requestParameters: PostRoleUsersOperationRequest, bodyParameters: PostRoleUsersRequest, initOverrides?: InitOverride): Promise<ApiResponse<void>>;
     /**
      * Create a new role.
      *

package/dist/types/management/__generated/managers/users-manager.d.ts

@@ -1,6 +1,6 @@
 import * as runtime from '../../../lib/runtime.js';
 import type { InitOverride, ApiResponse } from '../../../lib/runtime.js';
-import type { DeletePermissionsRequest, DeleteUserIdentityByUserId200ResponseInner, DeleteUserRolesRequest, GetAuthenticationMethods200ResponseOneOfAuthenticatorsInner, GetUsers200ResponseOneOfInner, PatchAuthenticationMethodsByAuthenticationMethodIdRequest, PostAuthenticationMethods201Response, PostAuthenticationMethodsRequest, PostIdentitiesRequest, PostPermissionsRequest, PostRecoveryCodeRegeneration200Response, PostUserRolesRequest, PutAuthenticationMethodsRequestInner, UserCreate, UserEnrollment, UserIdentity, UserUpdate, GetAuthenticationMethods200ResponseOneOf, GetAuthenticationMethods200ResponseOneOfInner, GetLogs200ResponseOneOf, Log, GetPermissions200ResponseOneOf, GetPermissions200ResponseOneOfInner, GetOrganizations200ResponseOneOf, GetOrganizations200ResponseOneOfInner, GetOrganizationMemberRoles200ResponseOneOf, GetOrganizationMemberRoles200ResponseOneOfInner, GetUsers200ResponseOneOf, DeleteAuthenticationMethodsRequest, DeleteAuthenticationMethodsByAuthenticationMethodIdRequest, DeleteAuthenticatorsRequest, DeleteMultifactorByProviderRequest, DeletePermissionsOperationRequest, DeleteUserIdentityByUserIdRequest, DeleteUserRolesOperationRequest, DeleteUsersByIdRequest, GetAuthenticationMethodsRequest, GetAuthenticationMethodsByAuthenticationMethodIdRequest, GetEnrollmentsRequest, GetLogsByUserRequest, GetPermissionsRequest, GetUserOrganizationsRequest, GetUserRolesRequest, GetUsersRequest, GetUsersByIdRequest, PatchAuthenticationMethodsByAuthenticationMethodIdOperationRequest, PatchUsersByIdRequest, PostAuthenticationMethodsOperationRequest, PostIdentitiesOperationRequest, PostInvalidateRememberBrowserRequest, PostPermissionsOperationRequest, PostRecoveryCodeRegenerationRequest, PostUserRolesOperationRequest, PutAuthenticationMethodsRequest } from '../models/index.js';
+import type { DeletePermissionsRequest, DeleteUserIdentityByUserId200ResponseInner, DeleteUserRolesRequest, GetAuthenticationMethods200ResponseOneOfAuthenticatorsInner, GetUsers200ResponseOneOfInner, PatchAuthenticationMethodsByAuthenticationMethodIdRequest, PostAuthenticationMethods201Response, PostAuthenticationMethodsRequest, PostIdentitiesRequest, PostPermissionsRequest, PostRecoveryCodeRegeneration200Response, PostUserRolesRequest, PutAuthenticationMethods200ResponseInner, PutAuthenticationMethodsRequestInner, UserCreate, UserEnrollment, UserIdentity, UserUpdate, GetAuthenticationMethods200ResponseOneOf, GetAuthenticationMethods200ResponseOneOfInner, GetLogs200ResponseOneOf, Log, GetPermissions200ResponseOneOf, GetPermissions200ResponseOneOfInner, GetOrganizations200ResponseOneOf, GetOrganizations200ResponseOneOfInner, GetOrganizationMemberRoles200ResponseOneOf, GetOrganizationMemberRoles200ResponseOneOfInner, GetUsers200ResponseOneOf, DeleteAuthenticationMethodsRequest, DeleteAuthenticationMethodsByAuthenticationMethodIdRequest, DeleteAuthenticatorsRequest, DeleteMultifactorByProviderRequest, DeletePermissionsOperationRequest, DeleteUserIdentityByUserIdRequest, DeleteUserRolesOperationRequest, DeleteUsersByIdRequest, GetAuthenticationMethodsRequest, GetAuthenticationMethodsByAuthenticationMethodIdRequest, GetEnrollmentsRequest, GetLogsByUserRequest, GetPermissionsRequest, GetUserOrganizationsRequest, GetUserRolesRequest, GetUsersRequest, GetUsersByIdRequest, PatchAuthenticationMethodsByAuthenticationMethodIdOperationRequest, PatchUsersByIdRequest, PostAuthenticationMethodsOperationRequest, PostIdentitiesOperationRequest, PostInvalidateRememberBrowserRequest, PostPermissionsOperationRequest, PostRecoveryCodeRegenerationRequest, PostUserRolesOperationRequest, PutAuthenticationMethodsRequest } from '../models/index.js';
 declare const BaseAPI: typeof runtime.BaseAPI;
 /**
  *
@@ -165,9 +165,7 @@ export declare class UsersManager extends BaseAPI {
      *
      * @throws {RequiredError}
      */
-    updateAuthenticationMethod(requestParameters: PatchAuthenticationMethodsByAuthenticationMethodIdOperationRequest, bodyParameters: PatchAuthenticationMethodsByAuthenticationMethodIdRequest, initOverrides?: InitOverride): Promise<ApiResponse<{
-        [key: string]: any;
-    }>>;
+    updateAuthenticationMethod(requestParameters: PatchAuthenticationMethodsByAuthenticationMethodIdOperationRequest, bodyParameters: PatchAuthenticationMethodsByAuthenticationMethodIdRequest, initOverrides?: InitOverride): Promise<ApiResponse<PutAuthenticationMethods200ResponseInner>>;
     /**
      * Update a user.
      *
@@ -297,7 +295,7 @@ export declare class UsersManager extends BaseAPI {
      *
      * @throws {RequiredError}
      */
-    assignPermissions(requestParameters: PostPermissionsOperationRequest, bodyParameters: PostPermissionsRequest, initOverrides?: InitOverride): Promise<ApiResponse<any>>;
+    assignPermissions(requestParameters: PostPermissionsOperationRequest, bodyParameters: PostPermissionsRequest, initOverrides?: InitOverride): Promise<ApiResponse<void>>;
     /**
      * Remove the current <a href="https://auth0.com/docs/multifactor-authentication/guardian">multi-factor authentication</a> recovery code and generate a new one.
      * Generate New Multi-factor Authentication Recovery Code
@@ -326,8 +324,6 @@ export declare class UsersManager extends BaseAPI {
      *
      * @throws {RequiredError}
      */
-    updateAuthenticationMethods(requestParameters: PutAuthenticationMethodsRequest, bodyParameters: Array<PutAuthenticationMethodsRequestInner>, initOverrides?: InitOverride): Promise<ApiResponse<Array<{
-        [key: string]: any;
-    }>>>;
+    updateAuthenticationMethods(requestParameters: PutAuthenticationMethodsRequest, bodyParameters: Array<PutAuthenticationMethodsRequestInner>, initOverrides?: InitOverride): Promise<ApiResponse<Array<PutAuthenticationMethods200ResponseInner>>>;
 }
 export {};