Skip to main content
GET
Retrieve a product's scope catalog

Authorizations

Authorization
string
header
required

JWT bearer token issued by the identity provider.

Path Parameters

product
string
required

Product slug, as returned by GET /v1/applications/available.

Minimum string length: 1
Example:

"midaz"

Response

OK

dimensions
object[] | null
required

Dimensions in tree order: the first is the top of the funnel and every later one narrows inside the previous. A partner scope line's field must be one of these names.

partners
boolean
required

Whether the product accepts partner credentials. A partner can be granted the product only when true.

Example:

true

product
string
required

Product slug, as returned by GET /v1/applications/available.

Example:

"midaz"

levels
object[] | null

How wide one instance of each leveled resource is, per (resource, action). A partner is not granted a write on a resource wider than its scope. Absent when the product declares no level.