v1

latestOpenAPI 3.0.0Creative Commons Attribution 3.02026-07-1310484273.7 KB
userProfiles

Modifies a guardian invitation. Currently, the only valid modification is to change the state from PENDING to COMPLETE. This has the effect of withdrawing the invitation. This method returns the following error codes: * PERMISSION_DENIED if the current user does not have permission to manage guardians, if guardians are not enabled for the domain in question or for other access errors. * FAILED_PRECONDITION if the guardian link is not in the PENDING state. * INVALID_ARGUMENT if the format of the student ID provided cannot be recognized (it is not an email address, nor a user_id from this API), or if the passed GuardianInvitation has a state other than COMPLETE, or if it modifies fields other than state. * NOT_FOUND if the student ID provided is a valid student ID, but Classroom has no record of that student, or if the id field does not refer to a guardian invitation known to Classroom.

patch/v1/userProfiles/{studentId}/guardianInvitations/{invitationId}

Path parameters

studentIdstring required

The ID of the student whose guardian invitation is to be modified.

invitationIdstring required

The id field of the GuardianInvitation to be modified.

Query parameters

updateMaskstring

Mask that identifies which fields on the course to update. This field is required to do an update. The update fails if invalid fields are specified. The following fields are valid: * state When set in a query parameter, this field should be specified as updateMask=,,...

Request body

invitationIdstring

Unique identifier for this invitation. Read-only.

studentIdstring

ID of the student (in standard format)

state'GUARDIAN_INVITATION_STATE_UNSPECIFIED' | 'PENDING' | 'COMPLETE'

The state that this invitation is in.

invitedEmailAddressstring

Email address that the invitation was sent to. This field is only visible to domain administrators.

creationTimestring google-datetime

The time that this invitation was created. Read-only.

Response

Successful response