cloudflare
Version:
The official TypeScript library for the Cloudflare API
407 lines • 13.6 kB
text/typescript
import { APIResource } from "../../../core/resource.mjs";
import { APIPromise } from "../../../core/api-promise.mjs";
import { PagePromise, V4PagePaginationArray, type V4PagePaginationArrayParams } from "../../../core/pagination.mjs";
import { RequestOptions } from "../../../internal/request-options.mjs";
export declare class BaseImpersonationRegistry extends APIResource {
static readonly _key: readonly ['emailSecurity', 'settings', 'impersonationRegistry'];
/**
* Creates a new entry in the impersonation registry to protect against
* impersonation. Emails attempting to impersonate this identity will be flagged.
* Supports regex patterns for flexible email matching.
*
* @example
* ```ts
* const impersonationRegistry =
* await client.emailSecurity.settings.impersonationRegistry.create(
* {
* account_id: '023e105f4ecef8ad9ca31a8372d0c353',
* email: 'john.doe@example.com',
* is_email_regex: false,
* name: 'John Doe',
* },
* );
* ```
*/
create(params: ImpersonationRegistryCreateParams, options?: RequestOptions): APIPromise<ImpersonationRegistryCreateResponse>;
/**
* Returns a paginated list of protected identities in the impersonation registry.
* These entries define identities and email addresses to protect from
* impersonation attacks. Can be manually added or automatically synced from
* directory integrations.
*
* @example
* ```ts
* // Automatically fetches more pages as needed.
* for await (const impersonationRegistryListResponse of client.emailSecurity.settings.impersonationRegistry.list(
* { account_id: '023e105f4ecef8ad9ca31a8372d0c353' },
* )) {
* // ...
* }
* ```
*/
list(params: ImpersonationRegistryListParams, options?: RequestOptions): PagePromise<ImpersonationRegistryListResponsesV4PagePaginationArray, ImpersonationRegistryListResponse>;
/**
* Removes an entry from the impersonation registry. After deletion, this identity
* will no longer be protected from impersonation.
*
* @example
* ```ts
* const impersonationRegistry =
* await client.emailSecurity.settings.impersonationRegistry.delete(
* 'f174e90a-fafe-4643-bbbc-4a0ed4fc8415',
* { account_id: '023e105f4ecef8ad9ca31a8372d0c353' },
* );
* ```
*/
delete(impersonationRegistryID: string, params: ImpersonationRegistryDeleteParams, options?: RequestOptions): APIPromise<ImpersonationRegistryDeleteResponse>;
/**
* Updates an existing impersonation registry entry. Only provided fields will be
* modified. Directory-synced entries can't be updated.
*
* @example
* ```ts
* const response =
* await client.emailSecurity.settings.impersonationRegistry.edit(
* 'f174e90a-fafe-4643-bbbc-4a0ed4fc8415',
* { account_id: '023e105f4ecef8ad9ca31a8372d0c353' },
* );
* ```
*/
edit(impersonationRegistryID: string, params: ImpersonationRegistryEditParams, options?: RequestOptions): APIPromise<ImpersonationRegistryEditResponse>;
/**
* Retrieves details for a specific impersonation registry entry including the
* protected identity, email pattern, and synchronization source if
* directory-synced.
*
* @example
* ```ts
* const impersonationRegistry =
* await client.emailSecurity.settings.impersonationRegistry.get(
* 'f174e90a-fafe-4643-bbbc-4a0ed4fc8415',
* { account_id: '023e105f4ecef8ad9ca31a8372d0c353' },
* );
* ```
*/
get(impersonationRegistryID: string, params: ImpersonationRegistryGetParams, options?: RequestOptions): APIPromise<ImpersonationRegistryGetResponse>;
}
export declare class ImpersonationRegistry extends BaseImpersonationRegistry {
}
export type ImpersonationRegistryListResponsesV4PagePaginationArray = V4PagePaginationArray<ImpersonationRegistryListResponse>;
/**
* An impersonation registry entry.
*/
export interface ImpersonationRegistryCreateResponse {
/**
* Impersonation registry entry identifier.
*/
id?: string;
/**
* Optional note describing the entry.
*/
comments?: string | null;
created_at?: string;
/**
* Identifier of the directory the entry was synced from, when directory-synced.
*/
directory_id?: number | null;
/**
* Identifier of the directory node the entry was synced from, when
* directory-synced.
*/
directory_node_id?: number | null;
/**
* Email address (or pattern) of the protected identity.
*/
email?: string;
/**
* @deprecated This field is deprecated.
*/
external_directory_node_id?: string | null;
/**
* Whether `email` is a regular expression instead of a literal address.
*/
is_email_regex?: boolean;
/**
* @deprecated Use `modified_at` instead.
*/
last_modified?: string;
modified_at?: string;
/**
* Display name of the protected identity.
*/
name?: string;
/**
* Source the entry was created from.
*/
provenance?: 'A1S_INTERNAL' | 'SNOOPY-CASB_OFFICE_365' | 'SNOOPY-OFFICE_365' | 'SNOOPY-GOOGLE_DIRECTORY' | null;
}
/**
* An impersonation registry entry.
*/
export interface ImpersonationRegistryListResponse {
/**
* Impersonation registry entry identifier.
*/
id?: string;
/**
* Optional note describing the entry.
*/
comments?: string | null;
created_at?: string;
/**
* Identifier of the directory the entry was synced from, when directory-synced.
*/
directory_id?: number | null;
/**
* Identifier of the directory node the entry was synced from, when
* directory-synced.
*/
directory_node_id?: number | null;
/**
* Email address (or pattern) of the protected identity.
*/
email?: string;
/**
* @deprecated This field is deprecated.
*/
external_directory_node_id?: string | null;
/**
* Whether `email` is a regular expression instead of a literal address.
*/
is_email_regex?: boolean;
/**
* @deprecated Use `modified_at` instead.
*/
last_modified?: string;
modified_at?: string;
/**
* Display name of the protected identity.
*/
name?: string;
/**
* Source the entry was created from.
*/
provenance?: 'A1S_INTERNAL' | 'SNOOPY-CASB_OFFICE_365' | 'SNOOPY-OFFICE_365' | 'SNOOPY-GOOGLE_DIRECTORY' | null;
}
export interface ImpersonationRegistryDeleteResponse {
/**
* Impersonation registry entry identifier.
*/
id: string;
}
/**
* An impersonation registry entry.
*/
export interface ImpersonationRegistryEditResponse {
/**
* Impersonation registry entry identifier.
*/
id?: string;
/**
* Optional note describing the entry.
*/
comments?: string | null;
created_at?: string;
/**
* Identifier of the directory the entry was synced from, when directory-synced.
*/
directory_id?: number | null;
/**
* Identifier of the directory node the entry was synced from, when
* directory-synced.
*/
directory_node_id?: number | null;
/**
* Email address (or pattern) of the protected identity.
*/
email?: string;
/**
* @deprecated This field is deprecated.
*/
external_directory_node_id?: string | null;
/**
* Whether `email` is a regular expression instead of a literal address.
*/
is_email_regex?: boolean;
/**
* @deprecated Use `modified_at` instead.
*/
last_modified?: string;
modified_at?: string;
/**
* Display name of the protected identity.
*/
name?: string;
/**
* Source the entry was created from.
*/
provenance?: 'A1S_INTERNAL' | 'SNOOPY-CASB_OFFICE_365' | 'SNOOPY-OFFICE_365' | 'SNOOPY-GOOGLE_DIRECTORY' | null;
}
/**
* An impersonation registry entry.
*/
export interface ImpersonationRegistryGetResponse {
/**
* Impersonation registry entry identifier.
*/
id?: string;
/**
* Optional note describing the entry.
*/
comments?: string | null;
created_at?: string;
/**
* Identifier of the directory the entry was synced from, when directory-synced.
*/
directory_id?: number | null;
/**
* Identifier of the directory node the entry was synced from, when
* directory-synced.
*/
directory_node_id?: number | null;
/**
* Email address (or pattern) of the protected identity.
*/
email?: string;
/**
* @deprecated This field is deprecated.
*/
external_directory_node_id?: string | null;
/**
* Whether `email` is a regular expression instead of a literal address.
*/
is_email_regex?: boolean;
/**
* @deprecated Use `modified_at` instead.
*/
last_modified?: string;
modified_at?: string;
/**
* Display name of the protected identity.
*/
name?: string;
/**
* Source the entry was created from.
*/
provenance?: 'A1S_INTERNAL' | 'SNOOPY-CASB_OFFICE_365' | 'SNOOPY-OFFICE_365' | 'SNOOPY-GOOGLE_DIRECTORY' | null;
}
export interface ImpersonationRegistryCreateParams {
/**
* Path param: Account identifier tag.
*/
account_id: string;
/**
* Body param: Email address (or pattern) of the protected identity.
*/
email: string;
/**
* Body param: Whether `email` is a regular expression instead of a literal
* address.
*/
is_email_regex: boolean;
/**
* Body param: Display name of the protected identity.
*/
name: string;
/**
* Body param: Optional note describing the entry.
*/
comments?: string | null;
/**
* Body param: Identifier of the directory the entry was synced from, when
* directory-synced.
*/
directory_id?: number | null;
/**
* Body param: Identifier of the directory node the entry was synced from, when
* directory-synced.
*/
directory_node_id?: number | null;
/**
* @deprecated This field is deprecated.
*/
external_directory_node_id?: string | null;
/**
* Body param: Source the entry was created from.
*/
provenance?: 'A1S_INTERNAL' | 'SNOOPY-CASB_OFFICE_365' | 'SNOOPY-OFFICE_365' | 'SNOOPY-GOOGLE_DIRECTORY' | null;
}
export interface ImpersonationRegistryListParams extends V4PagePaginationArrayParams {
/**
* Path param: Account identifier tag.
*/
account_id: string;
/**
* Query param: The sorting direction.
*/
direction?: 'asc' | 'desc';
/**
* Query param: Field to sort by.
*/
order?: 'name' | 'email' | 'created_at';
/**
* Query param
*/
provenance?: 'A1S_INTERNAL' | 'SNOOPY-CASB_OFFICE_365' | 'SNOOPY-OFFICE_365' | 'SNOOPY-GOOGLE_DIRECTORY';
/**
* Query param: Search term for filtering records. Behavior may change.
*/
search?: string;
}
export interface ImpersonationRegistryDeleteParams {
/**
* Account identifier tag.
*/
account_id: string;
}
export interface ImpersonationRegistryEditParams {
/**
* Path param: Account identifier tag.
*/
account_id: string;
/**
* Body param: Optional note describing the entry.
*/
comments?: string | null;
/**
* Body param: Identifier of the directory the entry was synced from, when
* directory-synced.
*/
directory_id?: number | null;
/**
* Body param: Identifier of the directory node the entry was synced from, when
* directory-synced.
*/
directory_node_id?: number | null;
/**
* Body param: Email address (or pattern) of the protected identity.
*/
email?: string;
/**
* @deprecated This field is deprecated.
*/
external_directory_node_id?: string | null;
/**
* Body param: Whether `email` is a regular expression instead of a literal
* address.
*/
is_email_regex?: boolean;
/**
* Body param: Display name of the protected identity.
*/
name?: string;
/**
* Body param: Source the entry was created from.
*/
provenance?: 'A1S_INTERNAL' | 'SNOOPY-CASB_OFFICE_365' | 'SNOOPY-OFFICE_365' | 'SNOOPY-GOOGLE_DIRECTORY' | null;
}
export interface ImpersonationRegistryGetParams {
/**
* Account identifier tag.
*/
account_id: string;
}
export declare namespace ImpersonationRegistry {
export { type ImpersonationRegistryCreateResponse as ImpersonationRegistryCreateResponse, type ImpersonationRegistryListResponse as ImpersonationRegistryListResponse, type ImpersonationRegistryDeleteResponse as ImpersonationRegistryDeleteResponse, type ImpersonationRegistryEditResponse as ImpersonationRegistryEditResponse, type ImpersonationRegistryGetResponse as ImpersonationRegistryGetResponse, type ImpersonationRegistryListResponsesV4PagePaginationArray as ImpersonationRegistryListResponsesV4PagePaginationArray, type ImpersonationRegistryCreateParams as ImpersonationRegistryCreateParams, type ImpersonationRegistryListParams as ImpersonationRegistryListParams, type ImpersonationRegistryDeleteParams as ImpersonationRegistryDeleteParams, type ImpersonationRegistryEditParams as ImpersonationRegistryEditParams, type ImpersonationRegistryGetParams as ImpersonationRegistryGetParams, };
}
//# sourceMappingURL=impersonation-registry.d.mts.map