• management
• SDK
• UsersClient

Class UsersClient

Index

Constructors

constructor

Methods

deleteByEmail

Properties

_options

Constructors

constructor

new UsersClient(options: BaseClientOptions): UsersClient

Parameters

• options: BaseClientOptions

Returns UsersClient

Methods

deleteByEmail

deleteByEmail(
id: string,
request: DeleteConnectionUsersByEmailQueryParameters,
requestOptions?: UsersClient.RequestOptions,
): HttpResponsePromise<void>

Deletes a specified connection user by its email (you cannot delete all users from specific connection). Currently, only Database Connections are supported.

Parameters

• id: string

The id of the connection (currently only database connections are supported)

• request: DeleteConnectionUsersByEmailQueryParameters
• OptionalrequestOptions: UsersClient.RequestOptions

Request-specific configuration.

Returns HttpResponsePromise<void>

Throws

Management.BadRequestError

Throws

Management.UnauthorizedError

Throws

Management.ForbiddenError

Throws

Management.TooManyRequestsError

Example

await client.connections.users.deleteByEmail("id", { email: "email" })Copy

Properties

Protected Readonly_options

_options: NormalizedClientOptionsWithAuth<BaseClientOptions>

Settings

Member Visibility

• Protected
• Inherited

ThemeOSLightDark

On This Page

Constructors constructor Methods deleteByEmail Properties _options