类 ApiKeyAuth

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

构造函数

构造函数

方法

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

构造函数

构造函数

方法

创建

  • 创建(keyName): Promise<SecretApiKey>

  • 创建可用于以当前用户身份进行身份验证的 API 密钥。

    参数

    • keyName : string

      要创建的 API 密钥的名称。

    返回Promise < SecretApiKey >

删除

  • 删除(keyId): Promise<void>

  • 删除与当前用户关联的 API 密钥。

    参数

    • keyId : string

      要删除的 API 密钥的 ID

    返回Promise < void >

禁用

  • 禁用(keyId): Promise<void>

  • 禁用与当前用户关联的 API 密钥。

    参数

    • keyId : string

      要禁用的 API 密钥的 ID

    返回Promise < void >

enable

  • enable(keyId): Promise<void>

  • 启用与当前用户关联的 API 密钥。

    参数

    • keyId : string

      要启用的 API 密钥的 ID

    返回Promise < void >

获取

  • 获取(keyId): Promise<Realm.ApiKey>

  • 获取与当前用户关联的 API 密钥。

    参数

    • keyId : string

      要获取的 API 密钥的 ID。

    返回Promise < Realm 。 ApiKey >

获取全部

  • 获取全部(): Promise<Realm.ApiKey[ ]>

  • 获取与当前用户关联的 API 密钥。

    返回Promise < Realm 。 ApiKey [] >

设置

主题

在此页面上

使用TypeDoc生成