Sign in
User / team / organization / usage

Changed on

Update Member Role

Updates the role of a member within the organization to admin or member.

  • admin: Grants the member admin privileges within the organization
  • member: Revokes admin privileges, setting the member as a regular user
patch/api/v2/organizations/{uid_organization}/members/{username}/

Request

  • The document declares no server URL.
  • Auth: one of:
    • HTTP basic
    • API key in header Authorization

Path parameters

uid_organizationstring required

UID of the organization

usernamestring required

Username of the user

Request body

role'admin' | 'member'
  • admin - admin
  • member - member

Response

role'admin' | 'member' | 'owner' required
  • admin - admin
  • member - member
  • owner - owner
urlstring uri nullable required
userstring uri nullable required
user__usernamestring nullable required
user__emailstring email nullable required
user__extra_details__namestring nullable required
user__has_mfa_enabledboolean nullable required
user__has_sso_enabledboolean nullable required
date_joinedstring date-time nullable required
user__is_activeboolean nullable required

Example response

{
  "url": "https://kf.kobotoolbox.org/api/v2/organizations/orgR6zUBwMHop2mgGygtFd6c/members/bob/",
  "user": "https://kf.kobotoolbox.org/api/v2/users/bob/",
  "invite": {
    "url": "https://kf.kobotoolbox.org/api/v2/organizations/orgR6zUBwMHop2mgGygtFd6c/invites/f3ba00b2-372b-4283-9d57-adbe7d5b1bf1/",
    "invited_by": "https://kf.kobotoolbox.org/api/v2/users/bob/"
  }
}

Changes

  • v2574be331e7acRevision changes
    • breaking

      the response property became nullable for the status

    • breaking

      the response property became nullable for the status

    • breaking

      the response property became nullable for the status

    • breaking

      the response property became nullable for the status

    • breaking

      the response property became nullable for the status

    • breaking

      the response property became nullable for the status

    • breaking

      the response property became nullable for the status

    • breaking

      the response property became nullable for the status

    • breaking

      the response property became nullable for the status

    • breaking

      added subschema #1 subschema #2 to the response property oneOf list for the response status

    • breaking

      the response's property type changed from string to no type for status

    • info

      removed the admin enum value from the response property for the response status

    • info

      removed the member enum value from the response property for the response status

    • info

      removed the owner enum value from the response property for the response status

  • v26180ad712df3Revision changes
    • breaking

      the response's property type changed from no type to string for status

    • warning

      added the new admin enum value to the response property for the response status

    • warning

      added the new member enum value to the response property for the response status

    • warning

      added the new owner enum value to the response property for the response status

    • info

      removed subschema #1 subschema #2 from the response property oneOf list for the response status