AuthN User API Reference

post/v2/client/userinfo

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

Response

Raw Output

Get current user | Client token

POST

https://authn.aws.us.pangea.cloud/v2/client/userinfo

Retrieve the logged in user's token and information.

required parameters

code

string

Login code returned by the login callback

optional parameters

flow_id

string

An ID for a login or signup flow

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/client/password/change

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

Response

Raw Output

Change password | Client token

POST

https://authn.aws.us.pangea.cloud/v2/client/password/change

Change a user's password given the current password.

required parameters

token

string

A user token value

old_password

string

old_password

new_password

string

new_password

Response Fields

Response Schema

object

Pangea standard response schema

result

object

An empty 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/user/authenticators/delete

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

Response

Raw Output

Delete user authenticator

POST

https://authn.aws.us.pangea.cloud/v2/user/authenticators/delete

Delete a user's authenticator.

required parameters

username

string

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

authenticator_id

string

An ID for an authenticator

Response Fields

Response Schema

object

Pangea standard response schema

result

object

An empty 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/user/authenticators/list

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

Response

Raw Output

List user authenticators

POST

https://authn.aws.us.pangea.cloud/v2/user/authenticators/list

Get user's authenticators by identity or email.

required parameters

username

string

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

Response Fields

Response Schema

object

Pangea standard response schema

result

object

authenticators

array<object>

A list of authenticators

id

string

An ID for an authenticator

type

string

An authentication mechanism

provider

string

provider_name

string

rpid

string

enabled

boolean

state

string

phase

string

enrolling_browser

string

enrolling_ip

string

created_at

string (date-time)

A time in ISO-8601 format

updated_at

string (date-time)

A time in ISO-8601 format

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/user/create

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

Response

Raw Output

Create user

POST

https://authn.aws.us.pangea.cloud/v2/user/create

Create a user.

required parameters

email

string

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

profile

object

A user profile as a collection of string properties

Click 'Save' to use the value

Pattern Property: .*

string

optional parameters

username

string

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

Response Fields

Response Schema

object

Pangea standard response schema

result

object

id

string

The identity of a user or a service

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.

phone

string (phone-E164-format)

A phone number

profile

object

A user profile as a collection of string properties

Pattern Property: .*

string

verified

boolean

True if the user's email has been verified

disabled

boolean

True if the service administrator has disabled user account

locked_out

boolean

True if the user account has been locked out

accepted_eula_id

string

An ID for an agreement

accepted_privacy_policy_id

string

An ID for an agreement

last_login_at

string (date-time)

A time in ISO-8601 format

created_at

string (date-time)

A time in ISO-8601 format

login_count

integer

last_login_ip

string

last_login_city

string

last_login_country

string

authenticators

array<object>

A list of authenticators

id

string

An ID for an authenticator

type

string

An authentication mechanism

provider

string

provider_name

string

rpid

string

enabled

boolean

state

string

phase

string

enrolling_browser

string

enrolling_ip

string

created_at

string (date-time)

A time in ISO-8601 format

updated_at

string (date-time)

A time in ISO-8601 format

groups

array<string>

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/user/delete

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

Response

Raw Output

Delete user

POST

https://authn.aws.us.pangea.cloud/v2/user/delete

Delete a user.

required parameters

username

string

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

Response Fields

Response Schema

object

Pangea standard response schema

result

object

An empty 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/user/list

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

Response

Raw Output

List users

POST

https://authn.aws.us.pangea.cloud/v2/user/list

Look up users by scopes.

fields

filter

object

Pattern Property: ^profile_([A-Za-z]+)$

string

Only records where metadata field equals this value.

Pattern Property: ^profile_([A-Za-z]+)__contains$

array<string>

Only records where metadata field contains one of these substrings.

Pattern Property: ^profile_([A-Za-z]+)__exists$

boolean

Only records where metadata field exists (true) or doesn't (false).

accepted_eula_id

string

Only records where accepted_eula_id equals this value.

accepted_eula_id

accepted_eula_id__contains

