Skip to main content

AuthN Groups API Reference

Run In Postman

Base URL

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

Response

Create user group

POST
https://authn.aws.us.pangea.cloud/v2/group/create

required parameters

string

A name for a group

string

string
object

A collection of key/value pairs

Click 'Save' to use the value

object

Pangea standard response schema

object

A group and its information

string

An ID for a group

string
string
string
object

A collection of key/value pairs

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

Response

Delete user group

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

required parameters

string

An ID for a group

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

Response

Get user group

POST
https://authn.aws.us.pangea.cloud/v2/group/get

Look up a group by ID and return its information.

required parameters

string

An ID for a group

object

Pangea standard response schema

object

A group and its information

string

An ID for a group

string
string
string
object

A collection of key/value pairs

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

Response

List user groups

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

Look up groups by name, type, or attributes.

fields

object
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 created_at includes this value.

string

Only records where id equals this value.

array<string>

Only records where id includes each substring.

Click 'Save' to use the value

array<string>

Only records where id equals one of the provided substrings.

Click 'Save' to use the value

string

Only records where name equals this value.

array<string>

Only records where name includes each substring.

Click 'Save' to use the value

array<string>

Only records where name equals one of the provided substrings.

Click 'Save' to use the value

string

Only records where type equals this value.

array<string>

Only records where type includes each substring.

Click 'Save' to use the value

array<string>

Only records where type equals one of the provided substrings.

Click 'Save' to use the value

string (date-time)

Only records where updated_at equals this value.

string (date-time)

Only records where updated_at is greater than this value.

string (date-time)

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

string (date-time)

Only records where updated_at is less than this value.

string (date-time)

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

string

Only records where updated_at includes this value.

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>

List of matching groups

string

An ID for a group

string
string
string
object

A collection of key/value pairs

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.

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

Response

List users assigned to a group

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

Return a list of ids for users assigned to a group

required parameters

string

An ID for a group

string

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

integer

Maximum results to include in the response.

  • minimum: 1

object

Pangea standard response schema

object
array<object>

A list of users and their information

string

The identity of a user or a service

string

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

string

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

string (phone-E164-format)

A phone number

object

A user profile as a collection of string properties

string
boolean

True if the user's email has been verified

boolean

True if the service administrator has disabled user account

boolean

True if the user account has been locked out

string

An ID for an agreement

string

An ID for an agreement

string (date-time)

A time in ISO-8601 format

string (date-time)

A time in ISO-8601 format

integer
string
string
string
array<object>

A list of authenticators

string

An ID for an authenticator

string

An authentication mechanism

string
string
string
boolean
string
string
string
string
string (date-time)

A time in ISO-8601 format

string (date-time)

A time in ISO-8601 format

array<string>
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.

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

Response

Update user group details

POST
https://authn.aws.us.pangea.cloud/v2/group/update

required parameters

string

An ID for a group

string

A name for a group

string
string
object

A collection of key/value pairs

Click 'Save' to use the value

object

Pangea standard response schema

object

A group and its information

string

An ID for a group

string
string
string
object

A collection of key/value pairs

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.

Was this article helpful?

Contact us