---
updatedAt: 2026-04-20T19:21:40.000Z
---

# Modify the social login allow list

Modifies the domains on the social login allowlist. If the allowlist is configured, only the domains included on that list can communicate with your social login application.

# OpenAPI definition

```json
{
  "openapi": "3.0.0",
  "info": {
    "title": "Social",
    "version": "2.0.0"
  },
  "servers": [
    {
      "url": "https://{hostname}"
    }
  ],
  "paths": {
    "/api/v2/add_domain_patterns": {
      "post": {
        "operationId": "post-add-domain-patterns",
        "summary": "Modify the social login allow list",
        "description": "Modifies the domains on the social login allowlist. If the allowlist is configured, only the domains included on that list can communicate with your social login application.",
        "requestBody": {
          "content": {
            "application/x-www-form-urlencoded": {
              "schema": {
                "properties": {
                  "apiKey": {
                    "type": "string",
                    "description": "Social login API key. This key can be found on the Social Login Dashboard or by looking for the `rpx_key` application setting in Console.\n",
                    "example": "475y385u343okf"
                  },
                  "domains": {
                    "type": "string",
                    "description": "Comma-separated list of domains allowed to communicate with your social login application.\n"
                  }
                }
              }
            }
          }
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "example": {
                  "$ref": "#/paths/~1api~1v2~1map/post/responses/200/content/application~1json/example"
                },
                "schema": {
                  "type": "object",
                  "description": "Adds a domain to an application's social login whitelist. For security reasons, only domains on the whitelist are allowed to communicate with your Social Login application. That means that these are the only domains that can  host your registration UI.\n",
                  "properties": {
                    "stat": {
                      "type": "string",
                      "description": "Indicates the status of the current operation.\n",
                      "enum": [
                        "OK",
                        "ERROR",
                        "FAIL"
                      ]
                    }
                  }
                }
              }
            },
            "description": "Successful response\n"
          },
          "400": {
            "content": {
              "application/json": {
                "example": {
                  "$ref": "#/paths/~1api~1v2~1map/post/responses/400/content/application~1json/example"
                },
                "schema": {
                  "$ref": "#/paths/~1api~1v2~1map/post/responses/400/content/application~1json/schema"
                }
              }
            },
            "description": "Parameters are missing or invalid .\n"
          }
        }
      }
    },
    "/api/v2/map": {
      "post": {
        "operationId": "post-map",
        "summary": "Associate a primary key",
        "description": "Associates a primary key with a user's social identity.",
        "requestBody": {
          "content": {
            "application/x-www-form-urlencoded": {
              "schema": {
                "properties": {
                  "apiKey": {
                    "type": "string",
                    "description": "Social login API key. This key can be found on the Social Login Dashboard or by looking for the `rpx_key` application setting in Console.\n",
                    "example": "475y385u343okf"
                  },
                  "overwrite": {
                    "type": "boolean",
                    "description": "When `false`, mappings are created only if the specified identifier doesn't already have a mapping. The default value is `true`.\n"
                  },
                  "primaryKey": {
                    "type": "integer",
                    "description": "Primary key found in the user’s user profile.\n",
                    "example": 13
                  },
                  "identifier": {
                    "type": "string",
                    "description": "Identifier currently mapped to the `primaryKey`.\n",
                    "example": "apple"
                  }
                }
              }
            }
          }
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "example": {
                  "stat": "ok"
                },
                "schema": {
                  "type": "object",
                  "description": "Associates a primary key with a user's social identity provider.\n",
                  "properties": {
                    "stat": {
                      "type": "string",
                      "description": "Indicates the status of the current operation.\n",
                      "enum": [
                        "OK",
                        "ERROR",
                        "FAIL"
                      ]
                    }
                  }
                }
              }
            },
            "description": "Successful response\n"
          },
          "400": {
            "content": {
              "application/json": {
                "example": {
                  "stat": "fail",
                  "err": {
                    "code": 0,
                    "msg": "Missing parameter: apiKey"
                  }
                },
                "schema": {
                  "type": "object",
                  "description": "Indicates that an error occurred when calling a Social Login API endpoint.\n",
                  "required": [
                    "stat",
                    "code",
                    "msg"
                  ],
                  "properties": {
                    "stat": {
                      "type": "string",
                      "enum": [
                        "ok",
                        "error",
                        "fail"
                      ],
                      "description": "Indicates the status of the operation.\n"
                    },
                    "code": {
                      "type": "string",
                      "description": "Social login error code.\n"
                    },
                    "msg": {
                      "type": "string",
                      "description": "Information about the error and why it occurred.\n"
                    }
                  }
                }
              }
            },
            "description": "Missing or invalid parameters.\n"
          }
        }
      }
    }
  },
  "x-readme": {
    "samples-languages": [
      "curl",
      "python",
      "node"
    ],
    "explorer-enabled": true,
    "proxy-enabled": true
  },
  "externalDocs": {
    "url": "https://techdocs.akamai.com/identity-cloud-social-login/reference",
    "description": "See documention for Akamai's Identity Cloud: Social Login API\n"
  }
}
```