array<string>

Only records where accepted_eula_id includes each substring.

Click 'Save' to use the value

accepted_eula_id__in

array<string>

Only records where accepted_eula_id equals one of the provided substrings.

Click 'Save' to use the value

accepted_privacy_policy_id

string

Only records where accepted_privacy_policy_id equals this value.

accepted_privacy_policy_id

accepted_privacy_policy_id__contains

array<string>

Only records where accepted_privacy_policy_id includes each substring.

Click 'Save' to use the value

accepted_privacy_policy_id__in

array<string>

Only records where accepted_privacy_policy_id equals one of the provided substrings.

Click 'Save' to use the value

created_at

string (date-time)

Only records where created_at equals this value.

created_at

created_at__gt

string (date-time)

Only records where created_at is greater than this value.

created_at__gt

created_at__gte

string (date-time)

Only records where created_at is greater than or equal to this value.

created_at__gte

created_at__lt

string (date-time)

Only records where created_at is less than this value.

created_at__lt

created_at__lte

string (date-time)

Only records where created_at is less than or equal to this value.

created_at__lte

disabled

boolean

Only records where disabled equals this value.

disabled

email

string

Only records where email equals this value.

email

email__contains

array<string>

Only records where email includes each substring.

Click 'Save' to use the value

email__in

array<string>

Only records where email equals one of the provided substrings.

Click 'Save' to use the value

username

string

Only records where username equals this value.

username

username__contains

array<string>

Only records where username includes each substring.

Click 'Save' to use the value

username__in

array<string>

Only records where username equals one of the provided substrings.

Click 'Save' to use the value

id

string

Only records where id equals this value.

id

id__contains

array<string>

Only records where id includes each substring.

Click 'Save' to use the value

id__in

array<string>

Only records where id equals one of the provided substrings.

Click 'Save' to use the value

last_login_at

string (date-time)

Only records where last_login_at equals this value.

last_login_at

last_login_at__gt

string (date-time)

Only records where last_login_at is greater than this value.

last_login_at__gt

last_login_at__gte

string (date-time)

Only records where last_login_at is greater than or equal to this value.

last_login_at__gte

last_login_at__lt

string (date-time)

Only records where last_login_at is less than this value.

last_login_at__lt

last_login_at__lte

string (date-time)

Only records where last_login_at is less than or equal to this value.

last_login_at__lte

last_login_ip

string

Only records where last_login_ip equals this value.

last_login_ip

last_login_ip__contains

array<string>

Only records where last_login_ip includes each substring.

Click 'Save' to use the value

last_login_ip__in

array<string>

Only records where last_login_ip equals one of the provided substrings.

Click 'Save' to use the value

login_count

integer

Only records where login_count equals this value.

login_count

login_count__gt

integer

Only records where login_count is greater than this value.

login_count__gt

login_count__gte

integer

Only records where login_count is greater than or equal to this value.

login_count__gte

login_count__lt

integer

Only records where login_count is less than to this value.

login_count__lt

login_count__lte

integer

Only records where login_count is less than or equal to this value.

login_count__lte

require_mfa

boolean

Only records where require_mfa equals this value.

require_mfa

scopes

array<string>

A list of tags that all must be present.

Click 'Save' to use the value

verified

boolean

Only records where verified equals this value.

verified

last

string

Reflected value from a previous response to obtain the next page of results.

last

order

string

Order results asc(ending) or desc(ending).

order

order_by

string

Which field to order results by.

order_by

size

integer

Maximum results to include in the response.

minimum: 1

size

Response Fields

Response Schema

object

Pangea standard response schema

result

object

users

array<object>

id

string

The identity of a user or a service

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.

phone

string (phone-E164-format)

A phone number

profile

object

A user profile as a collection of string properties

Pattern Property: .*

string

verified

boolean

True if the user's email has been verified

disabled

boolean

True if the service administrator has disabled user account

locked_out

boolean

True if the user account has been locked out

accepted_eula_id

string

An ID for an agreement

