auth0 4.17.0 → 4.19.0

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

@@ -3512,6 +3512,45 @@ export declare const ConnectionUpdateOptionsSetUserRootAttributesEnum: {
     readonly first_login: "on_first_login";
 };
 export type ConnectionUpdateOptionsSetUserRootAttributesEnum = (typeof ConnectionUpdateOptionsSetUserRootAttributesEnum)[keyof typeof ConnectionUpdateOptionsSetUserRootAttributesEnum];
+/**
+ * Phone provider configuration schema
+ */
+export interface CreatePhoneProviderRequest {
+    [key: string]: any | any;
+    /**
+     * Name of the phone notification provider
+     *
+     */
+    name: CreatePhoneProviderRequestNameEnum;
+    /**
+     * Whether the provider is enabled (false) or disabled (true).
+     *
+     */
+    disabled?: boolean;
+    /**
+     */
+    configuration?: GetBrandingPhoneProviders200ResponseProvidersInnerConfiguration;
+    /**
+     */
+    credentials: CreatePhoneProviderRequestCredentials;
+}
+export declare const CreatePhoneProviderRequestNameEnum: {
+    readonly twilio: "twilio";
+    readonly custom: "custom";
+};
+export type CreatePhoneProviderRequestNameEnum = (typeof CreatePhoneProviderRequestNameEnum)[keyof typeof CreatePhoneProviderRequestNameEnum];
+/**
+ * Provider credentials required to use authenticate to the provider.
+ */
+export type CreatePhoneProviderRequestCredentials = CreatePhoneProviderRequestCredentialsAnyOf | object;
+/**
+ *
+ */
+export interface CreatePhoneProviderRequestCredentialsAnyOf {
+    /**
+     */
+    auth_token: string;
+}
 /**
  *
  */
@@ -4876,6 +4915,103 @@ export interface GetBranding200ResponseFont {
      */
     url: string;
 }
+/**
+ *
+ */
+export interface GetBrandingPhoneProviders200Response {
+    /**
+     */
+    providers: Array<GetBrandingPhoneProviders200ResponseProvidersInner>;
+}
+/**
+ * Phone provider configuration schema
+ */
+export interface GetBrandingPhoneProviders200ResponseProvidersInner {
+    /**
+     */
+    id?: string;
+    /**
+     * The name of the tenant
+     *
+     */
+    tenant?: string;
+    /**
+     * Name of the phone notification provider
+     *
+     */
+    name: GetBrandingPhoneProviders200ResponseProvidersInnerNameEnum;
+    /**
+     * This depicts the type of notifications this provider can receive.
+     *
+     */
+    channel?: GetBrandingPhoneProviders200ResponseProvidersInnerChannelEnum;
+    /**
+     * Whether the provider is enabled (false) or disabled (true).
+     *
+     */
+    disabled?: boolean;
+    /**
+     */
+    configuration?: GetBrandingPhoneProviders200ResponseProvidersInnerConfiguration;
+    /**
+     * The provider's creation date and time in ISO 8601 format
+     *
+     */
+    created_at?: string;
+    /**
+     * The date and time of the last update to the provider in ISO 8601 format
+     *
+     */
+    updated_at?: string;
+}
+export declare const GetBrandingPhoneProviders200ResponseProvidersInnerNameEnum: {
+    readonly twilio: "twilio";
+    readonly custom: "custom";
+};
+export type GetBrandingPhoneProviders200ResponseProvidersInnerNameEnum = (typeof GetBrandingPhoneProviders200ResponseProvidersInnerNameEnum)[keyof typeof GetBrandingPhoneProviders200ResponseProvidersInnerNameEnum];
+export declare const GetBrandingPhoneProviders200ResponseProvidersInnerChannelEnum: {
+    readonly phone: "phone";
+};
+export type GetBrandingPhoneProviders200ResponseProvidersInnerChannelEnum = (typeof GetBrandingPhoneProviders200ResponseProvidersInnerChannelEnum)[keyof typeof GetBrandingPhoneProviders200ResponseProvidersInnerChannelEnum];
+/**
+ *
+ */
+export type GetBrandingPhoneProviders200ResponseProvidersInnerConfiguration = GetBrandingPhoneProviders200ResponseProvidersInnerConfigurationAnyOf | GetBrandingPhoneProviders200ResponseProvidersInnerConfigurationAnyOf1;
+/**
+ *
+ */
+export interface GetBrandingPhoneProviders200ResponseProvidersInnerConfigurationAnyOf {
+    /**
+     */
+    default_from?: string;
+    /**
+     */
+    mssid?: string;
+    /**
+     */
+    sid: string;
+    /**
+     */
+    delivery_methods: Array<GetBrandingPhoneProviders200ResponseProvidersInnerConfigurationAnyOfDeliveryMethodsEnum>;
+}
+export declare const GetBrandingPhoneProviders200ResponseProvidersInnerConfigurationAnyOfDeliveryMethodsEnum: {
+    readonly text: "text";
+    readonly voice: "voice";
+};
+export type GetBrandingPhoneProviders200ResponseProvidersInnerConfigurationAnyOfDeliveryMethodsEnum = (typeof GetBrandingPhoneProviders200ResponseProvidersInnerConfigurationAnyOfDeliveryMethodsEnum)[keyof typeof GetBrandingPhoneProviders200ResponseProvidersInnerConfigurationAnyOfDeliveryMethodsEnum];
+/**
+ *
+ */
+export interface GetBrandingPhoneProviders200ResponseProvidersInnerConfigurationAnyOf1 {
+    /**
+     */
+    delivery_methods: Array<GetBrandingPhoneProviders200ResponseProvidersInnerConfigurationAnyOf1DeliveryMethodsEnum>;
+}
+export declare const GetBrandingPhoneProviders200ResponseProvidersInnerConfigurationAnyOf1DeliveryMethodsEnum: {
+    readonly text: "text";
+    readonly voice: "voice";
+};
+export type GetBrandingPhoneProviders200ResponseProvidersInnerConfigurationAnyOf1DeliveryMethodsEnum = (typeof GetBrandingPhoneProviders200ResponseProvidersInnerConfigurationAnyOf1DeliveryMethodsEnum)[keyof typeof GetBrandingPhoneProviders200ResponseProvidersInnerConfigurationAnyOf1DeliveryMethodsEnum];
 /**
  *
  */
