Follow

Get Social Provider by ID

 

The Get Social Providers by ID command returns the Social Providers for a specified ID.  

Arguments

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

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

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

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

 

Name

Req?

Description

Argument

Command

Yes

Defines the command to use.

cmd=getsocialproviderbyid

c=getsocialproviderbyid

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 in the realm. social_provider_id=[social_provider_id]
Output Format   To specify the format of the list output, use one of two arguments.  If no argument is included, the default output is space-delimited plain text string, which may not include all data columns.

csv=1 or

output_format=[csv,csv_tab, csv_pipe,xml]

Header   To define the data with a label, use the Header argument.  This can only be used in conjunction with the output format, and does not affect XML.

headers=[0,1]

DEFAULT==0

 

Example

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

api_web?r=myrealm&p=mypass&c=getsocialproviderbyid&social_provider_id=89&output_format=csv&headers=1

Successful results return:

"social_provider_id","provider","username"

"89","FACEBOOK","myemail@mydomain.com"

Results

The Get Social Provider by ID command outputs either the results of the search or a FAILURE message. 

SUCCESS

The Get Social Provider by ID command does not explicitly return a Success code.  Instead, it outputs the template id and name in plain text format.  Use the Output Format argument to return the results in an alternate format.

FAILURE

A Get 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