accepted_privacy_policy_id

string

An ID for an agreement

last_login_at

string (date-time)

A time in ISO-8601 format

created_at

string (date-time)

A time in ISO-8601 format

login_count

integer

last_login_ip

string

last_login_city

string

last_login_country

string

authenticators

array<object>

A list of authenticators

id

string

An ID for an authenticator

type

string

An authentication mechanism

provider

string

provider_name

string

rpid

string

enabled

boolean

state

string

phase

string

enrolling_browser

string

enrolling_ip

string

created_at

string (date-time)

A time in ISO-8601 format

updated_at

string (date-time)

A time in ISO-8601 format

groups

array<string>

count

integer

last

string

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/user/password/expire

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

Response

Raw Output

Expire user password

POST

https://authn.aws.us.pangea.cloud/v2/user/password/expire

The next time the user logs in they must set a new password.

required parameters

id

string

The identity of a user or a service

Response Fields

Response Schema

object

Pangea standard response schema

result

object

An empty 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/user/profile/get

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

Response

Raw Output

Get user

POST

https://authn.aws.us.pangea.cloud/v2/user/profile/get

Get user's information by identity or email.

required parameters

username

string

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

Response Fields

Response Schema

object

Pangea standard response schema

result

object

id

string

The identity of a user or a service

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.

phone

string (phone-E164-format)

A phone number

profile

object

A user profile as a collection of string properties

Pattern Property: .*

string

verified

boolean

True if the user's email has been verified

disabled

boolean

True if the service administrator has disabled user account

locked_out

boolean

True if the user account has been locked out

accepted_eula_id

string

An ID for an agreement

accepted_privacy_policy_id

string

An ID for an agreement

last_login_at

string (date-time)

A time in ISO-8601 format

created_at

string (date-time)

A time in ISO-8601 format

login_count

integer

last_login_ip

string

last_login_city

string

last_login_country

string

authenticators

array<object>

A list of authenticators

id

string

An ID for an authenticator

type

string

An authentication mechanism

provider

string

provider_name

string

rpid

string

enabled

boolean

state

string

phase

string

enrolling_browser

string

enrolling_ip

string

created_at

string (date-time)

A time in ISO-8601 format

updated_at

string (date-time)

A time in ISO-8601 format

groups

array<string>

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/user/profile/update

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

Response

Raw Output

Update user

POST

https://authn.aws.us.pangea.cloud/v2/user/profile/update

Update user's information by identity or email.

required parameters

username

string

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

profile

object

Updates to a user profile

Click 'Save' to use the value

Pattern Property: .*

string, null

New value, or null to delete the existing value

Response Fields

Response Schema

object

Pangea standard response schema

result

object

id

string

The identity of a user or a service

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.

phone

string (phone-E164-format)

A phone number

profile

object

A user profile as a collection of string properties

Pattern Property: .*

string

verified

boolean

True if the user's email has been verified

disabled

boolean

True if the service administrator has disabled user account

locked_out

boolean

True if the user account has been locked out

accepted_eula_id

string

An ID for an agreement

accepted_privacy_policy_id

string

An ID for an agreement

last_login_at

string (date-time)

A time in ISO-8601 format

created_at

string (date-time)

A time in ISO-8601 format

login_count

integer

last_login_ip

string

last_login_city

string

last_login_country

string

authenticators

array<object>

A list of authenticators

id

string

An ID for an authenticator

type

string

An authentication mechanism

provider

string

provider_name

string

rpid

string

enabled

boolean

state

string

phase

string

enrolling_browser

string

enrolling_ip

string

created_at

string (date-time)

A time in ISO-8601 format

updated_at

string (date-time)

A time in ISO-8601 format

groups

array<string>

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/user/update

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

Response

Raw Output

Update user settings

POST

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

Update user's settings.

required parameters

username

string

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

optional parameters

disabled

boolean

New disabled value. Disabling a user account will prevent them from logging in.

disabled

unlock

boolean

Unlock a user account if it has been locked out due to failed Authentication attempts.