@@ -5278,6 +5414,89 @@ export interface GetEnabledConnections200ResponseOneOfInner {
      */
     connection: PostOrganizations201ResponseEnabledConnectionsInnerConnection;
 }
+/**
+ *
+ */
+export type GetEncryptionKeys200Response = Array<GetEncryptionKeys200ResponseOneOfInner> | GetEncryptionKeys200ResponseOneOf;
+/**
+ *
+ */
+export interface GetEncryptionKeys200ResponseOneOf {
+    /**
+     * Page index of the results to return. First page is 0.
+     *
+     */
+    start: number;
+    /**
+     * Number of results per page.
+     *
+     */
+    limit: number;
+    /**
+     * Total amount of encryption keys.
+     *
+     */
+    total: number;
+    /**
+     * Encryption keys.
+     *
+     */
+    keys: Array<GetEncryptionKeys200ResponseOneOfInner>;
+}
+/**
+ * Encryption key
+ */
+export interface GetEncryptionKeys200ResponseOneOfInner {
+    /**
+     * Key ID
+     *
+     */
+    kid: string;
+    /**
+     * Key type
+     *
+     */
+    type: GetEncryptionKeys200ResponseOneOfInnerTypeEnum;
+    /**
+     * Key state
+     *
+     */
+    state: GetEncryptionKeys200ResponseOneOfInnerStateEnum;
+    /**
+     * Key creation timestamp
+     *
+     */
+    created_at: string;
+    /**
+     * Key update timestamp
+     *
+     */
+    updated_at: string;
+    /**
+     * ID of parent wrapping key
+     *
+     */
+    parent_kid: string;
+    /**
+     * Public key in PEM format
+     *
+     */
+    public_key?: string;
+}
+export declare const GetEncryptionKeys200ResponseOneOfInnerTypeEnum: {
+    readonly customer_provided_root_key: "customer-provided-root-key";
+    readonly environment_root_key: "environment-root-key";
+    readonly tenant_master_key: "tenant-master-key";
+    readonly tenant_encryption_key: "tenant-encryption-key";
+};
+export type GetEncryptionKeys200ResponseOneOfInnerTypeEnum = (typeof GetEncryptionKeys200ResponseOneOfInnerTypeEnum)[keyof typeof GetEncryptionKeys200ResponseOneOfInnerTypeEnum];
+export declare const GetEncryptionKeys200ResponseOneOfInnerStateEnum: {
+    readonly pre_activation: "pre-activation";
+    readonly active: "active";
+    readonly deactivated: "deactivated";
+    readonly destroyed: "destroyed";
+};
+export type GetEncryptionKeys200ResponseOneOfInnerStateEnum = (typeof GetEncryptionKeys200ResponseOneOfInnerStateEnum)[keyof typeof GetEncryptionKeys200ResponseOneOfInnerStateEnum];
 /**
  *
  */
@@ -7780,6 +7999,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];
 /**
  *
  */
@@ -9179,6 +9456,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;
+}
 /**
  *
  */
@@ -10145,6 +10437,53 @@ export interface PostEnabledConnectionsRequest {
      */
     show_as_button?: boolean;
 }
