auth0 5.1.0 → 5.3.0

package/dist/esm/management/api/requests/requests.d.mts

@@ -1,5 +1,5 @@
-import * as Management from "../index.mjs";
 import * as core from "../../core/index.mjs";
+import * as Management from "../index.mjs";
 /**
  * @example
  *     {
@@ -47,6 +47,8 @@ export interface CreateActionRequestContent {
     runtime?: string;
     /** The list of secrets that are included in an action or a version of an action. */
     secrets?: Management.ActionSecretRequest[];
+    /** The list of action modules and their versions used by this action. */
+    modules?: Management.ActionModuleReference[];
     /** True if the action should be deployed after creation. */
     deploy?: boolean;
 }
@@ -77,6 +79,8 @@ export interface UpdateActionRequestContent {
     runtime?: string;
     /** The list of secrets that are included in an action or a version of an action. */
     secrets?: Management.ActionSecretRequest[];
+    /** The list of action modules and their versions used by this action. */
+    modules?: Management.ActionModuleReference[];
 }
 /**
  * @example
@@ -123,7 +127,7 @@ export interface ListClientGrantsRequestParameters {
     client_id?: string | null;
     /** Optional filter on allow_any_organization. */
     allow_any_organization?: Management.ClientGrantAllowAnyOrganizationEnum | null;
-    /** The type of application access the client grant allows. Use of this field is subject to the applicable Free Trial terms in Okta’s <a href="https://www.okta.com/legal/"> Master Subscription Agreement.</a> */
+    /** The type of application access the client grant allows. */
     subject_type?: Management.ClientGrantSubjectTypeEnum | null;
 }
 /**
@@ -144,8 +148,10 @@ export interface CreateClientGrantRequestContent {
     /** Scopes allowed for this client grant. */
     scope?: string[];
     subject_type?: Management.ClientGrantSubjectTypeEnum;
-    /** Types of authorization_details allowed for this client grant. Use of this field is subject to the applicable Free Trial terms in Okta’s <a href= "https://www.okta.com/legal/"> Master Subscription Agreement.</a> */
+    /** Types of authorization_details allowed for this client grant. */
     authorization_details_types?: string[];
+    /** If enabled, all scopes configured on the resource server are allowed for this grant. */
+    allow_all_scopes?: boolean;
 }
 /**
  * @example
@@ -157,8 +163,10 @@ export interface UpdateClientGrantRequestContent {
     organization_usage?: Management.ClientGrantOrganizationNullableUsageEnum | null;
     /** Controls allowing any organization to be used with this grant */
     allow_any_organization?: boolean | null;
-    /** Types of authorization_details allowed for this client grant. Use of this field is subject to the applicable Free Trial terms in Okta’s <a href= "https://www.okta.com/legal/"> Master Subscription Agreement.</a> */
+    /** Types of authorization_details allowed for this client grant. */
     authorization_details_types?: string[];
+    /** If enabled, all scopes configured on the resource server are allowed for this grant. */
+    allow_all_scopes?: boolean | null;
 }
 /**
  * @example
@@ -275,11 +283,13 @@ export interface CreateClientRequestContent {
      * See https://auth0.com/docs/secure/security-guidance/measures-against-app-impersonation for more information.
      */
     skip_non_verifiable_callback_uri_confirmation_prompt?: boolean;
+    token_exchange?: Management.ClientTokenExchangeConfiguration;
     /** Specifies how long, in seconds, a Pushed Authorization Request URI remains valid */
     par_request_expiry?: number | null;
     token_quota?: Management.CreateTokenQuota;
     /** The identifier of the resource server that this client is linked to. */
     resource_server_identifier?: string;
+    express_configuration?: Management.ExpressConfiguration;
     async_approval_notification_channels?: Management.ClientAsyncApprovalNotificationsChannelsApiPostConfiguration;
 }
 /**
@@ -376,10 +386,51 @@ export interface UpdateClientRequestContent {
      * See https://auth0.com/docs/secure/security-guidance/measures-against-app-impersonation for more information.
      */
     skip_non_verifiable_callback_uri_confirmation_prompt?: boolean | null;
