Skip to content
FractalOps

List Portal Groups

GET
/v1/portal/groups
curl --request GET \
  --url 'https://example.com/v1/portal/groups?query=&limit=20&tenant_id='

Parameters

Section titled “Parameters”

Query Parameters

Section titled “Query Parameters”
query
Query
string
""
limit
Limit
integer
default: 20 >= 1 <= 50
tenant_id
Tenant Id
string
""

Header Parameters

Section titled “Header Parameters”
X-FractalOps-Tenant-Id
Any of:
string
x-pomerium-jwt-assertion
Any of:
string

Responses

Section titled “Responses”

200

Section titled “200”

Successful Response

Media typeapplication/json
PortalGroupDirectoryListOut
object
query
Query
string
""
items
Items
Array<object>
PortalGroupDirectoryItemOut
object
group_path
Group Path
string
""
display_name
Display Name
string
""
group_kind
Group Kind
string
""
role_name
Role Name
string
""
Example
{
  "query": "",
  "items": [
    {
      "group_path": "",
      "display_name": "",
      "group_kind": "",
      "role_name": ""
    }
  ]
}

422

Section titled “422”

Validation Error

Media typeapplication/json
HTTPValidationError
object
detail
Detail
Array<object>
ValidationError
object
loc
required
Location
Array
msg
required
Message
string
type
required
Error Type
string
input
Input
ctx
Context
object
Examplegenerated
{
  "detail": [
    {
      "loc": [
        "example"
      ],
      "msg": "example",
      "type": "example",
      "input": "example",
      "ctx": {}
    }
  ]
}