Skip to main content

Switch Roles

If you've got enough permissions, it allows you to change the role of another user inside the organization. e.g. Turn a Member into an Admin.

Change user role

Provide the API with the email and the new role to get a member of your organization upgraded or downgraded.

curl -X 'POST' \
'https://api.gigapipe/v1/roles/switch' \
-H 'accept: application/json' \
-H 'Authorization: Bearer <your_access_token>' \
-H 'Content-Type: application/json' \
-d '{
"user_email": "martha@lamborgini.com",
"role_name": "Admin"
}'
  # Payload response ::Dictionary
{
"message": "User successfully changed from <Member> to <Admin>"
}

Payload

Attributes


user_email  ::String

The email of the user who you want to change the role


role_name  ::String

The name of the future role (Member/Admin/Owner)


Response

Attributes


message  ::String

A basic response message


Limitations

The target role should be a string in ["Member", "Admin", "Cluster"]