类 ApiKeyAuth

用户使用 API 密钥进行身份验证的身份验证提供者。

Index

方法

创建删除禁用 enable 获取获取全部

方法

创建

创建(keyName): Promise<SecretApiKey>
创建可用于以当前用户身份进行身份验证的 API 密钥。
参数
- keyName : string
  要创建的 API 密钥的名称。
返回Promise < SecretApiKey >
- 在包/域/src/app-services/ApiKeyAuth.ts:70中定义

删除

删除(keyId): Promise<void>
删除与当前用户关联的 API 密钥。
参数
- keyId : string
  要删除的 API 密钥的 ID
返回Promise < void >
- 在包/域/src/app-services/ApiKeyAuth.ts:97中定义

禁用

禁用(keyId): Promise<void>
禁用与当前用户关联的 API 密钥。
参数
- keyId : string
  要禁用的 API 密钥的 ID
返回Promise < void >
- 在包/域/src/app-services/ApiKeyAuth.ts:113中定义

enable

enable(keyId): Promise<void>
启用与当前用户关联的 API 密钥。
参数
- keyId : string
  要启用的 API 密钥的 ID
返回Promise < void >
- 在包/域/src/app-services/ApiKeyAuth.ts:105中定义

获取

获取(keyId): Promise<ApiKey>
获取与当前用户关联的 API 密钥。
参数
- keyId : string
  要获取的 API 密钥的 ID。
返回Promise < ApiKey >
- 在包/域/src/app-services/ApiKeyAuth.ts:80中定义

获取全部

获取全部(): Promise<ApiKey[ ]>
获取与当前用户关联的 API 密钥。

返回Promise < ApiKey [] >
- 在包/域/src/app-services/ApiKeyAuth.ts:88中定义

使用TypeDoc生成