Skip to navigation
API ReferenceMembers

UpdateMember

UpdateMember changes another member’s role (update_mask role). The member’s sign-in carries the old role until it next refreshes, up to an hour. Nobody changes their own role.

Authentication

AuthorizationBearer

A team API key, sent as Authorization: Bearer <key>.

OR
AuthorizationBearer

The Cognito access token of a signed-in Edulead user (edulead auth login), sent as Authorization: Bearer <token>.

Path parameters

idstringRequired1-128 characters
Identifier of the resource, assigned by Edulead and opaque to callers.

Headers

Edulead-TeamstringRequired

Query parameters

update_maskstringOptional
Which fields of the resource to change. Fields not listed keep their values.

Request

This endpoint expects an object.
idstringOptional<=128 characters
Identifier of the resource, assigned by Edulead and opaque to callers.
emailstringOptional<=1024 characters
given_namestringOptional<=1024 characters
Empty when the user gave none.
family_namestringOptional<=1024 characters
Empty when the user gave none.
roleenumOptional

MEMBER when the user has none recorded; MEMBER or OWNER on update. enum.defined_only = true

Allowed values:
grantslist of stringsOptional

Permissions granted to this user beyond the role, in the order ListPermissions lists them; usually empty. Read only.

enabledbooleanOptional
False once the user is disabled and can no longer sign in.
create_timedatetimeOptional
When Edulead created the resource.
update_timedatetimeOptional
When any field last changed.

Response

Success
memberobjectOptional
Member is one user of the team.