send_password_reset
Email a learner a password reset link scoped to a specific training domain. Provide the learner ID and domain to generate a working reset link.
Instructions
Email a learner a password reset link. This contacts a real person.
`id` is the obfuscated Skilljar learner id. `domain` is REQUIRED and has no default: the reset link is scoped to
one of your
training domains, so sending it against the wrong one produces a link that does
not work. Use `list_domains` to find the right value.
Prefer this over `set_student_password` - it never puts you in possession of
someone's credentials.
Requires the `students:manage-password` OAuth scope AND the `people.destructive`
capability. Send it only on the user's explicit instruction.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| id | Yes | ||
| domain | Yes |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| id | Yes | ||
| note | Yes | ||
| sent | Yes | ||
| domain | Yes |