+    token_exchange?: Management.ClientTokenExchangeConfigurationOrNull | null;
     /** Specifies how long, in seconds, a Pushed Authorization Request URI remains valid */
     par_request_expiry?: number | null;
+    express_configuration?: Management.ExpressConfigurationOrNull | null;
     async_approval_notification_channels?: Management.ClientAsyncApprovalNotificationsChannelsApiPatchConfiguration;
 }
+/**
+ * @example
+ *     {
+ *         from: "from",
+ *         take: 1
+ *     }
+ */
+export interface ListConnectionProfileRequestParameters {
+    /** Optional Id from which to start selection. */
+    from?: string | null;
+    /** Number of results per page. Defaults to 5. */
+    take?: number | null;
+}
+/**
+ * @example
+ *     {
+ *         name: "name"
+ *     }
+ */
+export interface CreateConnectionProfileRequestContent {
+    name: Management.ConnectionProfileName;
+    organization?: Management.ConnectionProfileOrganization;
+    connection_name_prefix_template?: Management.ConnectionNamePrefixTemplate;
+    enabled_features?: Management.ConnectionProfileEnabledFeatures;
+    connection_config?: Management.ConnectionProfileConfig;
+    strategy_overrides?: Management.ConnectionProfileStrategyOverrides;
+}
+/**
+ * @example
+ *     {}
+ */
+export interface UpdateConnectionProfileRequestContent {
+    name?: Management.ConnectionProfileName;
+    organization?: Management.ConnectionProfileOrganization;
+    connection_name_prefix_template?: Management.ConnectionNamePrefixTemplate;
+    enabled_features?: Management.ConnectionProfileEnabledFeatures;
+    connection_config?: Management.ConnectionProfileConfig;
+    strategy_overrides?: Management.ConnectionProfileStrategyOverrides;
+}
 /**
  * @example
  *     {
@@ -463,6 +514,25 @@ export interface UpdateConnectionRequestContent {
     authentication?: Management.ConnectionAuthenticationPurpose;
     connected_accounts?: Management.ConnectionConnectedAccountsPurpose;
 }
+/**
+ * @example
+ *     {
+ *         q: "q",
+ *         fields: "fields",
+ *         include_fields: true,
+ *         sort: "sort"
+ *     }
+ */
+export interface ListCustomDomainsRequestParameters {
+    /** Query in <a href ="http://www.lucenetutorial.com/lucene-query-syntax.html">Lucene query string syntax</a>. */
+    q?: string | null;
+    /** Comma-separated list of fields to include or exclude (based on value provided for include_fields) in the result. Leave empty to retrieve all fields. */
+    fields?: string | null;
+    /** Whether specified fields are to be included (true) or excluded (false). */
+    include_fields?: boolean | null;
+    /** Field to sort by. Only <code>domain:1</code> (ascending order by domain) is supported at this time. */
+    sort?: string | null;
+}
 /**
  * @example
  *     {
@@ -477,6 +547,9 @@ export interface CreateCustomDomainRequestContent {
     verification_method?: Management.CustomDomainVerificationMethodEnum;
     tls_policy?: Management.CustomDomainTlsPolicyEnum;
     custom_client_ip_header?: Management.CustomDomainCustomClientIpHeader | undefined;
+    domain_metadata?: Management.DomainMetadata;
+    /** Relying Party ID (rpId) to be used for Passkeys on this custom domain. If not provided, the full domain will be used. */
+    relying_party_identifier?: string;
 }
 /**
  * @example
@@ -485,6 +558,9 @@ export interface CreateCustomDomainRequestContent {
 export interface UpdateCustomDomainRequestContent {
     tls_policy?: Management.CustomDomainTlsPolicyEnum;
     custom_client_ip_header?: Management.CustomDomainCustomClientIpHeader | undefined;
+    domain_metadata?: Management.DomainMetadata;
+    /** Relying Party ID (rpId) to be used for Passkeys on this custom domain. Set to null to remove the rpId and fall back to using the full domain. */
+    relying_party_identifier?: string | null;
 }
 /**
  * @example
@@ -521,6 +597,7 @@ export interface ListDeviceCredentialsRequestParameters {
  * @example
  *     {
  *         device_name: "device_name",
+ *         type: "public_key",
  *         value: "value",
  *         device_id: "device_id"
  *     }
@@ -528,6 +605,7 @@ export interface ListDeviceCredentialsRequestParameters {
 export interface CreatePublicKeyDeviceCredentialRequestContent {
     /** Name for this device easily recognized by owner. */
     device_name: string;
