Skip to main content

AuthN Invite API Reference

Run In Postman

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

Response

Invite User

POST
https://authn.aws.us.pangea.cloud/v2/user/invite

Send an invitation to a user.

required parameters

string

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

string

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

string (http-url)

A login callback URI

string

State tracking string for login callbacks

object

Pangea standard response schema

object

A pending user invitation

string

A one-time ticket

string

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

string
string

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

string (http-url)

A login callback URI

string

State tracking string for login callbacks

boolean

Require the user to authenticate with MFA

string (date-time)

A time in ISO-8601 format

string (date-time)

A time in ISO-8601 format

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

Response

Delete Invite

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

Delete a user invitation.

required parameters

string

A one-time ticket

object

Pangea standard response schema

object

An empty object

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

Response

List Invites

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

Look up active invites for the userpool.

fields

object
string

Only records where callback equals this value.

array<string>

Only records where callback includes each substring.

array<string>

Only records where callback equals one of the provided substrings.

string (date-time)

Only records where created_at equals this value.

string (date-time)

Only records where created_at is greater than this value.

string (date-time)

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

string (date-time)

Only records where created_at is less than this value.

string (date-time)

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

string

Only records where email equals this value.

array<string>

Only records where email includes each substring.

array<string>

Only records where email equals one of the provided substrings.

string (date-time)

Only records where expire equals this value.

string (date-time)

Only records where expire is greater than this value.

string (date-time)

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

string (date-time)

Only records where expire is less than this value.

string (date-time)

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

string

Only records where id equals this value.

array<string>

Only records where id includes each substring.

array<string>

Only records where id equals one of the provided substrings.

string

Only records where invite_org equals this value.

array<string>

Only records where invite_org includes each substring.

array<string>

Only records where invite_org equals one of the provided substrings.

string

Only records where inviter equals this value.

array<string>

Only records where inviter includes each substring.

array<string>

Only records where inviter equals one of the provided substrings.

boolean

Only records where is_signup equals this value.

boolean

Only records where require_mfa equals this value.

string

Only records where state equals this value.

array<string>

Only records where state includes each substring.

array<string>

Only records where state equals one of the provided substrings.

string

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

string

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

string

Which field to order results by.

integer

Maximum results to include in the response.

  • minimum: 1
object

Pangea standard response schema

object
array<object>

A list of pending user invitations

string

A one-time ticket

string

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

string
string

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

string (http-url)

A login callback URI

string

State tracking string for login callbacks

boolean

Require the user to authenticate with MFA

string (date-time)

A time in ISO-8601 format

string (date-time)

A time in ISO-8601 format

integer
string
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"
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"
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"
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"
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