Follow

Delete Social Provider by User Name

Table of Contents
  1. 1. Overview
  2. 2. Arguments
      1. 2.1.1. Example
    1. 2.2. Results
      1. 2.2.1. SUCCESS
      2. 2.2.2. FAILURE
  3. 3. Related

Overview

The Delete Social Providers by User Name command deletes the Social Provider for a specific Social Network user.  

Arguments

The Delete Social Providers by User Name command requires the following arguments: Command, Realm, Password, Social Provider, and User Name.

api_web?r=myrealm&p=mypass&c=deletesocialproviderbyusername&provider=facebook&username=myemail@mydomain.com

The command is ‘deletesocialproviderbyusername’, the realm is ‘myrealm’ and the password is ‘mypass’, and the provider is 'facebook'.

The Delete Social Provider by User Name command supports the following arguments:

 

Name

Req?

Description

Argument

Command

Yes

Defines the command to use.

cmd= deletesocialproviderbyusername

c= deletesocialproviderbyusername

Realm

Yes

Name of the realm to run the command.  This is required, and the command will fail if the realm and password do not match.

realm=[realm_name]

r=[realm_name]

Password

Yes

Authentication code for API access.  This is required, and the command will fail if the realm and password do not match.

pwd=[password]

p=[password]

Social Provider Yes Name for the Social Provider in the realm.  Current provider strings include: facebook, twitter, linkedin provider=[social_provider_name]
User Name Yes Identifier of the Social Network user. username=[username]

 

Example

Using all commands and arguments (please note the command is wrapped for display purposes only):

api_web?r=myrealm&p=mypass&c=deletesocialproviderbyusername&provider=facebook&username=myemail@mydomain.com

Successful results return:

SUCCESS

Results

The Delete Social Provider by User Name command outputs either a simple SUCCESS or a FAILURE message. 

SUCCESS

The Delete Social Provider by User Name command success message returns a simple string.  The result format is:

SUCCESS

FAILURE

A Delete Social Provider by User Name command will fail for several reasons, such as if no Social Providers exist in the realm.  The result format is:

FAILURE: [Reason]  

Was this article helpful?
0 out of 0 found this helpful
Have more questions? Submit a request

Comments

Powered by Zendesk