Tenants
List all tenants within an omnibus structure
get/v1/domains/{domainId}/omnibus/{omnibusId}/tenants
Request
- Base URLhttps://docs.ripple.com (the document declares no server; this is the origin it was published from)
- Authnone declared
- TypeScriptA function with typed inputs. Its response is checked against the schema.
Path parameters
domainIdstring uuid required
omnibusIdstring uuid required
Query parameters
pageinteger
sizeinteger
searchstring
Case-insensitive substring match on tenant alias. Terms shorter than 3 characters return an empty page (the trigram index cannot serve them).
status'LOCKED' | 'UNLOCKED'
Filter tenants by status. Absent means no status filtering.
Response
OK
Changes
No recorded changes to this operation across all 3 revisions of this API.