get_portal_groups

Read named portal group buckets (e.g. saved searches, content groups, shared content groups).

get_portal_groups

Read named portal group buckets (e.g. saved searches, content groups, shared content groups).

Safety class: C · API type: portal · Min version: —

📘
Confinement
Class C: read-only aggregate of the caller's portal buckets. Non-prod only.

Signatures

def get_portal_groups(sdk, portal_groups):
    """Read the named portal group buckets; return the result object or None."""
    return sdk.get_portal_groups(portal_groups)

export async function getPortalGroups(sdk, portalGroups) {
    // Read the named portal group buckets.
    return await sdk.getPortalGroups(portalGroups);
}

Parameters

Parameter (Python)	Parameter (JS)	Type	Required	Notes
`sdk`	`sdk`	Nomad_SDK	yes
`portal_groups`	`portalGroups`	list[str]	yes	bucket names to return

Returns

dict | None — an object keyed by the requested bucket names; None on failure.

Errors

401 unauthenticated
InvalidAPITypeException (admin session)