+    type: Management.DeviceCredentialPublicKeyTypeEnum;
     /** Base64 encoded string containing the credential. */
     value: string;
     /** Unique identifier for the device. Recommend using <a href="http://developer.android.com/reference/android/provider/Settings.Secure.html#ANDROID_ID">Android_ID</a> on Android and <a href="https://developer.apple.com/library/ios/documentation/UIKit/Reference/UIDevice_Class/index.html#//apple_ref/occ/instp/UIDevice/identifierForVendor">identifierForVendor</a>. */
@@ -660,7 +738,7 @@ export interface FlowsListRequest {
     /** Return results inside an object that contains the total result count (true) or as a direct array of results (false, default). */
     include_totals?: boolean | null;
     /** hydration param */
-    hydrate?: ("form_count" | null) | ("form_count" | null)[];
+    hydrate?: (Management.FlowsListRequestHydrateItem | null) | (Management.FlowsListRequestHydrateItem | null)[];
     /** flag to filter by sync/async flows */
     synchronous?: boolean | null;
 }
@@ -781,6 +859,34 @@ export interface DeleteUserGrantByUserIdRequestParameters {
     /** user_id of the grant to delete. */
     user_id: string;
 }
+/**
+ * @example
+ *     {
+ *         connection_id: "connection_id",
+ *         name: "name",
+ *         external_id: "external_id",
+ *         fields: "fields",
+ *         include_fields: true,
+ *         from: "from",
+ *         take: 1
+ *     }
+ */
+export interface ListGroupsRequestParameters {
+    /** Filter groups by connection ID. */
+    connection_id?: string | null;
+    /** Filter groups by name. */
+    name?: string | null;
+    /** Filter groups by external ID. */
+    external_id?: string | null;
+    /** A comma separated list of fields to include or exclude (depending on include_fields) from the result, empty to retrieve all fields */
+    fields?: string | null;
+    /** Whether specified fields are to be included (true) or excluded (false). */
+    include_fields?: boolean | null;
+    /** Optional Id from which to start selection. */
+    from?: string | null;
+    /** Number of results per page. Defaults to 50. */
+    take?: number | null;
+}
 /**
  * @example
  *     {
@@ -1019,6 +1125,13 @@ export interface UpdateSettingsRequestContent {
     /** Use WebAuthn with Device Biometrics as the first authentication factor */
     webauthn_platform_first_factor?: boolean | null;
 }
+/**
+ * @example
+ *     {}
+ */
+export interface UpdateRefreshTokenRequestContent {
+    refresh_token_metadata?: (Management.RefreshTokenMetadata | undefined) | null;
+}
 /**
  * @example
  *     {
@@ -1066,7 +1179,7 @@ export interface CreateResourceServerRequestContent {
     /** Whether to enforce authorization policies (true) or to ignore them (false). */
     enforce_policies?: boolean;
     token_encryption?: Management.ResourceServerTokenEncryption | null;
