CreatePathwayAssignmentRequest

A request or response body; the type column links to the schemas it refers to.

Field	Type	Required	Description
assignee_kind	string	yes	role: holders of role_id. department: everyone with a role grant in department_id or any department nested beneath it. organization: every member. one of "role" \| "department" \| "organization"
role_id	string (uuid)	no	Required for role assignments; must be a role of the pathway's organization.
department_id	string (uuid)	no	Required for department assignments; forbidden for organization ones.

Field

Type

Required

Description

assignee_kind

string

yes

role: holders of role_id. department: everyone with a role grant in department_id or any department nested beneath it. organization: every member.

one of "role" | "department" | "organization"

role_id

string (uuid)

Required for role assignments; must be a role of the pathway's organization.

department_id

string (uuid)

Required for department assignments; forbidden for organization ones.

jsonExample

{
  "assignee_kind": "role",
  "role_id": "1b671a64-40d5-491e-99b0-da01ff1f3341",
  "department_id": "1b671a64-40d5-491e-99b0-da01ff1f3341"
}