RESTful API

 

/api/v2/providers

Request Type
GET
 
A collection of identity providers configured for the application.
 
Example URL
https://example.stitchz.net/api/v2/providers
 
Request
Required Parameter Type Description
yes Bearer string The application's unique Oauth2 bearer token (access token) in the request header
  Format string The format of the authenticated Stitchz response, XML, JSON, JSONP. A query string parameter can be included in the request (e.g. ?format=json) or a header variable of "Accept" with the proper value, e.g. 'application/json', 'application/xml', etc. The default response is in "JSON" format.
  details boolean Send "true" (e.g. ?details=true) with the details parameter to get the full details of your application's provider list, including apikey, scope, etc. The default is "false".
Example Request
$ curl -H "Authorization: Bearer e72e16c7e42f292c6912e7710c838347ae178b4a"
-H "Accept: application/json"
-A "example client"
https://example.stitchz.net/api/v2/providers

GET /api/v2/providers HTTP/1.1
User-Agent: example client
Host: example.stitchz.net
Accept: application/json
Authorization: Bearer e72e16c7e42f292c6912e7710c838347ae178b4a
Response
Field Type Description
ApiKey string The unique Application key. This is an automatically assigned number that identifies the application.
Scope string Your Application's scope, tied directly to the plan chosen when creating your application.
AppId string Unique application id provided by the Identity Provider.
AppKey string The unique value provided by the Identity Provider and used to identify each login request with the Identity Provider; similar to a username. Also known as a Consumer Key.
AppSecret string A value generated by the Identity Provider and used to establish ownership of the Consumer Key. Treat the secret the same as a password. Also known as the Consumer Secret.
Name string The name of the Identity Provider
Scope string The permissions or attributes requested from the Identity Provider.
IsActive boolean Whether or not the provider has been enabled for your Application. Inactive providers will not show on the standard login page.
 
* all fields are always returned in the response.
 
Example XML Response
Example JSON Response
<providermodel>
    <apikey>000000000000</apikey>
    <scope>Professional</scope>
    <providers>
        <provider>
            <appid></appid>
            <appkey>000000000000000000</appkey>
            <appsecret>51b7d71b18c74928b6a4dfa33de5fef2</appsecret>
            <identityprovidername>Facebook</identityprovidername>
            <scope>email</scope>
            <isactive>true</isactive>
        </provider>
        <provider>
            <appid></appid>
            <appkey>falkfLKFJ0EJIOWfsjelksers4</appkey>
            <appsecret>efa4fbbe88c74ea6b140e49cc9a5d3ad</appsecret>
            <identityprovidername>Twitter</identityprovidername>
            <scope></scope>
            <isactive>true</isactive>
        </provider>
        <provider>
            <appid></appid>
            <appkey>000000000000000000-hkjhgiu875dghfg55fhgfmjhhlkjlk.apps.googleusercontent.com</appkey>
            <appsecret>kjlhliuhm987076rfdgf</appsecret>
            <identityprovidername>Google</identityprovidername>
            <scope>profile email</scope>
            <isactive>true</isactive>
        </provider>
    </providers>
</providermodel>
{
    "ApiKey":000000000000,
    "Scope":Professional,
    "Providers":
    [
        {
            "IdentityProviderName":"Facebook",
            "AppKey":"000000000000000000",
            "AppSecret":"51b7d71b18c74928b6a4dfa33de5fef2",
            "Scope":"email",
            "IsActive":true,
            "AppId":""
        },
        {
            "IdentityProviderName":"Twitter",
            "AppKey":"falkfLKFJ0EJIOWfsjelksers4",
            "AppSecret":"efa4fbbe88c74ea6b140e49cc9a5d3ad",
            "Scope":"",
            "IsActive":true,
            "AppId":""
        },
        {
            "IdentityProviderName":"Google",
            "AppKey":"000000000000000000-hkjhgiu875dghfg55fhgfmjhhlkjlk.apps.googleusercontent.com",
            "AppSecret":"kjlhliuhm987076rfdgf",
            "Scope":"profile email",
            "IsActive":true,
            "AppId":""
        }
    ]
}