Follow

Delete Social Provider by ID

 

The Delete Social Providers by ID command deletes the Social Provider with a specified ID.  

Arguments

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

api_web?r=myrealm&p=mypass&c=deletesocialproviderbyid&social_provider_id=89

The command is ‘deletesocialproviderbyid’, the realm is ‘myrealm’ and the password is ‘mypass’, and the provider is id '89'.

The Delete Social Provider by ID command supports the following arguments:

 

Name

Req?

Description

Argument

Command

Yes

Defines the command to use.

cmd= deletesocialproviderbyid

c= deletesocialproviderbyid

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 Identifier for the Social Provider to delete from the realm. social_provider_id=[social_provider_id]

 

Example

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

api_web?r=myrealm&p=mypass&c=deletesocialproviderbyid&social_provider_id=89

Successful results return:

SUCCESS

Results

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

SUCCESS

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

SUCCESS

FAILURE

A Delete Social Provider by ID 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