AuthN Session API Reference

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

Raw Output

Invalidate Session | Client

POST

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

Invalidate a session by session ID using a client token.

required parameters

token

string

A user token value

session_id

string

An ID for a token

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

Raw Output

List sessions (client token)

POST

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

List sessions using a client token.

required parameters

token

string

A user token value

optional parameters

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).

active_token_id

string

Only records where active_token_id equals this value.

active_token_id

active_token_id__contains

array<string>

Only records where active_token_id includes each substring.

active_token_id__contains

active_token_id__in

array<string>

Only records where active_token_id equals one of the provided substrings.

active_token_id__in

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

email

string

Only records where email equals this value.

email

email__contains

array<string>

Only records where email includes each substring.

email__contains

email__in

array<string>

Only records where email equals one of the provided substrings.

email__in

username

string

Only records where username equals this value.

username

username__contains

array<string>

Only records where username includes each substring.

username__contains

username__in

array<string>

Only records where username equals one of the provided substrings.

username__in

enabled

boolean

Only records where enabled equals this value.

enabled

expire

string (date-time)

Only records where expire equals this value.

expire

expire__gt

string (date-time)

Only records where expire is greater than this value.

expire__gt

expire__gte

string (date-time)

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

expire__gte

expire__lt

string (date-time)

Only records where expire is less than this value.

expire__lt

expire__lte

string (date-time)

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

expire__lte

id

string

Only records where id equals this value.

id

id__contains

array<string>

Only records where id includes each substring.

id__contains

id__in

array<string>

Only records where id equals one of the provided substrings.

id__in

identity

string

Only records where identity equals this value.

identity

identity__contains

array<string>

Only records where identity includes each substring.

identity__contains

identity__in

array<string>

Only records where identity equals one of the provided substrings.

identity__in

scopes

array<string>

A list of tags that all must be present.

scopes

type

string

Only records where type equals this value.

type

type__contains

array<string>

Only records where type includes each substring.

type__contains

type__in

array<string>

Only records where type equals one of the provided substrings.

type__in

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

sessions

array<object>

A list of sessions

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

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

active_token

object

A token and its information

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

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

Raw Output

Log out (client token)

POST

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

Log out the current user's session.

required parameters

token

string

A user token 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/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

Raw Output

Refresh a Session

POST

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

Refresh a session token.

required parameters

refresh_token

string

A refresh token value

optional parameters

user_token

string

A user token value

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

Raw Output

Invalidate Session

POST

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

Invalidate a session by session ID.

required parameters

session_id

string

An ID for a token

optional parameters

user_initiated

boolean

user_initiated

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

Raw Output

Log out (service token)

POST

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

Invalidate all sessions belonging to a user.

required parameters

user_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/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

Raw Output

List session (service token)

POST

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

List sessions.

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).

active_token_id

string

Only records where active_token_id equals this value.

active_token_id

active_token_id__contains

array<string>

Only records where active_token_id includes each substring.

active_token_id__contains

active_token_id__in

array<string>

Only records where active_token_id equals one of the provided substrings.

active_token_id__in

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

email

string

Only records where email equals this value.

email

email__contains

array<string>

Only records where email includes each substring.

email__contains

email__in

array<string>

Only records where email equals one of the provided substrings.

email__in

username

string

Only records where username equals this value.

username

username__contains

array<string>

Only records where username includes each substring.

username__contains

username__in

array<string>

Only records where username equals one of the provided substrings.

username__in

enabled

boolean

Only records where enabled equals this value.

enabled

expire

string (date-time)

Only records where expire equals this value.

expire

expire__gt

string (date-time)

Only records where expire is greater than this value.

expire__gt

expire__gte

string (date-time)

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

expire__gte

expire__lt

string (date-time)

Only records where expire is less than this value.

expire__lt

expire__lte

string (date-time)

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

expire__lte

id

string

Only records where id equals this value.

id

id__contains

array<string>

Only records where id includes each substring.

id__contains

id__in

array<string>

Only records where id equals one of the provided substrings.

id__in

identity

string

Only records where identity equals this value.

identity

identity__contains

array<string>

Only records where identity includes each substring.

identity__contains

identity__in

array<string>

Only records where identity equals one of the provided substrings.

identity__in

scopes

array<string>

A list of tags that all must be present.

scopes

type

string

Only records where type equals this value.

type

type__contains

array<string>

Only records where type includes each substring.

type__contains

type__in

array<string>

Only records where type equals one of the provided substrings.

type__in

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

sessions

array<object>

A list of sessions

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

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

active_token

object

A token and its information

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

last

string

count

integer

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