auth0 4.16.0 → 4.18.0

package/dist/cjs/management/__generated/models/index.d.ts

@@ -3737,7 +3737,7 @@ export type DeviceCredentialCreateTypeEnum = (typeof DeviceCredentialCreateTypeE
  */
 export interface EmailProvider {
     /**
-     * Name of the email provider. Can be `mailgun`, `mandrill`, `sendgrid`, `ses`, `sparkpost`, `smtp`, `azure_cs`, or `ms365`.
+     * Name of the email provider. Can be `mailgun`, `mandrill`, `sendgrid`, `ses`, `sparkpost`, `smtp`, `azure_cs`, or `ms365`, or `custom`.
      *
      */
     name: string;
@@ -3767,7 +3767,7 @@ export interface EmailProvider {
  */
 export interface EmailProviderCreate {
     /**
-     * Name of the email provider. Can be `mailgun`, `mandrill`, `sendgrid`, `ses`, `sparkpost`, `smtp`, `azure_cs`, or `ms365`.
+     * Name of the email provider. Can be `mailgun`, `mandrill`, `sendgrid`, `ses`, `sparkpost`, `smtp`, `azure_cs`, or `ms365`, or `custom`.
      *
      */
     name: EmailProviderCreateNameEnum;
@@ -3801,6 +3801,7 @@ export declare const EmailProviderCreateNameEnum: {
     readonly smtp: "smtp";
     readonly azure_cs: "azure_cs";
     readonly ms365: "ms365";
+    readonly custom: "custom";
 };
 export type EmailProviderCreateNameEnum = (typeof EmailProviderCreateNameEnum)[keyof typeof EmailProviderCreateNameEnum];
 /**
@@ -3838,7 +3839,7 @@ export interface EmailProviderCredentials {
  */
 export interface EmailProviderUpdate {
     /**
-     * Name of the email provider. Can be `mailgun`, `mandrill`, `sendgrid`, `ses`, `sparkpost`, `smtp`, `azure_cs`, or `ms365`.
+     * Name of the email provider. Can be `mailgun`, `mandrill`, `sendgrid`, `ses`, `sparkpost`, `smtp`, `azure_cs`, `ms365`, or `custom`.
      *
      */
     name?: EmailProviderUpdateNameEnum;
@@ -3872,6 +3873,7 @@ export declare const EmailProviderUpdateNameEnum: {
     readonly smtp: "smtp";
     readonly azure_cs: "azure_cs";
     readonly ms365: "ms365";
+    readonly custom: "custom";
 };
 export type EmailProviderUpdateNameEnum = (typeof EmailProviderUpdateNameEnum)[keyof typeof EmailProviderUpdateNameEnum];
 /**
@@ -4565,7 +4567,7 @@ export interface GetActions200ResponseActionsInnerSupportedTriggersInnerCompatib
     version: string;
 }
 /**
- * An actions extensibility point. Acceptable values: <code>post-login, credentials-exchange, pre-user-registration, post-user-registration, post-change-password, send-phone-message, password-reset-post-challenge</code>
+ * An actions extensibility point. Acceptable values: <code>post-login, credentials-exchange, pre-user-registration, post-user-registration, post-change-password, send-phone-message, custom-email-provider, password-reset-post-challenge</code>
  */
 export type GetActions200ResponseActionsInnerSupportedTriggersInnerId = GetActions200ResponseActionsInnerSupportedTriggersInnerIdAnyOf;
 /**
@@ -4582,6 +4584,7 @@ export declare const GetActions200ResponseActionsInnerSupportedTriggersInnerIdAn
     readonly iga_certification: "iga-certification";
     readonly iga_fulfillment_assignment: "iga-fulfillment-assignment";
     readonly iga_fulfillment_execution: "iga-fulfillment-execution";
+    readonly custom_email_provider: "custom-email-provider";
     readonly password_reset_post_challenge: "password-reset-post-challenge";
 };
 export type GetActions200ResponseActionsInnerSupportedTriggersInnerIdAnyOf = (typeof GetActions200ResponseActionsInnerSupportedTriggersInnerIdAnyOf)[keyof typeof GetActions200ResponseActionsInnerSupportedTriggersInnerIdAnyOf];
@@ -5041,6 +5044,8 @@ export interface GetClients200ResponseOneOf {
  */
 export interface GetClients200ResponseOneOf1 {
     /**
+     * Opaque identifier for use with the <i>from</i> query parameter for the next page of results.<br/>This identifier is valid for 24 hours.
+     *
      */
     next: string;
     /**
@@ -5166,7 +5171,7 @@ export interface GetDeviceCredentials200ResponseOneOf {
  */
 export interface GetEmailTemplatesByTemplateName200Response {
     /**
-     * Template name. Can be `verify_email`, `verify_email_by_code`, `reset_email`, `welcome_email`, `blocked_account`, `stolen_credentials`, `enrollment_email`, `mfa_oob_code`, `user_invitation`, `change_password` (legacy), or `password_reset` (legacy).
+     * Template name. Can be `verify_email`, `verify_email_by_code`, `reset_email`, `reset_email_by_code`, `welcome_email`, `blocked_account`, `stolen_credentials`, `enrollment_email`, `mfa_oob_code`, `user_invitation`, `change_password` (legacy), or `password_reset` (legacy).
      *
      */
     template: GetEmailTemplatesByTemplateName200ResponseTemplateEnum;
@@ -5215,6 +5220,7 @@ export declare const GetEmailTemplatesByTemplateName200ResponseTemplateEnum: {
     readonly verify_email: "verify_email";
     readonly verify_email_by_code: "verify_email_by_code";
     readonly reset_email: "reset_email";
+    readonly reset_email_by_code: "reset_email_by_code";
     readonly welcome_email: "welcome_email";
     readonly blocked_account: "blocked_account";
     readonly stolen_credentials: "stolen_credentials";
@@ -7050,15 +7056,42 @@ export interface GetRendering200Response {
      * An array of head tags
      *
      */
-    head_tags: Array<{
-        [key: string]: any;
-    }>;
+    head_tags: Array<GetRendering200ResponseHeadTagsInner>;
 }
 export declare const GetRendering200ResponseRenderingModeEnum: {
     readonly advanced: "advanced";
     readonly standard: "standard";
 };
 export type GetRendering200ResponseRenderingModeEnum = (typeof GetRendering200ResponseRenderingModeEnum)[keyof typeof GetRendering200ResponseRenderingModeEnum];
+/**
+ *
+ */
+export interface GetRendering200ResponseHeadTagsInner {
+    [key: string]: any | any;
+    /**
+     * Any HTML element valid for use in the head tag
+     *
+     */
+    tag: string;
+    /**
+     */
+    attributes: GetRendering200ResponseHeadTagsInnerAttributes;
+    /**
+     * Text/content within the opening and closing tags of the element.
+     * See <a href="https://auth0.com/docs/customize/login-pages/advanced-customizations/getting-started/configure-acul-screens">documentation</a> on using context variables
+     *
+     */
+    content: string;
+}
+/**
+ * Attributes of the HTML tag
+ */
+export interface GetRendering200ResponseHeadTagsInnerAttributes {
+    [key: string]: any | any;
+    /**
+     */
+    integrity: Array<string>;
+}
 /**
  *
  */
@@ -7749,6 +7782,64 @@ export interface GetSuspiciousIpThrottling200ResponseStagePreUserRegistration {
      */
     rate: number;
 }
+/**
+ *
+ */
+export interface GetTokenExchangeProfiles200Response {
+    /**
+     */
+    pagination: {
+        [key: string]: any;
+    };
+    /**
+     */
+    token_exchange_profiles: Array<GetTokenExchangeProfilesById200Response>;
+}
+/**
+ *
+ */
+export interface GetTokenExchangeProfilesById200Response {
+    [key: string]: any | any;
+    /**
+     * The unique ID of the token exchange profile.
+     *
+     */
+    id: string;
+    /**
+     * Friendly name of this profile.
+     *
+     */
+    name: string;
+    /**
+     * Subject token type for this profile. When receiving a token exchange request on the Authentication API, the corresponding token exchange profile with a matching subject_token_type will be executed. This must be a URI.
+     *
+     */
+    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;
+    /**
+     * The type of the profile, which controls how the profile will be executed when receiving a token exchange request.
+     *
+     */
+    type: GetTokenExchangeProfilesById200ResponseTypeEnum;
+    /**
+     * The time when this profile was created.
+     *
+     */
+    created_at: string;
+    /**
+     * The time when this profile was updated.
+     *
+     */
+    updated_at: string;
+}
+export declare const GetTokenExchangeProfilesById200ResponseTypeEnum: {
+    readonly custom_authentication: "custom_authentication";
+};
+export type GetTokenExchangeProfilesById200ResponseTypeEnum = (typeof GetTokenExchangeProfilesById200ResponseTypeEnum)[keyof typeof GetTokenExchangeProfilesById200ResponseTypeEnum];
 /**
  *
  */
@@ -8676,7 +8767,7 @@ export type PatchCustomDomainsByIdRequestCustomClientIpHeaderEnum = (typeof Patc
  */
 export interface PatchEmailTemplatesByTemplateNameRequest {
     /**
-     * Template name. Can be `verify_email`, `verify_email_by_code`, `reset_email`, `welcome_email`, `blocked_account`, `stolen_credentials`, `enrollment_email`, `mfa_oob_code`, `user_invitation`, `change_password` (legacy), or `password_reset` (legacy).
+     * Template name. Can be `verify_email`, `verify_email_by_code`, `reset_email`, `reset_email_by_code`, `welcome_email`, `blocked_account`, `stolen_credentials`, `enrollment_email`, `mfa_oob_code`, `user_invitation`, `change_password` (legacy), or `password_reset` (legacy).
      *
      */
     template?: PatchEmailTemplatesByTemplateNameRequestTemplateEnum;
@@ -8725,6 +8816,7 @@ export declare const PatchEmailTemplatesByTemplateNameRequestTemplateEnum: {
     readonly verify_email: "verify_email";
     readonly verify_email_by_code: "verify_email_by_code";
     readonly reset_email: "reset_email";
+    readonly reset_email_by_code: "reset_email_by_code";
     readonly welcome_email: "welcome_email";
     readonly blocked_account: "blocked_account";
     readonly stolen_credentials: "stolen_credentials";
@@ -8973,7 +9065,38 @@ export interface PatchOrganizationsByIdRequestBranding {
     colors?: GetOrganizations200ResponseOneOfInnerBrandingColors;
 }
 /**
- * ACUL settings for the given screen.
+ *
+ */
+export interface PatchRendering200Response {
+    [key: string]: any | any;
+    /**
+     * Rendering mode
+     *
+     */
+    rendering_mode: PatchRendering200ResponseRenderingModeEnum;
+    /**
+     * Context values to make available
+     *
+     */
+    context_configuration: Array<string>;
+    /**
+     * Override Universal Login default head tags
+     *
+     */
+    default_head_tags_disabled: boolean;
+    /**
+     * An array of head tags
+     *
+     */
+    head_tags: Array<GetRendering200ResponseHeadTagsInner>;
+}
+export declare const PatchRendering200ResponseRenderingModeEnum: {
+    readonly advanced: "advanced";
+    readonly standard: "standard";
+};
+export type PatchRendering200ResponseRenderingModeEnum = (typeof PatchRendering200ResponseRenderingModeEnum)[keyof typeof PatchRendering200ResponseRenderingModeEnum];
+/**
+ * Render settings for the given screen
  */
 export interface PatchRenderingRequest {
     /**
@@ -8995,15 +9118,42 @@ export interface PatchRenderingRequest {
      * An array of head tags
      *
      */
-    head_tags?: Array<{
-        [key: string]: any;
-    }>;
+    head_tags?: Array<PatchRenderingRequestHeadTagsInner>;
 }
 export declare const PatchRenderingRequestRenderingModeEnum: {
     readonly advanced: "advanced";
     readonly standard: "standard";
 };
 export type PatchRenderingRequestRenderingModeEnum = (typeof PatchRenderingRequestRenderingModeEnum)[keyof typeof PatchRenderingRequestRenderingModeEnum];
+/**
+ *
+ */
+export interface PatchRenderingRequestHeadTagsInner {
+    [key: string]: any | any;
+    /**
+     * Any HTML element valid for use in the head tag
+     *
+     */
+    tag?: string;
+    /**
+     */
+    attributes?: PatchRenderingRequestHeadTagsInnerAttributes;
+    /**
+     * Text/content within the opening and closing tags of the element
+     * See <a href="https://auth0.com/docs/customize/login-pages/advanced-customizations/getting-started/configure-acul-screens">documentation</a> on using context variables
+     *
+     */
+    content?: string;
+}
+/**
+ * Attributes of the HTML tag
+ */
+export interface PatchRenderingRequestHeadTagsInnerAttributes {
+    [key: string]: any | any;
+    /**
+     */
+    integrity?: Array<string>;
+}
 /**
  *
  */
@@ -9089,6 +9239,21 @@ export interface PatchSuspiciousIpThrottlingRequestStagePreUserRegistration {
      */
     rate?: number;
 }
+/**
+ *
+ */
+export interface PatchTokenExchangeProfilesByIdRequest {
+    /**
+     * Friendly name of this profile.
+     *
+     */
+    name?: string;
+    /**
+     * Subject token type for this profile. When receiving a token exchange request on the Authentication API, the corresponding token exchange profile with a matching subject_token_type will be executed. This must be a URI.
+     *
+     */
+    subject_token_type?: string;
+}
 /**
  *
  */
@@ -9921,7 +10086,7 @@ export interface PostDeviceCredentials201Response {
  */
 export interface PostEmailTemplatesRequest {
     /**
-     * Template name. Can be `verify_email`, `verify_email_by_code`, `reset_email`, `welcome_email`, `blocked_account`, `stolen_credentials`, `enrollment_email`, `mfa_oob_code`, `user_invitation`, `change_password` (legacy), or `password_reset` (legacy).
+     * Template name. Can be `verify_email`, `verify_email_by_code`, `reset_email`, `reset_email_by_code`, `welcome_email`, `blocked_account`, `stolen_credentials`, `enrollment_email`, `mfa_oob_code`, `user_invitation`, `change_password` (legacy), or `password_reset` (legacy).
      *
      */
     template: PostEmailTemplatesRequestTemplateEnum;
@@ -9970,6 +10135,7 @@ export declare const PostEmailTemplatesRequestTemplateEnum: {
     readonly verify_email: "verify_email";
     readonly verify_email_by_code: "verify_email_by_code";
     readonly reset_email: "reset_email";
+    readonly reset_email_by_code: "reset_email_by_code";
     readonly welcome_email: "welcome_email";
     readonly blocked_account: "blocked_account";
     readonly stolen_credentials: "stolen_credentials";
@@ -12967,6 +13133,35 @@ export interface PostTicket200Response {
      */
     ticket_url: string;
 }
+/**
+ *
+ */
+export interface PostTokenExchangeProfilesRequest {
+    /**
+     * Friendly name of this profile.
+     *
+     */
+    name: string;
+    /**
+     * Subject token type for this profile. When receiving a token exchange request on the Authentication API, the corresponding token exchange profile with a matching subject_token_type will be executed. This must be a URI.
+     *
+     */
+    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;
+    /**
+     * The type of the profile, which controls how the profile will be executed when receiving a token exchange request.
+     *
+     */
+    type: PostTokenExchangeProfilesRequestTypeEnum;
+}
+export declare const PostTokenExchangeProfilesRequestTypeEnum: {
+    readonly custom_authentication: "custom_authentication";
+};
+export type PostTokenExchangeProfilesRequestTypeEnum = (typeof PostTokenExchangeProfilesRequestTypeEnum)[keyof typeof PostTokenExchangeProfilesRequestTypeEnum];
 /**
  *
  */
@@ -15738,7 +15933,7 @@ export interface GetActionsRequest {
  */
 export interface GetBindingsRequest {
     /**
-     * An actions extensibility point. Acceptable values: <code>post-login, credentials-exchange, pre-user-registration, post-user-registration, post-change-password, send-phone-message, password-reset-post-challenge</code>
+     * An actions extensibility point. Acceptable values: <code>post-login, credentials-exchange, pre-user-registration, post-user-registration, post-change-password, send-phone-message, custom-email-provider, password-reset-post-challenge</code>
      *
      */
     triggerId: string;
@@ -15778,7 +15973,7 @@ export interface PatchActionOperationRequest {
  */
 export interface PatchBindingsOperationRequest {
     /**
-     * An actions extensibility point. Acceptable values: <code>post-login, credentials-exchange, pre-user-registration, post-user-registration, post-change-password, send-phone-message, password-reset-post-challenge</code>
+     * An actions extensibility point. Acceptable values: <code>post-login, credentials-exchange, pre-user-registration, post-user-registration, post-change-password, send-phone-message, custom-email-provider, password-reset-post-challenge</code>
      *
      */
     triggerId: string;
@@ -16008,12 +16203,7 @@ export interface GetClientsRequest {
      */
     app_type?: string;
     /**
-     * A comma separated list of client_ids used to filter the returned clients
-     *
-     */
-    client_ids?: string;
-    /**
-     * Query in <a href ="http://www.lucenetutorial.com/lucene-query-syntax.html">Lucene query string syntax</a>.
+     * Advanced Query in <a href="http://www.lucenetutorial.com/lucene-query-syntax.html">Lucene</a> syntax.<br /><b>Permitted Queries</b>:<br /><ul><li><i>client_grant.organization_id:{organization_id}</i></li><li><i>client_grant.allow_any_organization:true</i></li></ul><b>Additional Restrictions</b>:<br /><ul><li>Cannot be used in combination with other filters</li><li>Requires use of the <i>from</i> and <i>take</i> paging parameters (checkpoint paginatinon)</li><li>Reduced rate limits apply. See <a href="https://auth0.com/docs/troubleshoot/customer-support/operational-policies/rate-limit-policy/rate-limit-configurations/enterprise-public">Rate Limit Configurations</a></li></ul><i><b>Note</b>: Recent updates may not be immediately reflected in query results</i>
      *
      */
     q?: string;
@@ -16487,6 +16677,7 @@ export declare const GetEmailTemplatesByTemplateNameTemplateNameEnum: {
     readonly verify_email: "verify_email";
     readonly verify_email_by_code: "verify_email_by_code";
     readonly reset_email: "reset_email";
+    readonly reset_email_by_code: "reset_email_by_code";
     readonly welcome_email: "welcome_email";
     readonly blocked_account: "blocked_account";
     readonly stolen_credentials: "stolen_credentials";
@@ -16502,7 +16693,7 @@ export type GetEmailTemplatesByTemplateNameTemplateNameEnum = (typeof GetEmailTe
  */
 export interface GetEmailTemplatesByTemplateNameRequest {
     /**
-     * Template name. Can be `verify_email`, `verify_email_by_code`, `reset_email`, `welcome_email`, `blocked_account`, `stolen_credentials`, `enrollment_email`, `mfa_oob_code`, `user_invitation`, `change_password` (legacy), or `password_reset` (legacy).
+     * Template name. Can be `verify_email`, `verify_email_by_code`, `reset_email`, `reset_email_by_code`, `welcome_email`, `blocked_account`, `stolen_credentials`, `enrollment_email`, `mfa_oob_code`, `user_invitation`, `change_password` (legacy), or `password_reset` (legacy).
      *
      */
     templateName: GetEmailTemplatesByTemplateNameTemplateNameEnum;
@@ -16514,6 +16705,7 @@ export declare const PatchEmailTemplatesByTemplateNameOperationTemplateNameEnum:
     readonly verify_email: "verify_email";
     readonly verify_email_by_code: "verify_email_by_code";
     readonly reset_email: "reset_email";
+    readonly reset_email_by_code: "reset_email_by_code";
     readonly welcome_email: "welcome_email";
     readonly blocked_account: "blocked_account";
     readonly stolen_credentials: "stolen_credentials";
@@ -16529,7 +16721,7 @@ export type PatchEmailTemplatesByTemplateNameOperationTemplateNameEnum = (typeof
  */
 export interface PatchEmailTemplatesByTemplateNameOperationRequest {
     /**
-     * Template name. Can be `verify_email`, `verify_email_by_code`, `reset_email`, `welcome_email`, `blocked_account`, `stolen_credentials`, `enrollment_email`, `mfa_oob_code`, `user_invitation`, `change_password` (legacy), or `password_reset` (legacy).
+     * Template name. Can be `verify_email`, `verify_email_by_code`, `reset_email`, `reset_email_by_code`, `welcome_email`, `blocked_account`, `stolen_credentials`, `enrollment_email`, `mfa_oob_code`, `user_invitation`, `change_password` (legacy), or `password_reset` (legacy).
      *
      */
     templateName: PatchEmailTemplatesByTemplateNameOperationTemplateNameEnum;
@@ -16541,6 +16733,7 @@ export declare const PutEmailTemplatesByTemplateNameTemplateNameEnum: {
     readonly verify_email: "verify_email";
     readonly verify_email_by_code: "verify_email_by_code";
     readonly reset_email: "reset_email";
+    readonly reset_email_by_code: "reset_email_by_code";
     readonly welcome_email: "welcome_email";
     readonly blocked_account: "blocked_account";
     readonly stolen_credentials: "stolen_credentials";
@@ -16556,7 +16749,7 @@ export type PutEmailTemplatesByTemplateNameTemplateNameEnum = (typeof PutEmailTe
  */
 export interface PutEmailTemplatesByTemplateNameRequest {
     /**
-     * Template name. Can be `verify_email`, `verify_email_by_code`, `reset_email`, `welcome_email`, `blocked_account`, `stolen_credentials`, `enrollment_email`, `mfa_oob_code`, `user_invitation`, `change_password` (legacy), or `password_reset` (legacy).
+     * Template name. Can be `verify_email`, `verify_email_by_code`, `reset_email`, `reset_email_by_code`, `welcome_email`, `blocked_account`, `stolen_credentials`, `enrollment_email`, `mfa_oob_code`, `user_invitation`, `change_password` (legacy), or `password_reset` (legacy).
      *
      */
     templateName: PutEmailTemplatesByTemplateNameTemplateNameEnum;
@@ -17932,12 +18125,12 @@ export type GetRenderingScreenEnum = (typeof GetRenderingScreenEnum)[keyof typeo
  */
 export interface GetRenderingRequest {
     /**
-     * Name of the prompt.
+     * Name of the prompt
      *
      */
     prompt: GetRenderingPromptEnum;
     /**
-     * Name of the screen.
+     * Name of the screen
      *
      */
     screen: GetRenderingScreenEnum;
@@ -18073,12 +18266,12 @@ export type PatchRenderingOperationScreenEnum = (typeof PatchRenderingOperationS
  */
 export interface PatchRenderingOperationRequest {
     /**
-     * Name of the prompt.
+     * Name of the prompt
      *
      */
     prompt: PatchRenderingOperationPromptEnum;
     /**
-     * Name of the screen.
+     * Name of the screen
      *
      */
     screen: PatchRenderingOperationScreenEnum;
@@ -18731,6 +18924,51 @@ export interface TenantSettingsRouteRequest {
      */
     include_fields?: boolean;
 }
+/**
+ *
+ */
+export interface DeleteTokenExchangeProfilesByIdRequest {
+    /**
+     * ID of the Token Exchange Profile to delete.
+     *
+     */
+    id: string;
+}
+/**
+ *
+ */
+export interface GetTokenExchangeProfilesRequest {
+    /**
+     * Optional Id from which to start selection.
+     *
+     */
+    from?: string;
+    /**
+     * Number of results per page. Defaults to 50.
+     *
+     */
+    take?: number;
+}
+/**
+ *
+ */
+export interface GetTokenExchangeProfilesByIdRequest {
+    /**
+     * ID of the Token Exchange Profile to retrieve.
+     *
+     */
+    id: string;
+}
+/**
+ *
+ */
+export interface PatchTokenExchangeProfilesByIdOperationRequest {
+    /**
+     * ID of the Token Exchange Profile to update.
+     *
+     */
+    id: string;
+}
 /**
  *
  */