-    consent_policy?: (Management.ResourceServerConsentPolicyEnum | undefined) | null;
+    consent_policy?: Management.ResourceServerConsentPolicyEnum | null;
     authorization_details?: unknown[];
     proof_of_possession?: Management.ResourceServerProofOfPossession | null;
     subject_type_authorization?: Management.ResourceServerSubjectTypeAuthorization;
@@ -1103,7 +1216,7 @@ export interface UpdateResourceServerRequestContent {
     /** Whether authorization policies are enforced (true) or not enforced (false). */
     enforce_policies?: boolean;
     token_encryption?: Management.ResourceServerTokenEncryption | null;
-    consent_policy?: (Management.ResourceServerConsentPolicyEnum | undefined) | null;
+    consent_policy?: Management.ResourceServerConsentPolicyEnum | null;
     authorization_details?: unknown[];
     proof_of_possession?: Management.ResourceServerProofOfPossession | null;
     subject_type_authorization?: Management.ResourceServerSubjectTypeAuthorization;
@@ -1352,6 +1465,7 @@ export interface ChangePasswordTicketRequestContent {
     mark_email_as_verified?: boolean;
     /** Whether to include the email address as part of the returnUrl in the reset_email (true), or not (false). */
     includeEmailInRedirect?: boolean;
+    identity?: Management.ChangePasswordTicketIdentity;
 }
 /**
  * @example
@@ -1371,7 +1485,8 @@ export interface TokenExchangeProfilesListRequest {
  *     {
  *         name: "name",
  *         subject_token_type: "subject_token_type",
- *         action_id: "action_id"
+ *         action_id: "action_id",
+ *         type: "custom_authentication"
  *     }
  */
 export interface CreateTokenExchangeProfileRequestContent {
@@ -1381,6 +1496,7 @@ export interface CreateTokenExchangeProfileRequestContent {
     subject_token_type: string;
     /** The ID of the Custom Token Exchange action to execute for this profile, in order to validate the subject_token. The action must use the custom-token-exchange trigger. */
     action_id: string;
+    type: Management.TokenExchangeProfileTypeEnum;
 }
 /**
  * @example
@@ -1643,6 +1759,75 @@ export interface ListActionVersionsRequestParameters {
     /** This field specify the maximum number of results to be returned by the server. 20 by default */
     per_page?: number | null;
 }
+/**
+ * @example
+ *     {
+ *         page: 1,
+ *         per_page: 1
+ *     }
+ */
+export interface GetActionModulesRequestParameters {
+    /** Page index of the results to return. First page is 0. */
+    page?: number | null;
+    /** Number of results per page. Paging is disabled if parameter not sent. */
+    per_page?: number | null;
+}
+/**
+ * @example
+ *     {
+ *         name: "name",
+ *         code: "code"
+ *     }
+ */
+export interface CreateActionModuleRequestContent {
+    /** The name of the action module. */
+    name: string;
+    /** The source code of the action module. */
+    code: string;
+    /** The secrets to associate with the action module. */
+    secrets?: Management.ActionModuleSecretRequest[];
+    /** The npm dependencies of the action module. */
+    dependencies?: Management.ActionModuleDependencyRequest[];
+    /** The API version of the module. */
+    api_version?: string;
+    /** Whether to publish the module immediately after creation. */
+    publish?: boolean;
+}
+/**
+ * @example
+ *     {}
+ */
+export interface UpdateActionModuleRequestContent {
+    /** The source code of the action module. */
+    code?: string;
+    /** The secrets to associate with the action module. */
+    secrets?: Management.ActionModuleSecretRequest[];
+    /** The npm dependencies of the action module. */
+    dependencies?: Management.ActionModuleDependencyRequest[];
+}
+/**
+ * @example
+ *     {
+ *         page: 1,
+ *         per_page: 1
+ *     }
+ */
+export interface GetActionModuleActionsRequestParameters {
+    /** Page index of the results to return. First page is 0. */
+    page?: number | null;
+    /** Number of results per page. */
+    per_page?: number | null;
+}
+/**
+ * @example
+ *     {
+ *         module_version_id: "module_version_id"
+ *     }
+ */
+export interface RollbackActionModuleRequestParameters {
+    /** The unique ID of the module version to roll back to. */
+    module_version_id: string;
+}
 /**
  * @example
  *     {
@@ -2084,6 +2269,19 @@ export interface ConnectionsGetRequest {
     /** <code>true</code> if the fields specified are to be included in the result, <code>false</code> otherwise (defaults to <code>true</code>) */
     include_fields?: boolean | null;
 }
