Don't forget to check out our JSON RESTful APIs, they can help you utilize and extend Quickbase with ease.
Overview
Use API_RemoveGroupFromRole to remove a group from a role in an app. You can also indicate if you want to remove a group from all roles in an application.
Request parameters
|
Parameter |
Value |
Required? |
|---|---|---|
|
gid |
The id of the group to manage. |
yes |
|
roleid |
The ID of the access role being assigned to the group. |
yes |
|
apptoken |
A valid application token. |
yes, if the application requires application tokens |
|
allRoles |
Set to TRUE if the group is to be removed from all roles in the app. Default is FALSE. |
no |
|
ticket |
A valid authentication ticket. The authentication ticket is returned via the API_Authenticate call. |
yes, one of: ticketusername/passworduser token |
|
usertoken |
The user token is an alternative means of authentication, used for API access. User tokens cannot be used to access the Quickbase UI. |
yes, one of: ticketusername/passworduser token |
|
udata |
A string value that you want returned. It will not be handled by Quickbase but it will be returned in the response. |
no |
Response values
|
Element Name |
Value |
|---|---|
|
action |
The originating request, for example, API_RemoveGroupFromRole. |
|
errcode |
Identifies the error code, if any. (See the Error Codes appendix for a list of possible error codes.) 0 indicates that no error was encountered. |
|
errtext |
Text that explains the error code. "No error" indicates that no error was encountered. |
|
udata |
Optional. Contains any udata value supplied in the request. |
Sample XML Request
POST https://target_domain/db/target_dbid HTTP/1.1
Content-Type: application/xml
Content-Length:
QUICKBASE-ACTION: API_RemoveGroupFromRole
<qdbapi>
<udata>misc data</udata>
<ticket>auth_ticket</ticket>
<gid>345889.klsd</gid>
<roleid>12</roleid>
<allRoles>true</allRoles>
</qdbapi>
Sample HTTP Get Request
https://target_domain/db/target_dbid?a=API_RemoveGroupFromRole&gid=345889.klsd
&roleid=12&allRoles=true&ticket=auth_ticket&udata=misc%20data
<?xml version="1.0" ?>
<qdbapi>
<action>API_RemoveGroupFromRole</action>
<errcode>0</errcode>
<errtext>No error</errtext>
<udata>misc data</udata>
</qdbapi>