|
UpdateRole |
Scroll |
REST URL (POST) https://tenant.thereforeonline.com/theservice/v0001/restun/UpdateRole
SOAP Action (POST) http://schemas.therefore.net/webservices/interop/v0001/messages/IThereforeService/UpdateRole
Updates Thereforeâ„¢ role used for permission management.
Input Message: http://schemas.therefore.net/webservices/interop/v0001/messages/IThereforeService/UpdateRole
Element Name |
Element Type |
Restrictions |
Description |
â– parameters |
|
|
|
â– RoleNo |
xs:int |
mandatory |
Set number of the role to update. |
â–¡ Name |
xs:string |
nillable |
Specify the role's name to update it. Omit the parameter or set it to null to retain the current name. Utilize the 'Accept-Language' HTTP header to update specific translation. |
â–¡ IsDenyRole |
xs:boolean |
nillable |
Specify the role's 'deny role' flag to update it. Omit the parameter or set it to null to retain the current value. |
â–¡ Description |
xs:string |
nillable |
Specify the role's description to update it. Omit the parameter or set it to null to retain the current description. Utilize the 'Accept-Language' HTTP header to update specific translation. |
â–¡ PermissionsMaskToAdd |
xs:unsignedLong |
nillable |
Specify the permissions mask to add permissions to the role. Omit the parameter or set it to null to retain the current permissions. Use role permission constants returned by the GetRolePermissionConstants web API call. The 'add' and 'remove' masks are applied in the following order: PermissionsMaskToAdd, PermissionsMaskToRemove. |
â–¡ PermissionsMaskToRemove |
xs:unsignedLong |
nillable |
Specify the permissions mask to remove permissions from the role. Omit the parameter or set it to null to retain the current permissions. Use role permission constants returned by the GetRolePermissionConstants web API call. The 'add' and 'remove' masks are applied in the following order: PermissionsMaskToAdd, PermissionsMaskToRemove. |
Output Message: http://schemas.therefore.net/webservices/interop/v0001/messages/IThereforeService/UpdateRoleResponse
Element Name |
Element Type |
Restrictions |
Description |
â– parameters |
|
|
|
â– RolePermissionsMask |
xs:unsignedLong |
|
Gets role permissions mask. |
Legend:
â– |
Not nillable element. |
â–¡ |
Nillable element. |
≡ |
List of elements. |
Bold |
Mandatory element. |
