Set user permissions

Description

Sets user permissions on a whiteboard.

If a user exits a room or goes offline, the user permissions will be cleared. When the user enters the room again, the user permissions need to be set again.
If the room to which a user belongs is destructed, the user permissions will be cleared.

Request method and endpoint

Request method: GET
Request endpoint: https://whiteboard-api.zego.im/?Action=SetWhiteboardUserAuth
Protocol: HTTPS
Rate limit: 50 requests/second (test environment: 1 request/second)

Request parameters

Listed below are the parameters specific to this request. For the complete list of public request parameters,see Accessing Server APIs - Public parameters.

Parameter	Type	Required	Description
RoomId	String	Yes	Room ID.
UserId	String	Yes	User ID.
ModuleAuth[]	Array of Number	Yes	Operation permissions on whiteboards. The value cannot be an empty array. 0: no permission 1: zooming 2: scrolling Example: ModuleAuth[]=1&ModuleAuth[]=2
GraphicAuth[]	Array of Number	Yes	Operation permissions on diagram elements. The value cannot be an empty array. 0: no permission 2: modifying diagram elements created by other users 4: erasing diagram elements created by other users 8: moving diagram elements created by other users 16: deleting all diagram elements 32: creating diagram elements Example: GraphicAuth[]=32&GraphicAuth[]=2

Sample request

Set the following user permissions:

Zoom in or out on, scroll, and turn pages on the whiteboard.
Create diagram elements and modify diagram elements created by others.

https://whiteboard-api.zego.im/?Action=SetWhiteboardUserAuth
&RoomId=RoomName
&UserId=jack
&ModuleAuth[]=1&ModuleAuth[]=2
&GraphicAuth[]=32&GraphicAuth[]=2
&<Public request parameters>

https://whiteboard-api.zego.im/?Action=SetWhiteboardUserAuth
&RoomId=RoomName
&UserId=jack
&ModuleAuth[]=1&ModuleAuth[]=2
&GraphicAuth[]=32&GraphicAuth[]=2
&<Public request parameters>

Response parameters

Parameter	Type	Description
Code	Number	Return code.
Message	String	Message.
RequestId	String	Unique request ID generated by ZEGO.

Sample response

{
    "Code":0,
    "Message":"SUCCESS",
    "RequestId":"2237080460466033406"
}

{
    "Code":0,
    "Message":"SUCCESS",
    "RequestId":"2237080460466033406"
}

Return codes

Listed below are the return codes related to this API. For the complete list of return codes, see Return codes.

Return code	Description
120000001	Signature authentication failed.
120000002	Incorrect input parameters.
120000101	Failed to set user permissions.
120000105	An empty array is entered for operation permissions.
120000106	Invalid values are set for the operation permissions.
120000201	The user does not exist.