Retrieve a product's scope catalog

Returns the dimensions one product lets a partner be scoped on, in tree order, with the rules each one carries: required, multi, and the collection its siblings live in. name is the value to send as field on a partner’s scope line; values are the product’s own identifiers (as its list APIs return them) and are not checked for existence.

Called by a partner editor that already knows which product it is scoping, and before a create or an update to know which lines the write will need.

Read-only and global: the same for every organization.

Failures:

• 404 IDE-1053 — the product has not published a scope catalog. None of its partners can be scoped until it does.
• 403 — your token does not hold the partners resource.
• 503 IDE-0066 — the identity provider is unavailable (unreachable, too slow to answer, or failing). Nothing about the request was wrong; retry it later.

GET /v1/scope-catalog/{product}

Retrieve a product's scope catalog

cURL

curl --request GET \
  --url https://identity.sandbox.lerian.net/v1/scope-catalog/{product} \
  --header 'Authorization: Bearer <token>'

200

{
  "dimensions": [
    {
      "collection": "organizations",
      "from": "path",
      "multi": false,
      "name": "organizationId",
      "param": "organization_id",
      "required": true,
      "covers": [
        "balances",
        "operations"
      ],
      "explicit": true,
      "label": "Midaz organization",
      "parent": "organizationId"
    }
  ],
  "partners": true,
  "product": "midaz",
  "integrations": [
    "midaz"
  ],
  "levels": [
    {
      "action": "update",
      "level": "organizationId",
      "resource": "ledgers"
    }
  ]
}

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

200

application/json

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.

Show child attributes

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"

integrations · string[] | null

Lerian services this product calls while serving a request (e.g. midaz). A partner granted this product reaches them through it, and each of them also applies the partner's own rules for that service when the partner has any. Absent when the product declares none.

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.

Show child attributes