View a Custom Provider

Endpoint URL: /config/low/services/engage-v2 /apps/{appId}/custom-providers /{providerId}



Description

Returns detailed information about the specified custom provider. Because custom providers don’t always appear in the Social Login Dashboard, using the /custom-providers/{providerId} endpoint and the GET method is the only guaranteed way to retrieve information about a speccific custom provider.


URL Parameters

URL parameters that must be included in the request are listed 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:

appId

Unique identifier of your Social Login application. You can return the IDs of all your Social Login applications by using the GET method and the /engage-v2/apps endpoint.

providerId

Unique identifier of the social login provider. IDs are assigned to a provider when provider is created.

No body parameters are required when calling the GET method.


HTTP Headers

This endpoint optionally allows the use of the following HTTP header:

Parameter

Description

If-None-Match

Used along with the Etag property to help you determine whether you are working with the most-recent version of the provider. See this article for more information.


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 access 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 get back 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 detailed information for the custom provider with the ID d284e861-d7f9-426e-93b0-56e01cf6d0ea:

curl -L -X GET \
  'https://v1.api.us.janrain.com/3cc14467-fd4f-437d-a0c0-0b3888dd2ee4/v2/config/low/services/engage-v2/apps/fifbclhccfpjdeoejkag/custom-providers/d284e861-d7f9-426e-93b0-56e01cf6d0ea \
  -H 'Authorization: Bearer lCV4idO6TEGHfUYCAqvBKekYWYnGEB7xqDPgOZfwKrhSSWD6B787TpOaGEzxKEAc'


Responses

200 OK

If your API call succeeds, you’ll get back detailed information for the specified provider. The following sample response is for a provider that uses the Security Assertion Markup Language (SAML) protocol:

{
    "_links": {
        "collection": {
            "href": "https://v1.api.us.janrain.com/3cc14467-fd4f-437d-a0c0-0b3888dd2ee4/v2/config/low/services/engage-v2/apps/fifbclhccfpjdeoejkag/custom-providers"
        },
        "self": {
            "href": "https://v1.api.us.janrain.com/3cc14467-fd4f-437d-a0c0-0b3888dd2ee4/v2/config/low/services/engage-v2/apps/fifbclhccfpjdeoejkag/custom-providers/d284e861-d7f9-426e-93b0-56e01cf6d0ea"
        }
    },
    "attribute_map": {
        "/username": "/email"
    },
    "auth_url": "https://dev-71752379.akamai.com/app/dev-71752379_gmssamlii_1/exkbvhhwptsUneoXg5d6/sso/saml",
    "createdAt": "2021-03-15T22:49:49.274441975Z",
    "id": "d284e861-d7f9-426e-93b0-56e01cf6d0ea",
    "idp_certificate": "MIIDqDCCApCgAwIBAgIGAXg390gvMA0GCSqGSIb3DQEBCwUAMIGUMQswCQYDVQQGEwJVUzETMBEGA1UECAwKQ2FsaWZvcm5pYTEWMBQGA1UEBwwNU2FuIEZyYW5jaXNjbzENMAs ==",
    "protocol": "saml2",
    "title": "Akamai SAML",
    "ui": {
        "title": "Akamai SAML",
        "icon_url": "https://dyzz9obi78pm5.cloudfront.net/app/image/id/5b749261ec161c506163b298/n/mixi-logo.svg"
    },
    "updatedAt": "2021-03-16T18:12:48.992622624Z"
}


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

400

The request was invalid. Typically occurs because your URL is incorrect. Verify each section of the URL and then try again.

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, application ID, or provider ID. Verify that those values are correct and then try again.