Create a partner
Registers one of your customers as a partner and fixes, up front, everything its future credentials will be allowed to reach: permissions says WHAT it may do in each product (collections × verbs) and scope says WHERE (which organization, which ledgers). The two are combined with AND at every request, so a partner reaches only the intersection.
This is the FIRST call in the flow. Nothing is issued here — no credential, no secret. Once the partner exists you create M2M applications against it with POST /v1/applications { "partnerId": "<the id returned here>" }, one per product, and hand the resulting clientId/clientSecret to the customer. A partner with no application is inert.
On success a new record is created in YOUR organization (resolved from your token — there is no tenant field to send) with a server-generated UUID id, state active, and the permissions, scope, validity window and IP allowlist you supplied. Nothing in any product changes: the scope values are recorded, never verified against the product and never created there.
Failures:
400 IDE-1042— a scopefieldis not one the product’s published scope catalog declares.GET /v1/scope-catalog/{product}lists the accepted dimensions; the message names the offending field.400 IDE-0001(scope) — the product’s catalog marks a dimensionrequiredand the scope has no line for it.400 IDE-0002(scope) — several values on a dimension the catalog does not markmulti.400 IDE-1043— a permission asks for a resource, an action, or a resource/action pair that no ONE enabled permission bound to your organization’s<product>-editor-roleholds, or that role holds nothing in the product. That is the ceiling; you cannot delegate more than you hold. Each permission of the role counts on its own: a pair is allowed only when one permission holds both its resource and its action, so a verb held for one resource is never borrowed by another. The message names the offending resource, action or pair; drop it from the line, or have it granted to the editor role first.400 IDE-1054— a permission names a product that is not ready for partners yet: it has not published a scope catalog, so a partner could not be narrowed to any of its instances. The message names the offendingpermissions[i].product; remove that line.400 IDE-1055— a permission names a product that has a scope catalog but has not opted in to partners (its manifest does not declarepartners: true;GET /v1/scope-catalog/{product}showspartners: false). Nothing in your request can change that: remove the line, or wait for the product to publish the opt-in.errors[0].locationisbody.permissions[i].product.400 IDE-1056— a permission grants a write (post,put,patch,delete) that the product performs at a level wider than the partner’s scope: a partner confined to one ledger cannot be granted creating ledgers, which acts on the whole organization. The product’s levels are inGET /v1/scope-catalog/{product}(levels). Remove that action, or scope the partner at the level the write needs.errors[0].locationisbody.permissions[i]; nothing is written.400 IDE-1052— any other refusal of the identity provider; the message repeats its code and sentence.400 IDE-1044— a product appears inscopebut not inpermissions, which would authorize nothing.400 IDE-1045—validUntilis not later thanvalidFrom.400 IDE-1047—"*"was used inpermissions.resourcesorpermissions.actions. A wildcard means allow-all and is refused; list the values.400 IDE-1048—ipAllowlistis an empty array. Omit it or send null to inherit the organization’s list.400 IDE-0036/400 IDE-1050— anipAllowlistentry has an unparseablecidr, or the same network appears twice.409 IDE-1040—displayNameis already used by another partner of yours.403— your token does not hold thepartnersresource.503 IDE-0066— the identity provider is unavailable (unreachable, too slow to answer, or failing). Nothing about the request was wrong; retry it later.
Body
The partner to create.
RFC 3339 instant after which the partner's credentials stop being honoured (the authorize call answers authorized=false with reason "expired", which the calling product turns into 401). Absent means "no end date". Must be later than validFrom, else IDE-1045.
"2027-01-01T00:00:00Z"
Response
Created

