InstaLink()

This API call is used to create a link between a node and a known user identified by a unique email address.

API URL:

[BaseURL]/VerificationToken/urn:dece:type:token:DelegationTokenRequest:VerifiedEmail?responseType={responseType}&subject={subject}

Request Method:

POST

Request Parameters:

• responseType is the response type for the request (must be urn:dece:type:tokenprofile:saml2)
• subject is the verified email address of the User to link to

Request Format

XML type:

• saml2:AuthnRequest

Headers:

• Content-type: application/x-www-form-urlencoded

Request Body Arguments:

• SAMLRequest is the AuthnRequest including the verified email address in the NameID element. This argument must be base64 encoded

Response Format

Status Code:

• HTTP 201

Headers:

• Location: [BaseURL]/SecurityToken/Assertion/{AssertionID}

  A reference to the newly created SAML Assertion

Errors

• AuthnRequestNotValid
  • The provided AuthnRequest in the SAMLRequest body argument is incomplete or malformed
  • HTTP Status Code: 400
• SecurityTokenResponseTypeNotValid
  • responseType query argument was not urn:dece:type:tokenprofile:saml2
  • HTTP Status Code: 400
• InvalidXMLDocument
  • The provided AuthnRequest in the SAMLRequest body argument was not properly base64 endcoded
  • HTTP Status Code: 400
• EmailAddressMissingInAuthnRequest
  • Verified email address from the AuthnRequest NameID element was not found
  • HTTP Status Code: 400
• EmailAddressMismatch
  • Email address referenced in the AuthnRequest NameID element did not match the subject query argument
  • HTTP Status Code: 400
• UserIdentifierNotFound
  • Email address did not match any known Users
  • HTTP Status Code: 404
• UserIdentifierNotValid
  • Email address did not identify a unique user
  • HTTP Status Code: 400

Example

Instalink

The following example demonstrates linking a node to a known user identified by a unique email address

Sample Request:

POST /rest/2015/02/VerificationToken/urn:dece:type:token:DelegationTokenRequest:VerifiedEmail?responseType=urn:dece:type:tokenprofile:saml2&subject=verified-email@test.com
Content-type: application/x-www-form-urlencoded
Host: api.uvvu.com

SAMLRequest=dsafndksalfjdsafodsaifdnsa....==

Sample Response:

HTTP/1.1 201
Date: [Date]
Location: https://api.uvvu.com/rest/2015/02/SecurityToken/Assertion/_1914d5f8-5fce-4436-9dc1-803adea311d8
X-transaction-info: [TransactionInfo]

See Also

• EmailResponseLink()
• SecurityTokenExchangeCredentials()
• SecurityTokenURIRefAssertionID()
• SecurityTokenURIRefExchange()