Skip to content
FractalOps

Apply Lifecycle Scenario

POST
/v1/admin/principal-assignments/lifecycle/scenario/apply
curl --request POST \
  --url https://example.com/v1/admin/principal-assignments/lifecycle/scenario/apply \
  --header 'Content-Type: application/json' \
  --data '{ "tenant_id": "default", "proposal_id": "example", "subject_key": "example", "principal_type": "human", "persona_key": "", "platform_role_keys": [ "example" ], "department_roles": [ { "scope_key": "example", "role_key": "member" } ], "team_roles": [ { "scope_key": "example", "role_key": "member" } ], "project_roles": [ { "scope_key": "example", "role_key": "member" } ], "solution_roles": [ { "scope_key": "example", "role_key": "member" } ], "initiative_roles": [ { "scope_key": "example", "role_key": "member" } ], "domain_roles": [ { "scope_key": "example", "role_key": "member" } ], "reason_code": "onboarding_scenario", "source": "fractalops_onboarding", "attributes": {} }'

Parameters

Section titled “Parameters”

Header Parameters

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

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
PrincipalLifecycleScenarioIn
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
persona_key
Persona Key
string
""
platform_role_keys
Platform Role Keys
Array<string>
department_roles
Department Roles
Array<object>
PrincipalScopeRoleIn
object
scope_key
required
Scope Key
string
role_key
Role Key
string
default: member
team_roles
Team Roles
Array<object>
PrincipalScopeRoleIn
object
scope_key
required
Scope Key
string
role_key
Role Key
string
default: member
project_roles
Project Roles
Array<object>
PrincipalScopeRoleIn
object
scope_key
required
Scope Key
string
role_key
Role Key
string
default: member
solution_roles
Solution Roles
Array<object>
PrincipalScopeRoleIn
object
scope_key
required
Scope Key
string
role_key
Role Key
string
default: member
initiative_roles
Initiative Roles
Array<object>
PrincipalScopeRoleIn
object
scope_key
required
Scope Key
string
role_key
Role Key
string
default: member
domain_roles
Domain Roles
Array<object>
PrincipalScopeRoleIn
object
scope_key
required
Scope Key
string
role_key
Role Key
string
default: member
reason_code
Reason Code
string
default: onboarding_scenario
source
Source
string
default: fractalops_onboarding
attributes
Attributes
object
key
additional properties
any

Responses

Section titled “Responses”

200

Section titled “200”

Successful Response

Media typeapplication/json
PrincipalLifecycleScenarioOut
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>
resolved_target_group_paths
Resolved Target Group Paths
Array<string>
Example
{
  "created_count": 0,
  "revoked_count": 0,
  "unchanged_count": 0
}

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