Skip to main content

AuthN Session API Reference

Run In Postman

Base URL

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

Response

Invalidate session | Client token

POST
https://authn.aws.us.pangea.cloud/v2/client/session/invalidate

Invalidate a session by session ID using a client token.

required parameters

string

A user token value

string

An ID for a token

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

Response

List sessions | Client token

POST
https://authn.aws.us.pangea.cloud/v2/client/session/list

List sessions using a client token.

required parameters

string

A user token value

object
string

Only records where metadata field equals this value.

array<string>

Only records where metadata field contains one of these substrings.

boolean

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

string

Only records where active_token_id equals this value.

array<string>

Only records where active_token_id includes each substring.

array<string>

Only records where active_token_id 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

Only records where username equals this value.

array<string>

Only records where username includes each substring.

array<string>

Only records where username equals one of the provided substrings.

boolean

Only records where enabled equals this value.

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 identity equals this value.

array<string>

Only records where identity includes each substring.

array<string>

Only records where identity equals one of the provided substrings.

array<string>

A list of tags that all must be present.

string

Only records where type equals this value.

array<string>

Only records where type includes each substring.

array<string>

Only records where type 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 sessions

string

An ID for a token

string

A token type

integer

A positive time duration in seconds

  • exclusiveMinimum: 0
string (date-time)

A time in ISO-8601 format

string

The identity of a user or a service

string
array<string>

A list of scopes

object

A user profile as a collection of string properties

string
string (date-time)

A time in ISO-8601 format

object

A token and its information

string

An ID for a token

string

A token type

integer

A positive time duration in seconds

  • exclusiveMinimum: 0
string (date-time)

A time in ISO-8601 format

boolean
string

The identity of a user or a service

string
array<string>

A list of scopes

object

A user profile as a collection of string properties

string
string (date-time)

A time in ISO-8601 format

object

Intelligence Add-on Data

boolean
boolean
array,null<string>
string

An ID for a service account

object

claim object in the token

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.

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

Response

Log out | Client token

POST
https://authn.aws.us.pangea.cloud/v2/client/session/logout

Log out the current user's session.

required parameters

string

A user token value

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

Response

Refresh session | Client token

POST
https://authn.aws.us.pangea.cloud/v2/client/session/refresh

Refresh a session token.

required parameters

string

A refresh token value

string

A user token value

object

Pangea standard response schema

object

Credentials for a login session

object
string

A token value

string

An ID for a token

string

A token type

integer

A positive time duration in seconds

  • exclusiveMinimum: 0
string (date-time)

A time in ISO-8601 format

boolean
string

The identity of a user or a service

string
array<string>

A list of scopes

object

A user profile as a collection of string properties

string
string (date-time)

A time in ISO-8601 format

object

Intelligence Add-on Data

boolean
boolean
array,null<string>
string

An ID for a service account

object

claim object in the token

object
string

A token value

string

An ID for a token

string

A token type

integer

A positive time duration in seconds

  • exclusiveMinimum: 0
string (date-time)

A time in ISO-8601 format

boolean
string

The identity of a user or a service

string
array<string>

A list of scopes

object

A user profile as a collection of string properties

string
string (date-time)

A time in ISO-8601 format

object

Intelligence Add-on Data

boolean
boolean
array,null<string>
string

An ID for a service account

object

claim object in the token

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

Response

Invalidate session

POST
https://authn.aws.us.pangea.cloud/v2/session/invalidate

Invalidate a session by session ID.

required parameters

string

An ID for a token

boolean

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

Response

Log out session

POST
https://authn.aws.us.pangea.cloud/v2/session/logout

Invalidate all sessions belonging to a user.

required parameters

string

The identity of a user or a service

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

Response

List sessions

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

List sessions.

fields

object
string

Only records where metadata field equals this value.

array<string>

Only records where metadata field contains one of these substrings.

boolean

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

string

Only records where active_token_id equals this value.

array<string>

Only records where active_token_id includes each substring.

array<string>

Only records where active_token_id 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

Only records where username equals this value.

array<string>

Only records where username includes each substring.

array<string>

Only records where username equals one of the provided substrings.

boolean

Only records where enabled equals this value.

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 identity equals this value.

array<string>

Only records where identity includes each substring.

array<string>

Only records where identity equals one of the provided substrings.

array<string>

A list of tags that all must be present.

string

Only records where type equals this value.

array<string>

Only records where type includes each substring.

array<string>

Only records where type 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 sessions

string

An ID for a token

string

A token type

integer

A positive time duration in seconds

  • exclusiveMinimum: 0
string (date-time)

A time in ISO-8601 format

string

The identity of a user or a service

string
array<string>

A list of scopes

object

A user profile as a collection of string properties

string
string (date-time)

A time in ISO-8601 format

object

A token and its information

string

An ID for a token

string

A token type

integer

A positive time duration in seconds

  • exclusiveMinimum: 0
string (date-time)

A time in ISO-8601 format

boolean
string

The identity of a user or a service

string
array<string>

A list of scopes

object

A user profile as a collection of string properties

string
string (date-time)

A time in ISO-8601 format

object

Intelligence Add-on Data

boolean
boolean
array,null<string>
string

An ID for a service account

object

claim object in the token

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