Progress will discontinue Telerik Platform on May 10th, 2018. Learn more

Linking or Unlinking AD FS Users

Linking or Unlinking AD FS Users

You can link an AD FS user account to a Telerik Platform user account, allowing the user to log in with either. You can unlink the AD FS user account at any time, keeping the Telerik Platform user management functionality.

See the coverage in Introduction to Active Directory Federation Services Integration for more details.

You need the AD FS access token for the user to perform linking. The way you obtain the token depends on whether you are implementing active federation or passive federation.

Linking with an AD FS Account

You link an AD user account to an existing Telerik Platform user account by making a POST request to the link endpoint of the built-in Users content type. The request should be authorized by a Telerik Platform bearer token valid for the specific user or by your MasterKey.

In the payload, set the base64-encoded SAML security token that you obtained earlier and set the provider name to ADFS.

Request:
    POST https://api.everlive.com/v1/your-app-id/Users/item-id/link
Headers:
    Content-Type: application/json
    Authorization:  Bearer your-access-token
Payload - raw:
    {
        "Provider": "ADFS",
        "Token": "your-Base64-encoded-SAML-token"
    }
Response:
    Status: 200 OK
    Content-Type: application/json
    Body: {}
var user = {
    "Provider": "ADFS",
    "Token": "your-Base64-encoded-SAML-token"
};
$.ajax({
    type: "POST",
    url: 'https://api.everlive.com/v1/your-app-id/Users/item-id/link',
    headers: {"Authorization" : "Bearer your-access-token"},
    contentType: "application/json",
    data: JSON.stringify(user),
    success: function(data){
        alert(JSON.stringify(data));
    },
    error: function(error){
        alert(JSON.stringify(error));
    }
});

These are important points you need to know about linking:

  • The user who you are linking must be logged in to their Telerik Platform account (in other words, you need the Telerik Platform access token to perform linking).
  • Users who have linked their AD identity to their Telerik Platform account can log in using either of them.
  • The AD user profile is stored as an object in the user account's Identity.ADFS field. It is visible only when using MasterKey authentication or when using Bearer authentication but the access token is issued for the same user.
  • If the Telerik Platform user account's Email is empty and the AD user profile contains an email, then it is stored in the user account's Email field.
  • You cannot link a single AD account to multiple Telerik Platform user accounts. If you try this, you receive an error.

Unlinking from an AD FS Account

You unlink an AD user account from an existing Telerik Platform user account by making a POST request to the unlink endpoint of the built-in Users content type. The request should be authorized by a Telerik Platform bearer token valid for the specific user or by your MasterKey. In the payload, set the Provider to ADFS.

Request:
    POST https://api.everlive.com/v1/your-app-id/Users/item-id/unlink
Headers:
    Content-Type: application/json
    Authorization:  Bearer your-access-token
Payload - raw:
    { "Provider": "ADFS" }
Response:
    Status: 200 OK
    Content-Type: application/json
    Body: {}
var user = {
    "Provider": "ADFS"
};
$.ajax({
    type: "POST",
    url: 'https://api.everlive.com/v1/your-app-id/Users/item-id/unlink',
    headers: {"Authorization" : "Bearer your-access-token"},
    contentType: "application/json",
    data: JSON.stringify(user),
    success: function(data){
        alert(JSON.stringify(data));
    },
    error: function(error){
        alert(JSON.stringify(error));
    }
});

These are important points you need to know about unlinking:

  • The user who you are unlinking must be logged in to their Telerik Platform account (in other words, you need the Telerik Platform access token to perform unlinking).
  • Telerik Platform deletes the user's AD profile by setting Profile.ADFS to null in the user account object.
  • After a user has been unlinked you can relink them.
  • The users can unlink only their own AD account. They cannot unlink other users' AD accounts, even if they have update permissions for the Users content type. This restriction is not present when using MasterKey authentication.
  • You can only unlink user accounts that existed before linking them to an AD account.

See Also

Contact us: +1-888-365-2779
sales@telerik.com
Copyright © 2016-2017, Progress Software Corporation and/or its subsidiaries or affiliates. All rights reserved.