@okta-dfuhriman/okta-auth-js/lib/idx/authenticate.ts

The Okta Auth SDK

/*!
 * Copyright (c) 2015-present, Okta, Inc. and/or its affiliates. All rights reserved.
 * The Okta software accompanied by this notice is provided pursuant to the Apache License, Version 2.0 (the "License.")
 *
 * You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0.
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
 * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * 
 * See the License for the specific language governing permissions and limitations under the License.
 */


import { 
  OktaAuthIdxInterface,
  IdxTransaction,
  AuthenticatorKey,
  AuthenticationOptions
} from './types';
import { run } from './run';

export async function authenticate(
  authClient: OktaAuthIdxInterface, options: AuthenticationOptions = {}
): Promise<IdxTransaction> {
  if (options.password && !options.authenticator) {
    options.authenticator = AuthenticatorKey.OKTA_PASSWORD;
  }
  return run(authClient, { 
    ...options, 
    flow: 'authenticate'
  });
}