+/**
+ * @example
+ *     {
+ *         from: "from",
+ *         take: 1
+ *     }
+ */
+export interface ListDirectoryProvisioningsRequestParameters {
+    /** Optional Id from which to start selection. */
+    from?: string | null;
+    /** Number of results per page. Defaults to 50. */
+    take?: number | null;
+}
 /**
  * @example
  *     {
@@ -2232,7 +2430,7 @@ export interface ExecutionsListRequest {
  */
 export interface ExecutionsGetRequest {
     /** Hydration param */
-    hydrate?: ("debug" | null) | ("debug" | null)[];
+    hydrate?: (Management.flows.ExecutionsGetRequestHydrateItem | null) | (Management.flows.ExecutionsGetRequestHydrateItem | null)[];
 }
 /**
  * @example
@@ -2259,6 +2457,25 @@ export interface UpdateFlowsVaultConnectionRequestContent {
     name?: string;
     setup?: Management.UpdateFlowsVaultConnectionSetup;
 }
+/**
+ * @example
+ *     {
+ *         fields: "fields",
+ *         include_fields: true,
+ *         from: "from",
+ *         take: 1
+ *     }
+ */
+export interface GetGroupMembersRequestParameters {
+    /** A comma separated list of fields to include or exclude (depending on include_fields) from the result, empty to retrieve all fields */
+    fields?: string | null;
+    /** Whether specified fields are to be included (true) or excluded (false). */
+    include_fields?: boolean | null;
+    /** Optional Id from which to start selection. */
+    from?: string | null;
+    /** Number of results per page. Defaults to 50. */
+    take?: number | null;
+}
 /**
  * @example
  *     {
@@ -2334,6 +2551,52 @@ export interface SetGuardianFactorPhoneTemplatesRequestContent {
     /** Message sent to the user when they are prompted to verify their account. */
     verification_message: string;
 }
+/**
+ * @example
+ *     {}
+ */
+export interface SetGuardianFactorsProviderPushNotificationApnsRequestContent {
+    sandbox?: boolean;
+    bundle_id?: string | null;
+    p12?: string | null;
+}
+/**
+ * @example
+ *     {}
+ */
+export interface UpdateGuardianFactorsProviderPushNotificationApnsRequestContent {
+    sandbox?: boolean;
+    bundle_id?: string | null;
+    p12?: string | null;
+}
+/**
+ * @example
+ *     {}
+ */
+export interface SetGuardianFactorsProviderPushNotificationFcmRequestContent {
+    server_key?: string | null;
+}
+/**
+ * @example
+ *     {}
+ */
+export interface UpdateGuardianFactorsProviderPushNotificationFcmRequestContent {
+    server_key?: string | null;
+}
+/**
+ * @example
+ *     {}
+ */
+export interface SetGuardianFactorsProviderPushNotificationFcmv1RequestContent {
+    server_credentials?: string | null;
+}
+/**
+ * @example
+ *     {}
+ */
+export interface UpdateGuardianFactorsProviderPushNotificationFcmv1RequestContent {
+    server_credentials?: string | null;
+}
 /**
  * @example
  *     {}
@@ -2569,6 +2832,8 @@ export interface CreateOrganizationDiscoveryDomainRequestContent {
     /** The domain name to associate with the organization e.g. acme.com. */
     domain: string;
     status?: Management.OrganizationDiscoveryDomainStatus;
