- Getting Started
- RESTful API
- User Data
- iframe User Registration
Capture Dashboard Overview
Dashboard Home Page ¶
When you log in to the Capture website, you arrive at the Capture Dashboard, see Figure 1.
On this page you see a snapshot of the number of your applications, how many total records exist, and how many people are signed up.
At the top of the Dashboard, you can find links for Engage, Capture, and Developers. If you have Engage applications, you can access them from here.
Capture Application Page ¶
Hover your cursor over the Apps link in the navigation bar. A list of your Capture applications appears. Select the application you want. A screen similar to Figure 2 appears, except that you will be able to read the e-mail addresses. (Alternatively, you can click the Your Apps link, which takes you to a list of your applications where you can choose the one you want.)
From here, you can view the details for Records, API Clients, and People. (See Figure 3.)
Records Page ¶
In the Records section, click the view link.
This page shows you the Entity Type (entityType in the API) for the records, in this case user. Clicking the new record button takes you to a details page where you can create a new user. (It may be easier just to sign-in as a new user and create a new profile that way.)
The field (column) drop-down menu allows you to choose the data to use to sort the user list. Use this menu in conjunction with the operator drop-down menu and value field to search for users with particular characteristics. Click the Filter button when you are ready.
Hover your cursor over one of the records. A view link appears at the far right. Click the link. The Dashboard takes you to the detail page for the specific user, as shown in Figure 4.
Records Details Page
Here you can see many data fields about a given user, and you can edit the fields if necessary. This is the user schema.
Place you cursor on a detail line. If it can be edited, you will see the click to edit message in the highlight bar.
Click the Show History link to see when the user details were created or last edited. You can click on an item in the history list to see what changes were made at a given time.
Use the Delete Record button to delete the user. You get a chance to Confirm or Cancel the delete.
When you finish on this page, click the (back to) Records button at the top left.
API Clients Page ¶
From the Records page, you can either go back to the Capture Dashboard, or click the API Clients link. (If you go back to the main application page in Figure 2, you will need to click the API Clients manage link.) The API Clients page looks similar to Figure 5:
You must be the application owner to use this page. The Dashboard always acts as the owner and has permission to make any changes or delete objects.
Use this page to create a new version of your Capture workflow. For example, if you have more than one website, and you want your users to have a different experience, or to create different branding on your different sites. Be sure to read the OAuth 2.0 specification before you use this feature.
- Click the Create New Client button. A new row expands, where you can enter a name for the new client, and set the client’s permissions as to what the “client” can modify or not. In this case, the “client” is an application or new version of the Capture flow, rather than a person or user role. You can choose from image_create, direct_access, access_issuer, and direct_read_access.
- image_create — Permission to create or add images.
- direct_access — Read and Write permission. Also, permission to issue access tokens.
- access_issuer — Permission to issue access tokens. The direct_access permission allows this also, so only assign this permission if the client does not have the direct_access permission.
- direct_read_access — Read only permission. Assign this permission only if the client does not have the direct_access permission.
- When you finish, click the Generate ID & Secret button. The Janrain server generates a new client ID and client secret for you.
There are two sets of permissions for each API Client.
- The permissions you set on this page, which you can also set using the /clients/set_features API call.
- You can set read and write permission on every attribute using the /entityType.setAccessSchema API call.
After you create a new client, you can examine it and modify it in the Settings tab.
Settings Page ¶
Click the Settings tab. The Settings page appears, similar to Figure 6. This is where you can see and modify the details of your API Clients.
On the Settings page, you can see all of the clients for your Capture application. Enter the settings as key-value pairs, key on the left, value on the right. At the top, you can set default settings that every client will use, unless they specifically override that setting.