AuthZ API Reference

Base URL

authz.<csp>.<region>.pangea.cloud

• OpenAPI Specification

post/v1/tuple/create

cURL

Code Snippet Language

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

Response

Raw Output

200

Code Snippet Language

---

Write tuples.

POST

https://authz.aws.us.pangea.cloud/v1/tuple/create

Write tuples. The request will fail if tuples do not validate against the schema defined resource types.

required parameters

tuples

array<object>

tuples

tuples

resource

object

type

string

type

type

id

string

id

id

relation

string

relation

relation

subject

object

type

string

type

type

id

string

id

id

action

string

action

action

Response Fields

Response Schema

object

Pangea standard response schema

result

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/v1/tuple/list

cURL

Code Snippet Language

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

Response

Raw Output

200

Code Snippet Language

---

Get tuples.

POST

https://authz.aws.us.pangea.cloud/v1/tuple/list

Return a paginated list of filtered tuples. The filter is given in terms of a tuple. Fill out the fields that you want to filter. If the filter is empty it will return all the tuples.

fields

filter

object

resource_type

string

Only records where resource type equals this value.

resource_type

resource_type

resource_type__contains

array<string>

Only records where resource type includes each substring.

resource_type__contains

resource_type__contains

resource_type__in

array<string>

Only records where resource type equals one of the provided substrings.

resource_type__in

resource_type__in

resource_id

string

Only records where resource id equals this value.

resource_id

resource_id

resource_id__contains

array<string>

Only records where resource id includes each substring.

resource_id__contains

resource_id__contains

resource_id__in

array<string>

Only records where resource id equals one of the provided substrings.

resource_id__in

resource_id__in

relation

string

Only records where relation equals this value.

relation

relation

relation__contains

array<string>

Only records where relation includes each substring.

relation__contains

relation__contains

relation__in

array<string>

Only records where relation equals one of the provided substrings.

relation__in

relation__in

subject_type

string

Only records where subject type equals this value.

subject_type

subject_type

subject_type__contains

array<string>

Only records where subject type includes each substring.

subject_type__contains

subject_type__contains

subject_type__in

array<string>

Only records where subject type equals one of the provided substrings.

subject_type__in

subject_type__in

subject_id

string

Only records where subject id equals this value.

subject_id

subject_id

subject_id__contains

array<string>

Only records where subject id includes each substring.

subject_id__contains

subject_id__contains

subject_id__in

array<string>

Only records where subject id equals one of the provided substrings.

subject_id__in

subject_id__in

subject_action

string

Only records where subject action equals this value.

subject_action

subject_action

subject_action__contains

array<string>

Only records where subject action includes each substring.

subject_action__contains

subject_action__contains

subject_action__in

array<string>

Only records where subject action equals one of the provided substrings.

subject_action__in

subject_action__in

last

string

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

last

last

order

string

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

order

​

order

order_by

string

Which field to order results by.

order_by

​

order_by

size

integer

Maximum results to include in the response.

• minimum: 1

size

size

Response Fields

Response Schema

object

Pangea standard response schema

result

object

tuples

array<object>

resource

object

type

string

id

string

relation

string

subject

object

type

string

id

string

action

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/v1/tuple/delete

cURL

Code Snippet Language

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

Response

Raw Output

200

Code Snippet Language

---

Delete tuples

POST

https://authz.aws.us.pangea.cloud/v1/tuple/delete

Delete tuples.

required parameters

tuples

array<object>

tuples

tuples

resource

object

type

string

type

type

id

string

id

id

relation

string

relation

relation

subject

object

type

string

type

type

id

string

id

id

action

string

action

action

Response Fields

Response Schema

object

Pangea standard response schema

result

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

cURL

Code Snippet Language

curl -sSLX POST 'https://authz.aws.us.pangea.cloud/v1/check' \
-H 'Authorization: Bearer <your_token>' \
-H 'Content-Type: application/json' \
-d '{}'

Response

Raw Output

200

Code Snippet Language

---

Perform a check request

POST

https://authz.aws.us.pangea.cloud/v1/check

Check if a subject has permission to do action on the resource.

required parameters

resource

object

type

string

type

type

action

string

action

action

subject

object

type

string

type

type

id

string

id

id

optional parameters

resource

object

id

string

id

id

subject

object

action

string

action

action

debug

boolean

In the event of an allowed check, return a path that granted access.

debug

​

debug

attributes

object

A JSON object of attribute data.

attributes

attributes

Response Fields

Response Schema

object

Pangea standard response schema

result

object

schema_id

string

schema_version

integer

allowed

boolean

depth

integer

debug

object

path

array<object>

type

string

id

string

action

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/v1/check/bulk

cURL

Code Snippet Language

curl -sSLX POST 'https://authz.aws.us.pangea.cloud/v1/check/bulk' \
-H 'Authorization: Bearer <your_token>' \
-H 'Content-Type: application/json' \
-d '{}'

Response

Raw Output

200

Code Snippet Language

---

Perform a bulk check request

POST

https://authz.aws.us.pangea.cloud/v1/check/bulk

Perform multiple checks in a single request to see if a subjects have permission to do actions on the resources.

required parameters

checks

array<object>

Check requests to perform, for example:

[
  {
    "resource": {
      "type": "file",
      "id": "1"
    },
    "action": "read",
    "subject": {
      "type": "user",
      "id": "1"
    }
  }
]

• minItems: 1

• maxItems: 100

​

resource

object

type

string

type

type

id

string

id

id

action

string

action

action

subject

object

type

string

type

type

id

string

id

id

action

string

action

action

optional parameters

debug

boolean

In the event of an allowed check, return a path that granted access.

debug

​

debug

attributes

object

A JSON object of attribute data.

attributes

attributes

Response Fields

Response Schema

object

Pangea standard response schema

result

object

schema_id

string

schema_version

integer

allowed

boolean

results

array<object>

checked

string

allowed

boolean

depth

integer

debug

object

path

array<object>

type

string

id

string

action

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/v1/list-resources

cURL

Code Snippet Language

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

Response

Raw Output

200

Code Snippet Language

---

List resources

POST

https://authz.aws.us.pangea.cloud/v1/list-resources

Given a type, action, and subject, list all the resources in the namespace that the subject has access to the action with.

required parameters

type

string

type

type

action

string

action

action

subject

object

type

string

type

type

id

string

id

id

optional parameters

subject

object

action

string

action

action

attributes

object

A JSON object of attribute data.

attributes

attributes

Response Fields

Response Schema

object

Pangea standard response schema

result

object

ids

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/v1/list-subjects

cURL

Code Snippet Language

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

Response

Raw Output

200

Code Snippet Language

---

List subjects

POST

https://authz.aws.us.pangea.cloud/v1/list-subjects

Given a resource and an action, return the list of subjects who have access to the action for the given resource.

required parameters

resource

object

type

string

type

type

id

string

id

id

action

string

action

action

optional parameters

attributes

object

A JSON object of attribute data.

attributes

attributes

debug

boolean

Return a path for each found subject.

debug

​

debug

Response Fields

Response Schema

object

Pangea standard response schema

result

object

subjects

array<object>

type

string

id

string

debug

object

path

array<object>

type

string

id

string

action

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.

Status Codes

Status	Status Code	Description
ReBACError	400	Error in ReBAC library

Was this article helpful?

Contact us