+    /** Indicates whether this domain should be used for organization discovery. */
+    use_for_organization_discovery?: boolean;
 }
 /**
  * @example
@@ -2576,6 +2841,8 @@ export interface CreateOrganizationDiscoveryDomainRequestContent {
  */
 export interface UpdateOrganizationDiscoveryDomainRequestContent {
     status?: Management.OrganizationDiscoveryDomainStatus;
+    /** Indicates whether this domain should be used for organization discovery. */
+    use_for_organization_discovery?: boolean;
 }
 /**
  * @example
@@ -2798,9 +3065,7 @@ export interface ListAculsRequestParameters {
  *     {
  *         configs: [{
  *                 prompt: "login",
- *                 screen: "login",
- *                 rendering_mode: "advanced",
- *                 head_tags: [{}]
+ *                 screen: "login"
  *             }]
  *     }
  */
@@ -2809,22 +3074,18 @@ export interface BulkUpdateAculRequestContent {
 }
 /**
  * @example
- *     {
- *         rendering_mode: "advanced",
- *         head_tags: [{}]
- *     }
+ *     {}
  */
 export interface UpdateAculRequestContent {
-    rendering_mode: Management.AculRenderingModeEnum;
-    /** Context values to make available */
-    context_configuration?: string[];
+    rendering_mode?: Management.AculRenderingModeEnum;
+    context_configuration?: Management.AculContextConfiguration;
     /** Override Universal Login default head tags */
     default_head_tags_disabled?: boolean | null;
-    /** An array of head tags */
-    head_tags: Management.AculHeadTag[];
-    filters?: Management.AculFilters | null;
     /** Use page template with ACUL */
     use_page_template?: boolean | null;
+    /** An array of head tags */
+    head_tags?: Management.AculHeadTag[];
+    filters?: Management.AculFilters | null;
 }
 /**
  * @example
@@ -2927,6 +3188,8 @@ export interface CreateSelfServiceProfileSsoTicketRequestContent {
     ttl_sec?: number;
     domain_aliases_config?: Management.SelfServiceProfileSsoTicketDomainAliasesConfig;
     provisioning_config?: Management.SelfServiceProfileSsoTicketProvisioningConfig;
+    /** Indicates whether a verified domain should be used for organization discovery during authentication. */
+    use_for_organization_discovery?: boolean;
 }
 /**
  * @example
@@ -3002,6 +3265,9 @@ export interface UpdateTenantSettingsRequestContent {
      * See https://auth0.com/docs/secure/security-guidance/measures-against-app-impersonation for more information.
      */
     skip_non_verifiable_callback_uri_confirmation_prompt?: boolean | null;
+    resource_parameter_profile?: Management.TenantSettingsResourceParameterProfile;
+    /** Whether Auth0 Guide (AI-powered assistance) is enabled for this tenant. */
+    enable_ai_guide?: boolean;
 }
 export declare namespace UpdateTenantSettingsRequestContent {
     type EnabledLocales = EnabledLocales.Item[];
@@ -3154,6 +3420,25 @@ export interface GetUserConnectedAccountsRequestParameters {
     /** Number of results to return.  Defaults to 10 with a maximum of 20 */
     take?: number | null;
 }
+/**
+ * @example
+ *     {
+ *         fields: "fields",
+ *         include_fields: true,
+ *         from: "from",
+ *         take: 1
+ *     }
+ */
+export interface GetUserGroupsRequestParameters {
+    /** A comma separated list of fields to include or exclude (depending on include_fields) from the result, empty to retrieve all fields */
+    fields?: string | null;
+    /** Whether specified fields are to be included (true) or excluded (false). */
+    include_fields?: boolean | null;
+    /** Optional Id from which to start selection. */
+    from?: string | null;
+    /** Number of results per page. Defaults to 50. */
+    take?: number | null;
+}
 /**
  * @example
  *     {}