API_ProvisionUser
Don't forget to check out our JSON RESTful APIs, they can help you utilize and extend Quickbase with ease.
Overview
Use API_ProvisionUser to add a user who is not yet registered with Quickbase to your application. You invoke an application-level dbid for a user that is not yet registered with Quickbase, but whose email is known to you. This call:
starts a new user registration in Quickbase using the supplied email, fname (first name), and lname (last name).
gives application access to the user by adding the user to the specified role.
Note that, to assign roles to users, you must have either of these permissions on the application:
Basic Access with Sharing -- If you have Basic Access with Sharing permissions, you can assign roles with all permissions except Full Administration.
Full Administration -- If you have Full Administration permissions, you can assign roles with all permissions.
After you invoke this call, you’ll need to invoke API_SendInvitation to invite the new user via email. When the user clicks on the email invitation, the user is prompted to complete the brief registration. (At this time, the user can change the first and last name you assigned.)
If a user already is registered with Quickbase, the API will return an error. With registered users, you should use API_GetUserInfo, API_AddUserToRole, and API_SendInvitation.
Request parameters
| Parameter | Value | Required? |
|---|---|---|
The email address of the person to whom you are granting access. | yes | |
roleid | The role ID of the role you want to assign this user to. You can find this information by invoking API_GetRoleInfo. If you don’t supply a roleid, the role will be set to none. | no |
fname | The first name of the new Quickbase user. | yes |
lname | The last name of the new Quickbase user. | yes |
ticket | A valid authentication ticket. The authentication ticket is returned via the API_Authenticate call. | yes, one of:
|
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:
|
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 by Quickbase but it will be returned in the response. | no |
Response values
| Element Name | Value |
|---|---|
action | The originating request, for example, API_ProvisionUser. |
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. |
userid | The userid for the new user returned by Quickbase. |
udata | Optional. Contains any udata value supplied in the request. |
Sample XML Request
POST https://target_domain/db/target_dbid
HTTP/1.0
Content-Type: application/xml
Content-Length:
QUICKBASE-ACTION: API_ProvisionUser
<qdbapi>
<ticket>auth_ticket</ticket>
<apptoken>app_token</apptoken>
<roleid>11</roleid>
<email>sanskor@sbcglobal.com</email>
<fname>Margi</fname>
<lname>Rita</lname>
</qdbapi>
URL alternative
https://target_domain/db/target_dbid?a=API_ProvisionUser&email=DukeOHazard@sbcglobal.net&roleid=11&fname=Muggsy&lname=Bogues&ticket=auth_ticket&apptoken=app_token
where target_domain is the domain against which you are invoking this call, for example, quickbase.com. Read about this notation.
Sample response
<?xml version="1.0" ?><qdbapi> <action>api_provisionuser</action> <errcode>0</errcode> <errtext>No error</errtext> <userid>112248.5nzg</userid></qdbapi>