unlock

Response Fields

Response Schema

object

Pangea standard response schema

result

object

id

string

The identity of a user or a service

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.

phone

string (phone-E164-format)

A phone number

profile

object

A user profile as a collection of string properties

Pattern Property: .*

string

verified

boolean

True if the user's email has been verified

disabled

boolean

True if the service administrator has disabled user account

locked_out

boolean

True if the user account has been locked out

accepted_eula_id

string

An ID for an agreement

accepted_privacy_policy_id

string

An ID for an agreement

last_login_at

string (date-time)

A time in ISO-8601 format

created_at

string (date-time)

A time in ISO-8601 format

login_count

integer

last_login_ip

string

last_login_city

string

last_login_country

string

authenticators

array<object>

A list of authenticators

id

string

An ID for an authenticator

type

string

An authentication mechanism

provider

string

provider_name

string

rpid

string

enabled

boolean

state

string

phase

string

enrolling_browser

string

enrolling_ip

string

created_at

string (date-time)

A time in ISO-8601 format

updated_at

string (date-time)

A time in ISO-8601 format

groups

array<string>

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/users/import

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

Response

Raw Output

Import user

POST

https://authn.aws.us.pangea.cloud/v2/users/import

One time user import from a given source.

required parameters

name

string

Display name

name

source_id

string

An ID for a user import source id

field_mappings

array<object>

Schema for mapping source fields to Pangea fields

Click 'Save' to use the value

source_field

object

Schema for source field and type

source_field_name

string

The name of the field in the source system

source_field_name

source_field_type

string

The data type of the field in the source system

source_field_type

tags

array<object>

Click 'Save' to use the value

key

string

key

value

string

value

pangea_field

object

Pangea field and its properties

pangea_field_name

string

The corresponding name of the field in Pangea

pangea_field_name

pangea_field_type

string

The accepted data types of the field in Pangea

pangea_field_type

required

boolean

Indicates if the field is required

required

is_profile_field

boolean

Indicates if the field is profile or not

is_profile_field

tags

array<object>

Click 'Save' to use the value

key

string

key

value

string

value

password_hash_params

object

iterations

integer (uint32)

The number of iterations over the memory.

maximum: 1,500,000

iterations

salt

string

Salt

salt

salt_order

string

Order in which salt is applied

salt_order

key_length

integer

Length of the generated key.

key_length

digest_algorithm

string

Algorithm used to generate the key.

digest_algorithm

memory

integer (uint32)

The amount of memory (in KB) used by the algorithm.

maximum: 65,536

memory

parallelism

integer (uint8)

The number of threads used by the algorithm.

maximum: 4

parallelism

block_size

integer (int)

scrypt block size parameter

maximum: 8

block_size

cost_factor

integer (int)

scrypt CPU/memory cost parameter. Must be a power of 2

cost_factor

salt_separator

string

base64 encoded salt separator required for firebase scrypt algorithm

salt_separator

signer_key

string

base64 encoded private key which is required for firebase scrypt algorithm

signer_key

algorithm

string

type of hashing algorithm

algorithm

Response Fields

Response Schema

object

Pangea standard response schema

result

object

name

string

id

string

An ID for a user import id

status

string

User import status

summary

object

total

integer

total number of user record is processed from the given source

successful

integer

count of successful imported users

failed

integer

count of failed imported users

skipped

integer

count of existing user records, which was skipped during import

updated_at

string (date-time)

A time in ISO-8601 format

created_at

string (date-time)

A time in ISO-8601 format

details

array<object>

user_id

string

status

string

message

string

created_at

string (date-time)

A time in ISO-8601 format

created_at

string (date-time)

A time in ISO-8601 format

updated_at

string (date-time)

A time in ISO-8601 format

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/users/sources/upload

curl -sSLX POST 'https://authn.aws.us.pangea.cloud/v2/users/sources/upload' \
-H 'Authorization: Bearer <your_token>' \
-H 'Content-Type: multipart/form-data'

Response

Raw Output

