AuthN Flow API Reference

• AuthN Documentation
• OpenAPI Specification

note

Username parameters

• Non-email usernames have been implemented, so you may notice username and username_format parameters in relevant API endpoints
• email behaves the same as before, with the addition of being duplicated in the username field where necessary if not included in the request
• In some calls such as flow/start and flow/update, the email parameter only returns when username_format is set to email
• Some choices (e.g., verify_email, email_otp, magiclink) expect an email value when need_email is returned, to ensure an email address (required) is defined when a non-email username is used in the request

post/v2/client/token/check

cURL

Code Snippet Language

curl -sSLX POST 'https://authn.aws.us.pangea.cloud/v2/client/token/check' \
-H 'Authorization: Bearer <your_token>' \
-H 'Content-Type: application/json' \
-d '{}'

Response

Raw Output

200

Code Snippet Language

---

Check a token

POST

https://authn.aws.us.pangea.cloud/v2/client/token/check

Look up a token and return its contents.

required parameters

token

string

A token value

​

Response Fields

Response Schema

object

Pangea standard response schema

result

object

request_id

string

A unique identifier assigned to each request made to the API. It is used to track and identify a specific request and its associated data. The request_id can be helpful for troubleshooting, auditing, and tracing the flow of requests within the system. It allows users to reference and retrieve information related to a particular request, such as the response, parameters, and raw data associated with that specific request.

"request_id":"prq_x6fdiizbon6j3bsdvnpmwxsz2aan7fqd"

request_time

string

The timestamp indicates the exact moment when a request is made to the API. It represents the date and time at which the request was initiated by the client. The request_time is useful for tracking and analyzing the timing of requests, measuring response times, and monitoring performance metrics. It allows users to determine the duration between the request initiation and the corresponding response, aiding in the assessment of API performance and latency.

"request_time":"2022-09-21T17:24:33.105Z"

response_time

string

Duration it takes for the API to process a request and generate a response. It represents the elapsed time from when the request is received by the API to when the corresponding response is returned to the client.

"response_time":"2022-09-21T17:24:34.007Z"

status

string

It represents the status or outcome of the API request made for IP information. It indicates the current state or condition of the request and provides information on the success or failure of the request.

"status":"success"

summary

string

Provides a concise and brief overview of the purpose or primary objective of the API endpoint. It serves as a high-level summary or description of the functionality or feature offered by the endpoint.

post/v2/flow/complete

cURL

Code Snippet Language

curl -sSLX POST 'https://authn.aws.us.pangea.cloud/v2/flow/complete' \
-H 'Authorization: Bearer <your_token>' \
-H 'Content-Type: application/json' \
-d '{}'

Response

Raw Output

200

Code Snippet Language

---

Complete sign-up/sign-in

POST

https://authn.aws.us.pangea.cloud/v2/flow/complete

Complete a sign-up or sign-in flow.

required parameters

flow_id

string

An ID for a login or signup flow

​

optional parameters

device_id

string

device_id

device_id

Response Fields

Response Schema

object

Pangea standard response schema

result

object

Credentials for a login session

refresh_token

object

token

string

A token value

id

string

An ID for a token

type

string

A token type

life

integer

A positive time duration in seconds

• exclusiveMinimum: 0

expire

string (date-time)

A time in ISO-8601 format

enabled

boolean

identity

string

The identity of a user or a service

email

string

scopes

array<string>

A list of scopes

profile

object

A user profile as a collection of string properties

Pattern Property: .*

string

created_at

string (date-time)

A time in ISO-8601 format

intelligence

object

Intelligence Add-on Data

embargo

boolean

ip_intel

domain_intel

user_intel

boolean

audience

array,null<string>

client_id

string

An ID for a service account

claims

object

claim object in the token

active_token

object

token

string

A token value

id

string

An ID for a token

type

string

A token type

life

integer

A positive time duration in seconds

• exclusiveMinimum: 0

expire

string (date-time)

A time in ISO-8601 format

enabled

boolean

identity

string

The identity of a user or a service

email

string

scopes

array<string>

A list of scopes

profile

object

A user profile as a collection of string properties

Pattern Property: .*

string

created_at

string (date-time)

A time in ISO-8601 format

intelligence

object

Intelligence Add-on Data

embargo

boolean

ip_intel

domain_intel

user_intel

boolean

audience

array,null<string>

client_id

string

An ID for a service account

claims

object

claim object in the token

request_id

string

A unique identifier assigned to each request made to the API. It is used to track and identify a specific request and its associated data. The request_id can be helpful for troubleshooting, auditing, and tracing the flow of requests within the system. It allows users to reference and retrieve information related to a particular request, such as the response, parameters, and raw data associated with that specific request.

