AuthN | Node SDK | Flow Endpoints

Flow Endpoints

Check a token

check(token: string): Promise<PangeaResponse<CheckResult>>

Look up a token and return its contents.

required parameters

token

string

A token value

Response Object

CheckResult

Promise<PangeaResponse<CheckResult>>

const response = await authn.client.clientToken.check(
  "ptu_wuk7tvtpswyjtlsx52b7yyi2l7zotv4a",
);

Complete sign-up/sign-in

complete(flowID: string): Promise<PangeaResponse<CompleteResult>>

Complete a login or signup flow.

required parameters

flowID

string

An ID for a login or signup flow

Response Object

CompleteResult

Promise<PangeaResponse<CompleteResult>>

const response = await authn.flow.complete(
  "pfl_dxiqyuq7ndc5ycjwdgmguwuodizcaqhh"
);

Restart a sign-up/sign-in flow

restart(request: RestartRequest): Promise<PangeaResponse<RestartResult>>

Restart a signup-up/in flow choice.

required parameters

requestRestartRequest

Response Object

RestartResult

Promise<PangeaResponse<RestartResult>>

const response = await authn.flow.restart({
  flow_id: "pfl_dxiqyuq7ndc5ycjwdgmguwuodizcaqhh",
  choice: AuthN.Flow.Choice.PASSWORD,
  data: {},
});

Start a sign-up/sign-in flow

start(request: StartRequest): Promise<PangeaResponse<StartResult>>

Start a new signup or signin flow.

required parameters

requestStartRequest

Response Object

StartResult

Promise<PangeaResponse<StartResult>>

const response = await authn.flow.start({
  email: "joe.user@email.com",
  cb_uri: "https://www.myserver.com/callback",
  flow_types: [
    AuthN.FlowType.SIGNIN,
    AuthN.FlowType.SIGNUP,
  ],
  invitation: "pmc_wuk7tvtpswyjtlsx52b7yyi2l7zotv4a",
});

Update a sign-up/sign-in flow

update(request: UpdateRequest): Promise<PangeaResponse<UpdateResult>>

Update a sign-up/sign-in flow.

required parameters

requestUpdateRequest

Response Object

UpdateResult

Promise<PangeaResponse<UpdateResult>>

const response = await authn.flow.update({
  flow_id: "pfl_dxiqyuq7ndc5ycjwdgmguwuodizcaqhh",
  choice: AuthN.Flow.Choice.PASSWORD,
  data: {
    password: "someNewPasswordHere",
  },
});

Namespace Flow

Flow

Enum FlowType

FlowType

SIGNIN = "signin"

SIGNUP = "signup"