Import users from file

POST

https://authn.aws.us.pangea.cloud/v2/users/sources/upload

Upload a file.

required parameters

request

object

transfer_method

string

(default: "multipart")

The transfer method used to upload the file data.

transfer_method

file_type

string

(default: "csv")

file type

file_type

upload

Response Fields

Response Schema

object

Pangea standard response schema

result

object

The object that was created.

id

string

An ID for a user import source id

source_fields

array<object>

source_field_name

string

The name of the field in the source system

source_field_type

string

The data type of the field in the source system

tags

array<object>

key

string

value

string

pangea_fields

array<object>

pangea_field_name

string

The corresponding name of the field in Pangea

pangea_field_type

string

The accepted data types of the field in Pangea

required

boolean

Indicates if the field is required

is_profile_field

boolean

Indicates if the field is profile or not

tags

array<object>

key

string

value

string

password_hash_params

object

iterations

integer (uint32)

The number of iterations over the memory.

maximum: 1,500,000

salt

string

Salt

salt_order

string

Order in which salt is applied

key_length

integer

Length of the generated key.

digest_algorithm

string

Algorithm used to generate the key.

memory

integer (uint32)

The amount of memory (in KB) used by the algorithm.

maximum: 65,536

parallelism

integer (uint8)

The number of threads used by the algorithm.

maximum: 4

block_size

integer (int)

scrypt block size parameter

maximum: 8

cost_factor

integer (int)

scrypt CPU/memory cost parameter. Must be a power of 2

salt_separator

string

base64 encoded salt separator required for firebase scrypt algorithm

signer_key

string

base64 encoded private key which is required for firebase scrypt algorithm

algorithm

string

type of hashing algorithm

password_hash_algorithms

array<string>

List of supported password hashing algorithms

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/users/import/get

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

Response

Raw Output

Get import details

POST

https://authn.aws.us.pangea.cloud/v2/users/import/get

Get user import details

required parameters

id

string

An ID for a user import id

optional parameters

verbose_failed

boolean

Enable this option to retrieve detailed information about users whose import have failed. When set to true, the system will include comprehensive error details, such as the nature of the failure and the specific user data associated with the failure. This can be useful for debugging and auditing purposes.

verbose_failed

verbose_skipped

boolean

Enable this option to retrieve detailed information about users whose import have skipped. When set to true, the system will include comprehensive error details, such as the nature of the failure and the specific user data associated with the failure. This can be useful for debugging and auditing purposes.

verbose_skipped

verbose_success

boolean

Enable this option to retrieve detailed information about users whose import have success. When set to true, the system will include comprehensive error details, such as the nature of the failure and the specific user data associated with the failure. This can be useful for debugging and auditing purposes.

verbose_success

Response Fields

Response Schema

object

Pangea standard response schema

result

object

name

string

id

string

An ID for a user import id

status

string

User import status

summary

object

total

integer

total number of user record is processed from the given source

successful

integer

count of successful imported users

failed

integer

count of failed imported users

skipped

integer

count of existing user records, which was skipped during import

updated_at

string (date-time)

A time in ISO-8601 format

created_at

string (date-time)

A time in ISO-8601 format

details

array<object>

user_id

string

status

string

message

string

created_at

string (date-time)

A time in ISO-8601 format

created_at

string (date-time)

A time in ISO-8601 format

updated_at

string (date-time)

A time in ISO-8601 format

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/users/import/list

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

Response

Raw Output

List imports

POST

https://authn.aws.us.pangea.cloud/v2/users/import/list

Lookup active or past user import data

fields

filter

object

created_at

string (date-time)

Only records where created_at equals this value.

created_at

created_at__gt

string (date-time)

Only records where created_at is greater than this value.

created_at__gt

created_at__gte

string (date-time)

Only records where created_at is greater than or equal to this value.

created_at__gte

created_at__lt

string (date-time)

Only records where created_at is less than this value.

created_at__lt

created_at__lte

string (date-time)

Only records where created_at is less than or equal to this value.

