47
API_RemoveUserFromRole
•
Overview
•
Request parameters
•
Response values
•
Sample XML Request
•
URL alternative
•
Sample response
Overview
Use API_RemoveUserFromRole to remove a user from a specified role. You invoke this call on an
application-level dbid. If the user has no other role, this call eliminates the user from the application’s role list.
You’ll need to get the user ID by calling API_GetUserInfo if you want to assign the user to another role in the
future.
This call can be used to remove the user entirely from any role in the application, effectively turning off access
to that user. If you intend to turn off all access, you would need to call API_GetUserRole Info to see what
roles the user has, then invoke API_RemoveUserFromRole on each role.
If you expect to add that user to another role in the future, you should consider using API_ChangeUserRole,
which can be used to turn off access (with a role set to None) while keeping the user on the application’s role
list for future reinstatement or role change.
If you are simply changing the user from one role to another, you should use API_ChangeUserRole.
Request parameters
PARAMETER
VALUE
REQUIRED?
userid
The ID of user you want removed from the role.
yes
roleid
The ID of the role from which you want the user removed.
yes
ticket
A valid authentication ticket.
The authentication ticket is returned via the
API_Authenticate call.
yes
apptoken
A valid application token.
yes, if the application
requires application tokens
udata
A string value that you want returned. It will not be handled no
Page 203
