auth0 4.36.0 → 4.37.0

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

@@ -268,8 +268,7 @@ export interface Auth0V2CaptchaConfig {
 /**
  * List of IP addresses or CIDR blocks to allowlist
  */
-export interface BotDetectionAllowlist extends Array<BotDetectionIpAddressOrCidrBlock> {
-}
+export type BotDetectionAllowlist = Array<BotDetectionIpAddressOrCidrBlock>;
 /**
  * The policy that defines how often to show CAPTCHA
  */
@@ -640,6 +639,9 @@ export interface Client {
      *
      */
     skip_non_verifiable_callback_uri_confirmation_prompt?: boolean;
+    /**
+     */
+    express_configuration?: ClientExpressConfiguration;
     /**
      * Array of notification channels for contacting the user when their approval is required. Valid values are `guardian-push`, `email`.
      *
@@ -1595,6 +1597,9 @@ export interface ClientCreate {
      *
      */
     skip_non_verifiable_callback_uri_confirmation_prompt?: boolean;
+    /**
+     */
+    express_configuration?: ClientExpressConfiguration;
     /**
      * Array of notification channels for contacting the user when their approval is required. Valid values are `guardian-push`, `email`.
      *
@@ -2576,6 +2581,66 @@ export interface ClientEncryptionKey {
      */
     subject: string;
 }
+/**
+ * Application specific configuration for use with the OIN Express Configuration feature.
+ */
+export interface ClientExpressConfiguration {
+    /**
+     * The URI users should bookmark to log in to this application. Variable substitution is permitted for the following properties: organization_name, organization_id, and connection_name.
+     *
+     */
+    initiate_login_uri_template: string;
+    /**
+     * The ID of the user attribute profile to use for this application.
+     *
+     */
+    user_attribute_profile_id: string;
+    /**
+     * The ID of the connection profile to use for this application.
+     *
+     */
+    connection_profile_id: string;
+    /**
+     * When true, all connections made via express configuration will be enabled for this application.
+     *
+     */
+    enable_client: boolean;
+    /**
+     * When true, all connections made via express configuration will have the associated organization enabled.
+     *
+     */
+    enable_organization: boolean;
+    /**
+     * List of client IDs that are linked to this express configuration (e.g. web or mobile clients).
+     *
+     */
+    linked_clients?: Array<ClientExpressConfigurationLinkedClientsInner>;
+    /**
+     * This is the unique identifier for the Okta OIN Express Configuration Client, which Okta will use for this application.
+     *
+     */
+    okta_oin_client_id: string;
+    /**
+     * This is the domain that admins are expected to log in via for authenticating for express configuration. It can be either the canonical domain or a registered custom domain.
+     *
+     */
+    admin_login_domain: string;
+    /**
+     * The identifier of the published application in the OKTA OIN.
+     *
+     */
+    oin_submission_id?: string;
+}
+/**
+ * Configuration for linked clients in the OIN Express Configuration feature.
+ */
+export interface ClientExpressConfigurationLinkedClientsInner {
+    /**
+     * The ID of the linked client.
+     *
+     */
+    client_id: string;
+}
 /**
  *
  */
@@ -2610,6 +2675,11 @@ export interface ClientGrant {
      *
      */
     allow_any_organization: boolean;
+    /**
+     * If enabled, this grant is a special grant created by Auth0. It cannot be modified or deleted directly.
+     *
+     */
+    is_system?: boolean;
     /**
      */
     subject_type?: ClientGrantSubjectTypeEnum;
@@ -3162,6 +3232,9 @@ export interface ClientUpdate {
      *
      */
     skip_non_verifiable_callback_uri_confirmation_prompt?: boolean;
+    /**
+     */
+    express_configuration?: ClientExpressConfiguration;
     /**
      * Array of notification channels for contacting the user when their approval is required. Valid values are `guardian-push`, `email`.
      *
@@ -4304,6 +4377,168 @@ export interface ConnectionForList {
      */
     connected_accounts?: ConnectionConnectedAccounts;
 }
+/**
+ *
+ */
+export interface ConnectionProfile {
+    /**
+     * Connection Profile identifier.
+     *
+     */
+    id?: string;
+    /**
+     * The name of the connection profile.
+     *
+     */
+    name?: string;
+    /**
+     */
+    organization?: ConnectionProfileOrganization;
+    /**
+     * Connection name prefix template.
+     *
+     */
+    connection_name_prefix_template?: string;
+    /**
+     */
+    enabled_features?: ConnectionProfileEnabledFeatures;
+    /**
+     * Connection profile configuration.
+     *
+     */
+    connection_config?: object;
+    /**
+     */
+    strategy_overrides?: ConnectionProfileStrategyOverrides;
+}
+/**
+ * Enabled features for the connection profile.
+ */
+export interface ConnectionProfileEnabledFeatures extends Array<EnabledFeaturesEnum> {
+}
+/**
+ * The organization of the connection profile.
+ */
+export interface ConnectionProfileOrganization {
+    /**
+     */
+    show_as_button?: ConnectionProfileOrganizationShowAsButtonEnum;
+    /**
+     */
+    assign_membership_on_login?: ConnectionProfileOrganizationAssignMembershipOnLoginEnum;
+}
+/**
+ * Indicates if membership should be assigned on login.
+ */
+export declare const ConnectionProfileOrganizationAssignMembershipOnLoginEnum: {
+    readonly none: "none";
+    readonly optional: "optional";
+    readonly required: "required";
+};
+export type ConnectionProfileOrganizationAssignMembershipOnLoginEnum = (typeof ConnectionProfileOrganizationAssignMembershipOnLoginEnum)[keyof typeof ConnectionProfileOrganizationAssignMembershipOnLoginEnum];
+/**
+ * Indicates if the organization should be shown as a button.
+ */
+export declare const ConnectionProfileOrganizationShowAsButtonEnum: {
+    readonly none: "none";
+    readonly optional: "optional";
+    readonly required: "required";
+};
+export type ConnectionProfileOrganizationShowAsButtonEnum = (typeof ConnectionProfileOrganizationShowAsButtonEnum)[keyof typeof ConnectionProfileOrganizationShowAsButtonEnum];
+/**
+ * Connection Profile Strategy Override
+ */
+export interface ConnectionProfileStrategyOverride {
+    /**
+     */
+    enabled_features?: ConnectionProfileStrategyOverridesEnabledFeatures;
+    /**
+     * Connection profile strategy overrides connection configuration.
+     *
+     */
+    connection_config?: object;
+}
+/**
+ * Strategy-specific overrides for this attribute
+ */
+export interface ConnectionProfileStrategyOverrides {
+    /**
+     */
+    pingfederate?: ConnectionProfileStrategyOverride;
+    /**
+     */
+    ad?: ConnectionProfileStrategyOverride;
+    /**
+     */
+    adfs?: ConnectionProfileStrategyOverride;
+    /**
+     */
+    waad?: ConnectionProfileStrategyOverride;
+    /**
+     */
+    'google-apps'?: ConnectionProfileStrategyOverride;
+    /**
+     */
+    okta?: ConnectionProfileStrategyOverride;
+    /**
+     */
+    oidc?: ConnectionProfileStrategyOverride;
+    /**
+     */
+    samlp?: ConnectionProfileStrategyOverride;
+}
+/**
+ * Enabled features for a connections profile strategy override.
+ */
+export interface ConnectionProfileStrategyOverridesEnabledFeatures extends Array<EnabledFeaturesEnum> {
+}
+/**
+ * The structure of the template, which can be used as the payload for creating or updating a Connection Profile.
+ */
+export interface ConnectionProfileTemplate {
+    /**
+     * The name of the connection profile.
+     *
+     */
+    name?: string;
+    /**
+     */
+    organization?: ConnectionProfileOrganization;
+    /**
+     * Connection name prefix template.
+     *
+     */
+    connection_name_prefix_template?: string;
+    /**
+     */
+    enabled_features?: ConnectionProfileEnabledFeatures;
+    /**
+     * Connection profile configuration.
+     *
+     */
+    connection_config?: object;
+    /**
+     */
+    strategy_overrides?: ConnectionProfileStrategyOverrides;
+}
+/**
+ *
+ */
+export interface ConnectionProfileTemplateItem {
+    /**
+     * The id of the template.
+     *
+     */
+    id?: string;
+    /**
+     * The user-friendly name of the template displayed in the UI.
+     *
+     */
+    display_name?: string;
+    /**
+     */
+    template?: ConnectionProfileTemplate;
+}
 /**
  *
  */
@@ -4460,6 +4695,69 @@ export declare const ConnectionUpdateOptionsSetUserRootAttributesEnum: {
     readonly first_login: "on_first_login";
 };
 export type ConnectionUpdateOptionsSetUserRootAttributesEnum = (typeof ConnectionUpdateOptionsSetUserRootAttributesEnum)[keyof typeof ConnectionUpdateOptionsSetUserRootAttributesEnum];
+/**
+ *
+ */
+export interface CreateConnectionProfileRequestContent {
+    /**
+     * The name of the connection profile.
+     *
+     */
+    name: string;
+    /**
+     */
+    organization?: ConnectionProfileOrganization;
+    /**
+     * Connection name prefix template.
+     *
+     */
+    connection_name_prefix_template?: string;
+    /**
+     */
+    enabled_features?: ConnectionProfileEnabledFeatures;
+    /**
+     * Connection profile configuration.
+     *
+     */
+    connection_config?: object;
+    /**
+     */
+    strategy_overrides?: ConnectionProfileStrategyOverrides;
+}
+/**
+ *
+ */
+export interface CreateConnectionProfileResponseContent {
+    /**
+     * Connection Profile identifier.
+     *
+     */
+    id?: string;
+    /**
+     * The name of the connection profile.
+     *
+     */
+    name?: string;
+    /**
+     */
+    organization?: ConnectionProfileOrganization;
+    /**
+     * Connection name prefix template.
+     *
+     */
+    connection_name_prefix_template?: string;
+    /**
+     */
+    enabled_features?: ConnectionProfileEnabledFeatures;
+    /**
+     * Connection profile configuration.
+     *
+     */
+    connection_config?: object;
+    /**
+     */
+    strategy_overrides?: ConnectionProfileStrategyOverrides;
+}
 /**
  *
  */
@@ -5100,6 +5398,14 @@ export declare const EmailTemplateUpdateTemplateEnum: {
     readonly async_approval: "async_approval";
 };
 export type EmailTemplateUpdateTemplateEnum = (typeof EmailTemplateUpdateTemplateEnum)[keyof typeof EmailTemplateUpdateTemplateEnum];
+/**
+ * Enum for enabled features.
+ */
+export declare const EnabledFeaturesEnum: {
+    readonly scim: "scim";
+    readonly universal_logout: "universal_logout";
+};
+export type EnabledFeaturesEnum = (typeof EnabledFeaturesEnum)[keyof typeof EnabledFeaturesEnum];
 /**
  *
  */
@@ -6571,6 +6877,58 @@ export interface GetConnectionClients200ResponseClientsInner {
      */
     client_id: string;
 }
+/**
+ *
+ */
+export interface GetConnectionProfileResponseContent {
+    /**
+     * Connection Profile identifier.
+     *
+     */
+    id?: string;
+    /**
+     * The name of the connection profile.
+     *
+     */
+    name?: string;
+    /**
+     */
+    organization?: ConnectionProfileOrganization;
+    /**
+     * Connection name prefix template.
+     *
+     */
+    connection_name_prefix_template?: string;
+    /**
+     */
+    enabled_features?: ConnectionProfileEnabledFeatures;
+    /**
+     * Connection profile configuration.
+     *
+     */
+    connection_config?: object;
+    /**
+     */
+    strategy_overrides?: ConnectionProfileStrategyOverrides;
+}
+/**
+ *
+ */
+export interface GetConnectionProfileTemplateResponseContent {
+    /**
+     * The id of the template.
+     *
+     */
+    id?: string;
+    /**
+     * The user-friendly name of the template displayed in the UI.
+     *
+     */
+    display_name?: string;
+    /**
+     */
+    template?: ConnectionProfileTemplate;
+}
 /**
  *
  */
@@ -6595,8 +6953,7 @@ export interface GetConnections200ResponseOneOf {
 /**
  *
  */
-export interface GetConnectionsKeysResponseContent extends Array<GetConnectionsKeysResponseContentInner> {
-}
+export type GetConnectionsKeysResponseContent = Array<GetConnectionsKeysResponseContentInner>;
 /**
  *
  */
@@ -10466,6 +10823,27 @@ export declare const JobFormatEnum: {
     readonly csv: "csv";
 };
 export type JobFormatEnum = (typeof JobFormatEnum)[keyof typeof JobFormatEnum];
+/**
+ *
+ */
+export interface ListConnectionProfileTemplateResponseContent {
+    /**
+     */
+    connection_profile_templates?: Array<ConnectionProfileTemplateItem>;
+}
+/**
+ *
+ */
+export interface ListConnectionProfilesPaginatedResponseContent {
+    /**
+     * A cursor to be used as the "from" query parameter for the next page of results.
+     *
+     */
+    next?: string;
+    /**
+     */
+    connection_profiles?: Array<ConnectionProfile>;
+}
 /**
  *
  */
@@ -18865,6 +19243,69 @@ export interface UpdateCaptchaResponseContent {
      */
     allowlist?: Array<AnomalyAllowlistFormat>;
 }
+/**
+ *
+ */
+export interface UpdateConnectionProfileRequestContent {
+    /**
+     * The name of the connection profile.
+     *
+     */
+    name?: string;
+    /**
+     */
+    organization?: ConnectionProfileOrganization;
+    /**
+     * Connection name prefix template.
+     *
+     */
+    connection_name_prefix_template?: string;
+    /**
+     */
+    enabled_features?: ConnectionProfileEnabledFeatures;
+    /**
+     * Connection profile configuration.
+     *
+     */
+    connection_config?: object;
+    /**
+     */
+    strategy_overrides?: ConnectionProfileStrategyOverrides;
+}
+/**
+ *
+ */
+export interface UpdateConnectionProfileResponseContent {
+    /**
+     * Connection Profile identifier.
+     *
+     */
+    id?: string;
+    /**
+     * The name of the connection profile.
+     *
+     */
+    name?: string;
+    /**
+     */
+    organization?: ConnectionProfileOrganization;
+    /**
+     * Connection name prefix template.
+     *
+     */
+    connection_name_prefix_template?: string;
+    /**
+     */
+    enabled_features?: ConnectionProfileEnabledFeatures;
+    /**
+     * Connection profile configuration.
+     *
+     */
+    connection_config?: object;
+    /**
+     */
+    strategy_overrides?: ConnectionProfileStrategyOverrides;
+}
 /**
  *
  */
@@ -19104,8 +19545,7 @@ export type UserAttributeProfilePatchUserId = UserAttributeProfileUserId;
 /**
  * SAML mapping override for this strategy
  */
-export interface UserAttributeProfileSamlMapping extends Array<string> {
-}
+export type UserAttributeProfileSamlMapping = Array<string>;
 /**
  * Strategy-specific overrides for this attribute
  */
@@ -19313,8 +19753,7 @@ export type UserAttributeProfileUserIdOidcStrategyOverrideMapping = (typeof User
 /**
  * SAML mapping for user ID
  */
-export interface UserAttributeProfileUserIdSamlMapping extends Array<string> {
-}
+export type UserAttributeProfileUserIdSamlMapping = Array<string>;
 /**
  *
  */
@@ -20489,6 +20928,61 @@ export interface PostRotateSecretRequest {
      */
     client_id: string;
 }
+/**
+ *
+ */
+export interface DeleteConnectionProfilesByIdRequest {
+    /**
+     * ID of the connection-profile to delete.
+     *
+     */
+    id: string;
+}
+/**
+ *
+ */
+export interface GetConnectionProfileTemplateRequest {
+    /**
+     * ID of the connection-profile-template to retrieve.
+     *
+     */
+    id: string;
+}
+/**
+ *
+ */
+export interface GetConnectionProfilesRequest {
+    /**
+     * Optional Id from which to start selection.
+     *
+     */
+    from?: string;
+    /**
+     * Number of results per page. Defaults to 5.
+     *
+     */
+    take?: number;
+}
+/**
+ *
+ */
+export interface GetConnectionProfilesByIdRequest {
+    /**
+     * ID of the connection-profile to retrieve.
+     *
+     */
+    id: string;
+}
+/**
+ *
+ */
+export interface PatchConnectionProfilesByIdRequest {
+    /**
+     * ID of the connection profile to update.
+     *
+     */
+    id: string;
+}
 /**
  *
  */