This is the object representing a base form template settings for an authorization form. The properties of these templates contain settings like what to do after a form is submitted, who we should email notifications to, etc.
/api/v2/templates
List or search your templates
/api/v2/templates/123
Get a specific template
Attribute | Format | Description | Example |
---|---|---|---|
uid |
UID String | Unique identifier of the Template. These uids may look like integers, but they are not guaranteed to stay that way, so you should treat them as strings. | "1234567-0" |
created |
ISO8601 | When the Template was created. | "2016-01-01T12:30:24.653422+00:00" |
updated |
ISO8601 | When the Template was last updated. | "2016-01-01T12:30:24.653422+00:00" |
user_email |
String | User who created the Template. | "sales@acmesolar.com" |
user_uid |
UID String | Unique identifier for the user who created the Template. | "12345-6" |
disabled |
Boolean | Whether the Template is disabled from being loaded or submitted. | false |
portal |
String | The customizable string at the end of the base_url. | "acme_solar" |
base_url |
URL |
A link to a blank verison of the authorization form.
Authorizations
submitted on this form will have "form_uid": null . See
URL Parameters
for additional options.
|
"https://utilityapi.com/authorize/acme_solar" |
redirect_uris |
List(URL) | Whitelist of locations to redirect the user after authorization is complete. If no redirect_uri parameter is included in an authorization form, the form will automatically redirect to the first url in this list. See Redirect Parameters for expected parameters in the redirect. | ["https://acmesolar.com", ...] |
company_logo |
URL | Link to the authorization form logo. | "https://utilityapi.com/abc123.png" |
company_name |
String | The displayed company name on authorization forms. | "Acme Solar, Inc." |
company_email |
String | A contact email for the company. | "sales@acmesolar.com" |
// Basic Template { "uid": "12345", "created": "2016-01-01T12:30:24.653422+00:00", "updated": "2016-01-01T12:30:24.653422+00:00", "user_email": "sales@acmesolar.com", "user_uid": "1111", "disabled": false, "portal": "acme_solar", "base_url": "https://utilityapi.com/authorize/acme_solar", "redirect_uris": [], "company_logo": "https://utilityapi.com/static/logo.png", "company_name": "Acme Solar, Inc.", "company_email": "sales@acmesolar.com" }
// Template with two whitelisted redirects, one being a development redirect { "uid": "12345", "created": "2016-01-01T12:30:24.653422+00:00", "updated": "2016-01-02T10:22:02.847385+00:00", "user_email": "sales@acmesolar.com", "user_uid": "1111", "disabled": false, "portal": "acme_solar", "base_url": "https://utilityapi.com/authorize/acme_solar", "redirect_uris": [ "https://acmesolar.com/thanks?ref=1", "http://localhost:8888/test-redirect/" ], "company_logo": "https://utilityapi.com/uploads/dskfjfa9su0.png", "company_name": "Acme Solar, Inc.", "company_email": "sales@acmesolar.com" }