Skip to content

Apply Lifecycle

POST
/v1/admin/principal-assignments/lifecycle/apply
curl --request POST \
--url https://example.com/v1/admin/principal-assignments/lifecycle/apply \
--header 'Content-Type: application/json' \
--data '{ "tenant_id": "default", "proposal_id": "example", "subject_key": "example", "principal_type": "human", "target_group_paths": [ "example" ], "reason_code": "lifecycle_apply", "source": "hr-event", "attributes": {} }'
x-pomerium-jwt-assertion
Any of:
string
Media typeapplication/json
PrincipalLifecycleApplyIn
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
target_group_paths
Target Group Paths
Array<string>
reason_code
Reason Code
string
default: lifecycle_apply
source
Source
string
default: hr-event
attributes
Attributes
object
key
additional properties
any

Successful Response

Media typeapplication/json
PrincipalLifecycleApplyOut
object
created_count
Created Count
integer
0
revoked_count
Revoked Count
integer
0
unchanged_count
Unchanged Count
integer
0
created_paths
Created Paths
Array<string>
revoked_paths
Revoked Paths
Array<string>
Example
{
"created_count": 0,
"revoked_count": 0,
"unchanged_count": 0
}

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