"request_id":"prq_x6fdiizbon6j3bsdvnpmwxsz2aan7fqd"

request_time

string

The timestamp indicates the exact moment when a request is made to the API. It represents the date and time at which the request was initiated by the client. The request_time is useful for tracking and analyzing the timing of requests, measuring response times, and monitoring performance metrics. It allows users to determine the duration between the request initiation and the corresponding response, aiding in the assessment of API performance and latency.

"request_time":"2022-09-21T17:24:33.105Z"

response_time

string

Duration it takes for the API to process a request and generate a response. It represents the elapsed time from when the request is received by the API to when the corresponding response is returned to the client.

"response_time":"2022-09-21T17:24:34.007Z"

status

string

It represents the status or outcome of the API request made for IP information. It indicates the current state or condition of the request and provides information on the success or failure of the request.

"status":"success"

summary

string

Provides a concise and brief overview of the purpose or primary objective of the API endpoint. It serves as a high-level summary or description of the functionality or feature offered by the endpoint.

post/v2/flow/restart

cURL

Code Snippet Language

curl -sSLX POST 'https://authn.aws.us.pangea.cloud/v2/flow/restart' \
-H 'Authorization: Bearer <your_token>' \
-H 'Content-Type: application/json' \
-d '{}'

Response

Raw Output

200

Code Snippet Language

---

Restart a sign-up/sign-in flow

POST

https://authn.aws.us.pangea.cloud/v2/flow/restart

Restart a sign-up/sign-in flow choice.

Schema

agreements

Schema

required parameters

flow_id

string

An ID for a login or signup flow

​

choice

string

Flow Choice

choice

choice

data

object

An empty object

Response Fields

Response Schema

object

Pangea standard response schema

result

object

flow_id

string

An ID for a login or signup flow

flow_type

array<string>

A list of flow types

email

string

An email address; if not populated, certain calls may return a 'need_email' in the response.

disclaimer

string

flow_phase

string

Signin/Signup Phase

flow_choices

choice

string

Flow Choice

data

object

agreements

object

Pattern Property: .*

object

A EULA

type

string

An agreement type

id

string

An ID for an agreement

created_at

string (date-time)

A time in ISO-8601 format

updated_at

string (date-time)

A time in ISO-8601 format

published_at

string (date-time)

A time in ISO-8601 format

name

string

text

string

active

boolean

request_id

string

A unique identifier assigned to each request made to the API. It is used to track and identify a specific request and its associated data. The request_id can be helpful for troubleshooting, auditing, and tracing the flow of requests within the system. It allows users to reference and retrieve information related to a particular request, such as the response, parameters, and raw data associated with that specific request.

"request_id":"prq_x6fdiizbon6j3bsdvnpmwxsz2aan7fqd"

request_time

string

The timestamp indicates the exact moment when a request is made to the API. It represents the date and time at which the request was initiated by the client. The request_time is useful for tracking and analyzing the timing of requests, measuring response times, and monitoring performance metrics. It allows users to determine the duration between the request initiation and the corresponding response, aiding in the assessment of API performance and latency.

"request_time":"2022-09-21T17:24:33.105Z"

response_time

string

Duration it takes for the API to process a request and generate a response. It represents the elapsed time from when the request is received by the API to when the corresponding response is returned to the client.

"response_time":"2022-09-21T17:24:34.007Z"

status

string

It represents the status or outcome of the API request made for IP information. It indicates the current state or condition of the request and provides information on the success or failure of the request.

"status":"success"

summary

string

Provides a concise and brief overview of the purpose or primary objective of the API endpoint. It serves as a high-level summary or description of the functionality or feature offered by the endpoint.

post/v2/flow/start

cURL

Code Snippet Language

curl -sSLX POST 'https://authn.aws.us.pangea.cloud/v2/flow/start' \
-H 'Authorization: Bearer <your_token>' \
-H 'Content-Type: application/json' \
-d '{}'

Response

Raw Output

200

Code Snippet Language

---

Start a sign-up/sign-in flow

POST

https://authn.aws.us.pangea.cloud/v2/flow/start

Start a new sign-up or sign-in flow.

fields

username

string

A username string, which can be used in place of an id or email in many cases.

​

email

string

An email address; if not populated, certain calls may return a 'need_email' in the response.

​

cb_uri

string (http-url)

A login callback URI

​

flow_types

array<string>

A list of flow types

​

invitation

string

A one-time ticket

​

saml_idp_initiated_ticket

string

A one-time ticket

​

client_id

string

An ID for a service account

​

scope

string

A list of space separated scope

​

