Retrieve a partner
Returns one partner in full: its permissions, its scope, its validity window, its IP allowlist and how many applications are attached.
Called to open a partner’s detail screen, and before a PATCH — the update replaces permissions and scope wholesale rather than merging entry by entry, so an editor has to start from the current lists.
Read-only: nothing changes.
Failures:
404 IDE-1046— no such partner in your organization. An id that belongs to ANOTHER tenant answers exactly this, deliberately: telling the two apart would confirm another tenant’s records exist.422—idis not a UUID.403— your token does not hold thepartnersresource.503 IDE-0060— the identity provider is unavailable (unreachable, too slow to answer, or failing). Nothing about the request was wrong; retry it later.501 IDE-1051— this deployment publishes the contract but does not serve it yet.
Autorizações
JWT bearer token issued by the identity provider.
Parâmetros de caminho
Identifier of the partner, as returned by the create call.
"00000000-0000-0000-0000-000000000000"
Resposta
OK
How many M2M applications are currently attached to this partner. A non-zero value is what makes DELETE answer 409 (IDE-1049).
2
When the partner was created (RFC 3339).
"2026-01-15T09:30:00Z"
Human-readable name, unique within the organization.
"Loja do Zé"
Server-generated identifier of the partner (UUID). This is the value to pass as partnerId when creating an application, and the value that travels in the credential's partner claim.
"00000000-0000-0000-0000-000000000000"
The partner's own IP allowlist, or null when it inherits the organization's list. Null and an empty list are NOT the same thing here: null is inheritance, and an empty own list cannot be stored.
What the partner may do, per product.
Where the partner may do it, per product and dimension. An empty list means the partner is not restricted by instance in any product.
Whether the partner's credentials are honoured. Note this never reads "expired": expiry is derived from validUntil at decision time, so a closed window shows here as "active" with a past validUntil.
active, suspended "active"
When it was last modified (RFC 3339).
"2026-01-15T09:30:00Z"
Start of the validity window (RFC 3339), or null when it is open-ended.
"2026-01-01T00:00:00Z"
End of the validity window (RFC 3339), or null when it is open-ended. A past value means every credential of this partner is already refused.
"2027-01-01T00:00:00Z"

