Class ApiKey


  • a chave de API de classe pública
    estende o objeto
    Classe que representa uma chave API para um User. Uma API pode ser usada para representar o usuário ao fazer login, em vez de usar e-mail e senha.

    Essas chaves são criadas ou obtidas por meio ApiKeyAuth.create(String) ou dos vários métodos fetch .

    Observe que uma chave value só está disponível quando a chave é criada, depois disso ela não fica visível. Portanto, qualquer pessoa que crie uma chave de API é responsável por armazená-la com segurança depois disso.

    • Detalhes do método

      • getId

        getId() de ObjectId público
        Retorna o identificador exclusivo para esta chave.
        Retorna:
        o ID, identificando exclusivamente a chave.
      • getValue

        @Nullable
        string pública getValue()
        Retorna este valor de chaves. Este valor só é retornado quando a chave é criada. Depois disso, o valor não é mais visível.
        Retorna:
        o valor desta chave. Só é retornado quando a chave é criada.
      • getName

        string pública getName()
        Retorna o nome desta chave.
        Retorna:
        o nome da chave.
      • isEnabled

        boolean público isEnabled()
        Retorna se esta chave está ou não habilitada no momento.
        Retorna:
        se a chave está habilitada ou não.