Response Fields

Response Schema

object

Pangea standard response schema

result

object

flow_id

string

An ID for a login or signup flow

flow_type

array<string>

A list of flow types

email

string

An email address; if not populated, certain calls may return a 'need_email' in the response.

disclaimer

string

flow_phase

string

Signin/Signup Phase

flow_choices

choice

string

Flow Choice

data

object

agreements

object

Pattern Property: .*

object

A EULA

type

string

An agreement type

id

string

An ID for an agreement

created_at

string (date-time)

A time in ISO-8601 format

updated_at

string (date-time)

A time in ISO-8601 format

published_at

string (date-time)

A time in ISO-8601 format

name

string

text

string

active

boolean

request_id

string

A unique identifier assigned to each request made to the API. It is used to track and identify a specific request and its associated data. The request_id can be helpful for troubleshooting, auditing, and tracing the flow of requests within the system. It allows users to reference and retrieve information related to a particular request, such as the response, parameters, and raw data associated with that specific request.

"request_id":"prq_x6fdiizbon6j3bsdvnpmwxsz2aan7fqd"

request_time

string

The timestamp indicates the exact moment when a request is made to the API. It represents the date and time at which the request was initiated by the client. The request_time is useful for tracking and analyzing the timing of requests, measuring response times, and monitoring performance metrics. It allows users to determine the duration between the request initiation and the corresponding response, aiding in the assessment of API performance and latency.

"request_time":"2022-09-21T17:24:33.105Z"

response_time

string

Duration it takes for the API to process a request and generate a response. It represents the elapsed time from when the request is received by the API to when the corresponding response is returned to the client.

"response_time":"2022-09-21T17:24:34.007Z"

status

string

It represents the status or outcome of the API request made for IP information. It indicates the current state or condition of the request and provides information on the success or failure of the request.

"status":"success"

summary

string

Provides a concise and brief overview of the purpose or primary objective of the API endpoint. It serves as a high-level summary or description of the functionality or feature offered by the endpoint.

post/v2/flow/update

cURL

Code Snippet Language

curl -sSLX POST 'https://authn.aws.us.pangea.cloud/v2/flow/update' \
-H 'Authorization: Bearer <your_token>' \
-H 'Content-Type: application/json' \
-d '{}'

Response

Raw Output

200

Code Snippet Language

---

Update a sign-up/sign-in flow

POST

https://authn.aws.us.pangea.cloud/v2/flow/update

Update a sign-up/sign-in flow.

Schema

empty

Schema

required parameters

flow_id

string

An ID for a login or signup flow

​

choice

string

Flow Choice

choice

choice

data

object

data

data

Response Fields

Response Schema

object

Pangea standard response schema

result

object

flow_id

string

An ID for a login or signup flow

flow_type

array<string>

A list of flow types

email

string

An email address; if not populated, certain calls may return a 'need_email' in the response.

disclaimer

string

flow_phase

string

Signin/Signup Phase

flow_choices

choice

string

Flow Choice

data

object

agreements

object

Pattern Property: .*

object

A EULA

type

string

An agreement type

id

string

An ID for an agreement

created_at

string (date-time)

A time in ISO-8601 format

updated_at

string (date-time)

A time in ISO-8601 format

published_at

string (date-time)

A time in ISO-8601 format

name

string

text

string

active

boolean

request_id

string

A unique identifier assigned to each request made to the API. It is used to track and identify a specific request and its associated data. The request_id can be helpful for troubleshooting, auditing, and tracing the flow of requests within the system. It allows users to reference and retrieve information related to a particular request, such as the response, parameters, and raw data associated with that specific request.

"request_id":"prq_x6fdiizbon6j3bsdvnpmwxsz2aan7fqd"

request_time

string

The timestamp indicates the exact moment when a request is made to the API. It represents the date and time at which the request was initiated by the client. The request_time is useful for tracking and analyzing the timing of requests, measuring response times, and monitoring performance metrics. It allows users to determine the duration between the request initiation and the corresponding response, aiding in the assessment of API performance and latency.

"request_time":"2022-09-21T17:24:33.105Z"

response_time

string

Duration it takes for the API to process a request and generate a response. It represents the elapsed time from when the request is received by the API to when the corresponding response is returned to the client.

"response_time":"2022-09-21T17:24:34.007Z"

status

string

It represents the status or outcome of the API request made for IP information. It indicates the current state or condition of the request and provides information on the success or failure of the request.

"status":"success"

summary

string

Provides a concise and brief overview of the purpose or primary objective of the API endpoint. It serves as a high-level summary or description of the functionality or feature offered by the endpoint.

Was this article helpful?

Contact us