LEAF API Documentation
You are in: API » Release 1 » Issue Token

Issue passthrough authentication token POST

Obtains a token that can be used to log a user into the myLEAF website. This is required if you wish to redirect a user to a secure web page within myLEAF without requiring them to enter their username or password again.

Parameters

Response Parameters
ParameterNameTypeDescription
tokenTokenStringThe passthrough token to be supplied to the myLEAF login page

XML

Example Request
POST https://api.leaf.eco/r1/issuetoken.eb HTTP/1.1
Accept: text/xml
Response Schema
<?xml version="1.0" encoding="utf-8"?>
<xsd:schema elementFormDefault="qualified" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <xsd:element name="authorization">
    <xsd:complexType>
      <xsd:sequence>
        <xsd:element name="token" type="xsd:string">
          <xsd:annotation>
            <xsd:documentation>The passthrough token to be supplied to the myLEAF login page</xsd:documentation>
          </xsd:annotation>
        </xsd:element>
      </xsd:sequence>
    </xsd:complexType>
  </xsd:element>
</xsd:schema>
Example Response
HTTP/1.1 200 OK
Content-Type: text/xml

<?xml version="1.0" encoding="utf-8"?>
<authorization>
  <token>xsd:string</token>
</authorization>

JSON

Example Request
POST https://api.leaf.eco/r1/issuetoken.eb HTTP/1.1
Accept: application/json
Example Response
HTTP/1.1 200 OK
Content-Type: application/json

{"token":String}

Status Codes

Status and Error Codes
HTTP StatusError CodeDescription
200 

The token was generated successfully

403 

No authentication was provided with the request

403DataError:Authentication 

After calling this endpoint, build a redirect URL to the myLEAF login page using the token given in the response as the "token" querystring parameter.

If you want to redirect the user to a specific page on the website, include the optional "goto" parameter. This should contain the URL-encoded absolute path to the page, e.g. "/myleaf/profile/myaccount.eb"

Tokens obtained via this endpoint are valid for a maximum of ten minutes and may only be used once.