Classe APIKeyAuth

Provedor de autenticação onde os usuários se identificam usando uma API.

Index

Construtores

Métodos

criar excluir desabilitar habilitar buscar buscartodos

Construtores

construtor

nova autenticação de chave de API(): APIKeyAuth
Retorna ApiKeyAuth

Métodos

criar

criar(keyName): Promessa<SecretApiKey>
Cria uma chave de API que pode ser usada para autenticar como o usuário atual.
Parâmetros
- keyName: string
  o nome da chave API a ser criada.
Retorna a Promessa<SecretApiKey>
- Definido em pacotes/realm/dist/public-types/app-services/ApiKeyAuth.d.ts:35

excluir

excluir(keyId): Promessa<vazio>
Exclui uma chave de API associada ao usuário atual.
Parâmetros
- chaveId: string
  o ID da chave de API a ser excluída
Retorna a Promessa<null>
- Definido em pacotes/realm/dist/public-types/app-services/ApiKeyAuth.d.ts:49

desabilitar

desabilitar(keyId): Promessa<vazio>
Desabilite uma chave de API associada ao usuário atual.
Parâmetros
- chaveId: string
  o ID da chave de API para desabilitar
Retorna a Promessa<null>
- Definido em pacotes/realm/dist/public-types/app-services/ApiKeyAuth.d.ts:59

habilitar

habilitar(keyId): Promessa<vazio>
Habilita uma chave de API associada ao usuário atual.
Parâmetros
- chaveId: string
  o ID da chave API para habilitar
Retorna a Promessa<null>
- Definido em pacotes/realm/dist/public-types/app-services/ApiKeyAuth.d.ts:54

buscar

buscar(keyId): Promessa<Realm.Chave de API>
Busca uma chave de API associada ao usuário atual.
Parâmetros
- chaveId: string
  o ID da chave de API a ser buscada.
Retorna a promessa<Realm.Chave de API>
- Definido em pacotes/realm/dist/public-types/app-services/ApiKeyAuth.d.ts:40

buscartodos

buscartodos(): Promessa<Realm.Chave de API[]>
Busca as chaves de API associadas ao usuário atual.

Retorna a promessa<Realm.ApiKey[]>
- Definido em pacotes/realm/dist/public-types/app-services/ApiKeyAuth.d.ts:44

Gerado usando TypeDoc