List Your Social Login Applications

Endpoint URL: /config/low/services/ engage-v2/apps



Description

Returns information about your Social Login applications. A social login application is required in order to add social login to Hosted Login and to create a Configurable Identity Provider (custom provider). If you aren’t sure whether or not you have a social login application, you can find out by logging on to Console, clicking Manage Application, and looking for the rpx_app_id setting:

In the preceding example, the social login application ID is cphbafmnnoahhedkjkmf. When working with custom providers, you’ll need to reference that application ID. 

Instead of using Console, you can return information about your social login application (or applications) by using the /config/low/services/engage-v2/apps endpoint. Admittedly, Console might be a little quicker and a little easier to use. However, there’s at least one advantage to employing the /engage-v2/apps endpoint instead: in a single operation, this endpoint returns information about all your social login applications. 

Note. Yes, organizations can have more than one social login application. When setting up social login for Hosted Login, you can use any of the applications associated with your customer ID.



Respects the API Client Allow List: No


URL Parameters

URL parameters that must be included in an /engage-v2/apps request are shown in the following table:

Parameter

Description

customerId

Unique identifier issued to Akamai customers. If you aren’t sure what your Akamai customer ID is, log on to Console and check the value of the customer_id application setting:

No body parameters are required when calling this endpoint.


Authentication

This endpoint requires token-based authentication. To obtain an access token, you must use a configuration client (employing the client ID as the username and the client secret as the password) to connect to the /{customerId}/login/token endpoint. The access token returned from the token endpoint is then used in the Authorization header of your API call. 

For example, if you’re issued the access token z7S4iEe7KBRG8vMBPWRtJD66VH9SGMAlA56ol-loCln5MZOtGjmcy6O1tSh5lE6t your Authorization header will look like this when using Curl:

-H 'Authorization: Bearer z7S4iEe7KBRG8vMBPWRtJD66VH9SGMAlA56ol-loCln5MZOtGjmcy6O1tSh5lE6t'

If you’re using  Postman, set the Authorization Type to Bearer and use the access token as the value of the Token field:

Note. When requesting an access token, make sure you set the token scope to *:**. Any other scope will result in a 403 Forbidden error when you attempt to use the token.


Sample Request (curl)

The following command returns information about the social login applications associated with customer ID 3cc14467-fd4f-437d-a0c0-0b3888dd2ee4:

curl -L -X GET \
  'https://v1.api.us.janrain.com/3cc14467-fd4f-437d-a0c0-0b3888dd2ee4/v2/config/low/services/engage-v2/apps' \
  -H 'Authorization: Bearer lCV4idO6TEGHfUYCAqvBKekYWYnGEB7xqDPgOZfwKrhSSWD6B787TpOaGEzxKEAc' 


Responses

200 OK

If your API call succeeds, you’ll get back information about all the Social Login applications associated with the specified customer ID. In the sample API response shown below, the only available Social Login application ID is listed in red:

 {
    "_embedded": {
        "item": [
            {
                "_links": {
                    "self": {
                        "href": "https://v1.api.us.janrain.com/3cc14467-fd4f-437d-a0c0-0b3888dd2ee4/v2/config/low/services/engage-v2/apps/fifbclhccfpjdeoejkag"
                    }
                },
                "appid": "fifbclhccfpjdeoejkag",
                "realm": "greg-stemp-2-c27kzd26tbhfgd9yv6axkvgjbc"
            }
        ]
    },
    "_links": {
        "item": {
            "href": "https://v1.api.us.janrain.com/3cc14467-fd4f-437d-a0c0-0b3888dd2ee4/v2/config/low/services/engage-v2/apps{/id}",
            "templated": true
        },
        "self": {
            "href": "https://v1.api.us.janrain.com/3cc14467-fd4f-437d-a0c0-0b3888dd2ee4/v2/config/low/services/engage-v2/apps"
        }
    },
    "total": 2
}


Error Response Codes

The following table includes information about some of the other response codes that you might encounter when calling this endpoint.

Response Code

Description

403

Forbidden. Access is denied. This typically occurs because your configuration access token has expired. Obtain a new access token and then try again.

404

The requested resource was not found. Typically occurs if your call specifies an invalid customer ID. Verify that the customer ID is correct and then try again.