+/**
+ *
+ */
+export interface PostEncryptionKeyRequest {
+    [key: string]: any | any;
+    /**
+     * Base64 encoded ciphertext of key material wrapped by public wrapping key.
+     *
+     */
+    wrapped_key: string;
+}
+/**
+ *
+ */
+export interface PostEncryptionRequest {
+    [key: string]: any | any;
+    /**
+     * Type of the encryption key to be created.
+     *
+     */
+    type: PostEncryptionRequestTypeEnum;
+}
+export declare const PostEncryptionRequestTypeEnum: {
+    readonly customer_provided_root_key: "customer-provided-root-key";
+    readonly tenant_encryption_key: "tenant-encryption-key";
+};
+export type PostEncryptionRequestTypeEnum = (typeof PostEncryptionRequestTypeEnum)[keyof typeof PostEncryptionRequestTypeEnum];
+/**
+ *
+ */
+export interface PostEncryptionWrappingKey201Response {
+    [key: string]: any | any;
+    /**
+     * Public wrapping key in PEM format
+     *
+     */
+    public_key: string;
+    /**
+     * Encryption algorithm that shall be used to wrap your key material
+     *
+     */
+    algorithm: PostEncryptionWrappingKey201ResponseAlgorithmEnum;
+}
+export declare const PostEncryptionWrappingKey201ResponseAlgorithmEnum: {
+    readonly CKM_RSA_AES_KEY_WRAP: "CKM_RSA_AES_KEY_WRAP";
+};
+export type PostEncryptionWrappingKey201ResponseAlgorithmEnum = (typeof PostEncryptionWrappingKey201ResponseAlgorithmEnum)[keyof typeof PostEncryptionWrappingKey201ResponseAlgorithmEnum];
 /**
  *
  */
@@ -13058,6 +13397,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];
 /**
  *
  */
@@ -15273,6 +15641,32 @@ export interface TwilioFactorProvider {
      */
     sid: string | null;
 }
+/**
+ *
+ */
+export interface UpdatePhoneProviderRequest {
+    /**
+     * Name of the phone notification provider
+     *
+     */
+    name?: UpdatePhoneProviderRequestNameEnum;
+    /**
+     * Whether the provider is enabled (false) or disabled (true).
+     *
+     */
+    disabled?: boolean;
+    /**
+     */
+    credentials?: CreatePhoneProviderRequestCredentials;
+    /**
+     */
+    configuration?: GetBrandingPhoneProviders200ResponseProvidersInnerConfiguration;
+}
+export declare const UpdatePhoneProviderRequestNameEnum: {
+    readonly twilio: "twilio";
+    readonly custom: "custom";
+};
+export type UpdatePhoneProviderRequestNameEnum = (typeof UpdatePhoneProviderRequestNameEnum)[keyof typeof UpdatePhoneProviderRequestNameEnum];
 /**
  *
  */
@@ -15949,6 +16343,24 @@ export interface DeleteBrandingThemeRequest {
      */
     themeId: string;
 }
+/**
+ *
+ */
+export interface DeletePhoneProviderRequest {
+    /**
+     */
+    id: string;
+}
+/**
+ *
+ */
+export interface GetBrandingPhoneProvidersRequest {
+    /**
+     * Whether the provider is enabled (false) or disabled (true).
+     *
+     */
+    disabled?: boolean;
+}
 /**
  *
  */
@@ -15959,6 +16371,14 @@ export interface GetBrandingThemeRequest {
      */
     themeId: string;
 }
+/**
+ *
+ */
+export interface GetPhoneProviderRequest {
+    /**
+     */
+    id: string;
+}
 /**
  *
  */
@@ -15969,6 +16389,14 @@ export interface PatchBrandingThemeRequest {
      */
     themeId: string;
 }
+/**
+ *
+ */
+export interface UpdatePhoneProviderOperationRequest {
+    /**
+     */
+    id: string;
+}
 /**
  *
  */
@@ -17220,6 +17648,46 @@ export interface PostUsersImportsData {
      */
     send_completion_email?: boolean;
 }
+/**
+ *
+ */
+export interface DeleteEncryptionKeyRequest {
+    /**
+     * Encryption key ID
+     *
+     */
+    kid: string;
+}
+/**
+ *
+ */
+export interface GetEncryptionKeyRequest {
+    /**
+     * Encryption key ID
+     *
+     */
+    kid: string;
+}
+/**
+ *
+ */
+export interface GetEncryptionKeysRequest {
+    /**
+     * Page index of the results to return. First page is 0.
+     *
+     */
+    page?: number;
+    /**
+     * Number of results per page. Default value is 50, maximum value is 100.
+     *
+     */
+    per_page?: number;
+    /**
+     * Return results inside an object that contains the total result count (true) or as a direct array of results (false, default).
+     *
+     */
+    include_totals?: boolean;
+}
 /**
  *
  */
@@ -17230,6 +17698,26 @@ export interface GetSigningKeyRequest {
      */
     kid: string;
 }
+/**
+ *
+ */
+export interface PostEncryptionKeyOperationRequest {
+    /**
+     * Encryption key ID
+     *
+     */
+    kid: string;
+}
+/**
+ *
+ */
+export interface PostEncryptionWrappingKeyRequest {
+    /**
+     * Encryption key ID
+     *
+     */
+    kid: string;
+}
 /**
  *
  */
@@ -18825,6 +19313,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;
+}
 /**
  *
  */