Class Users

Index

Constructors

Methods

deleteByEmail _getAuthorizationHeader

Properties

Constructors

constructor

new Users(_options: Users.Options): Users
Parameters
- _options: Users.Options
Returns Users

Methods

deleteByEmail

deleteByEmail(
    id: string,
    request: Management.DeleteConnectionUsersByEmailQueryParameters,
    requestOptions?: Users.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: Management.DeleteConnectionUsersByEmailQueryParameters
- OptionalrequestOptions: Users.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"
    })
```

`Protected`_getAuthorizationHeader

_getAuthorizationHeader(): Promise<string>
Returns Promise<string>

Properties

`Protected` `Readonly`_options

_options: Users.Options