Skip to content

Assign

POST
/v1/admin/principal-assignments
curl --request POST \
--url https://example.com/v1/admin/principal-assignments \
--header 'Content-Type: application/json' \
--data '{ "tenant_id": "default", "proposal_id": "example", "subject_key": "example", "principal_type": "human", "group_path": "example", "reason_code": "manual", "source": "admin", "effective_from": "2026-04-15T12:00:00Z", "attributes": {} }'
x-pomerium-jwt-assertion
Any of:
string
Media typeapplication/json
PrincipalAssignmentIn
object
tenant_id
Tenant Id
string
default: default
proposal_id
required
Proposal Id
string
>= 1 characters
subject_key
required
Subject Key
string
principal_type
Principal Type
string
default: human
group_path
required
Group Path
string
reason_code
Reason Code
string
default: manual
source
Source
string
default: admin
effective_from
Effective From
string format: date-time
attributes
Attributes
object
key
additional properties
any

Successful Response

Media typeapplication/json
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
{
"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"
}

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