created_at__lte

id

string

Only records where id equals this value.

id

id__contains

array<string>

Only records where id includes each substring.

Click 'Save' to use the value

id__in

array<string>

Only records where id equals one of the provided substrings.

Click 'Save' to use the value

name

string

Only records where name equals this value.

name

name__contains

array<string>

Only records where name includes each substring.

Click 'Save' to use the value

name__in

array<string>

Only records where name equals one of the provided substrings.

Click 'Save' to use the value

updated_at

string (date-time)

Only records where updated_at equals this value.

updated_at

updated_at__gt

string (date-time)

Only records where updated_at is greater than this value.

updated_at__gt

updated_at__gte

string (date-time)

Only records where updated_at is greater than or equal to this value.

updated_at__gte

updated_at__lt

string (date-time)

Only records where updated_at is less than this value.

updated_at__lt

updated_at__lte

string (date-time)

Only records where updated_at is less than or equal to this value.

updated_at__lte

last

string

Reflected value from a previous response to obtain the next page of results.

last

order

string

Order results asc(ending) or desc(ending).

order

order_by

string

Which field to order results by.

order_by

size

integer

Maximum results to include in the response.

minimum: 1

size

Response Fields

Response Schema

object

Pangea standard response schema

result

object

user_imports

array<object>

name

string

id

string

An ID for a user import id

status

string

User import status

summary

object

total

integer

total number of user record is processed from the given source

successful

integer

count of successful imported users

failed

integer

count of failed imported users

skipped

integer

count of existing user records, which was skipped during import

updated_at

string (date-time)

A time in ISO-8601 format

created_at

string (date-time)

A time in ISO-8601 format

details

array<object>

user_id

string

status

string

message

string

created_at

string (date-time)

A time in ISO-8601 format

created_at

string (date-time)

A time in ISO-8601 format

updated_at

string (date-time)

A time in ISO-8601 format

count

integer

last

string

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/user/group/assign

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

Response

Raw Output

Assign user to groups

POST

https://authn.aws.us.pangea.cloud/v2/user/group/assign

Add a list of groups to a specified user

required parameters

id

string

An ID for a user

id

group_ids

array<string>

minItems: 1
maxItems: 32

Click 'Save' to use the value

Response Fields

Response Schema

object

Pangea standard response schema

result

object

An empty 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/user/group/remove

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

Response

Raw Output

Unassign user group

POST

https://authn.aws.us.pangea.cloud/v2/user/group/remove

required parameters

id

string

An ID for a user

id

group_id

string

An ID for a group

Response Fields

Response Schema

object

Pangea standard response schema

result

object

An empty 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/user/group/list

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

Response

Raw Output

List groups for user

POST

https://authn.aws.us.pangea.cloud/v2/user/group/list

Return a list of ids for groups assigned to a user

required parameters

id

string

An ID for a user

id

optional parameters

last

string

Reflected value from a previous response to obtain the next page of results.

last

size

integer

Maximum results to include in the response.

minimum: 1

size

Response Fields

Response Schema

object

Pangea standard response schema

result

object

groups

array<object>

List of matching groups

id

string

An ID for a group

name

string

type

string

description

string

attributes

object

A collection of key/value pairs

created_at

string (date-time)

A time in ISO-8601 format

updated_at

string (date-time)

A time in ISO-8601 format

count

integer

last

string

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

Base URL

Get current user | Client token

string

optional parameters

string

Response Fields

object

object

object

string

string

string

integer

string (date-time)

boolean

string

string

array<string>

object

string

string (date-time)

object

boolean

boolean

array,null<string>

string

object

object

string

string

string

integer

string (date-time)

boolean

string

string

array<string>

object

string

string (date-time)

object

boolean

boolean

array,null<string>

string

object

string

string

string

string

string

Change password | Client token

string

string

string

Response Fields

object

object

string

string

string

string

string

Delete user authenticator

string

string

Response Fields

object

object

string

string

string

string

string

List user authenticators

string

Response Fields

object

object

array<object>