Skip to content
FractalOps

List Assignments

GET
/v1/admin/principal-assignments
curl --request GET \
  --url 'https://example.com/v1/admin/principal-assignments?tenant_id=&subject_key=&active_only=true'

Parameters

Section titled “Parameters”

Query Parameters

Section titled “Query Parameters”
tenant_id
Tenant Id
string
""
subject_key
Subject Key
string
""
active_only
Active Only
boolean
default: true

Header Parameters

Section titled “Header Parameters”
x-pomerium-jwt-assertion
Any of:
string

Responses

Section titled “Responses”

200

Section titled “200”

Successful Response

Media typeapplication/json
PrincipalAssignmentListOut
object
items
Items
Array<object>
PrincipalAssignmentOut
object
id
required
Id
string
tenant_id
required
Tenant Id
string
subject_key
required
Subject Key
string
principal_type
required
Principal Type
string
group_path
required
Group Path
string
reason_code
required
Reason Code
string
source
required
Source
string
effective_from
required
Effective From
string
effective_to
Any of:
string
attributes
Attributes
object
key
additional properties
any
created_by
required
Created By
string
updated_by
required
Updated By
string
created_at
required
Created At
string
updated_at
required
Updated At
string
Examplegenerated
{
  "items": [
    {
      "id": "example",
      "tenant_id": "example",
      "subject_key": "example",
      "principal_type": "example",
      "group_path": "example",
      "reason_code": "example",
      "source": "example",
      "effective_from": "example",
      "effective_to": "example",
      "attributes": {},
      "created_by": "example",
      "updated_by": "example",
      "created_at": "example",
      "updated_at": "example"
    }
  ]
}

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": {}
    }
  ]
}