API_ProvisionUser

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

Note that, to assign roles to users, you must have either of these permissions on the application:

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.

top

Request parameters

Parameter Value Required?

email

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

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

top

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.

top

Sample XML Request 

POST https://<target_domain>/db/57pa5vjf HTTP/1.0
Content-Type: application/xml
Content-Length:
QUICKBASE-ACTION: API_ProvisionUser

<qdbapi>
   <ticket>2_bdh78chd4_dpsx_b_dnbypa8d372j5rb6vt6kfdx7ty25</ticket>
   <apptoken>dtmd897bfsw85bb6bneceb6wnze3</apptoken>
   <roleid>11</roleid>
   <email>sanskor@sbcglobal.com</email>
   <fname>Margi</fname>
   <lname>Rita</lname>
</qdbapi>

top

URL alternative

https://<target_domain>/db/bdb5rjd6h?act=API_ProvisionUser&email=
DukeOHazard@sbcglobal.net&roleid=11&fname=Muggsy&lname=Bogues&ticket=
<your_ticket>&apptoken=dtmd897bfsw85bb6bneceb6wnze3

where <target_domain> is the domain against which you are invoking this call, for example, intuit.quickbase.com.

top

Sample response

<?xml version="1.0" ?>
<qdbapi>
   <action>api_provisionuser</action>
   <errcode>0</errcode>
   <errtext>No error</errtext>
   <userid>112248.5nzg</userid>
</qdbapi>

top   

© 1999-2013 Intuit Inc. All rights reserved. Legal Notices.