Add a domain to a domains allow list
Appends domains to the social login allow list for an application. If configured, only the domains on the allow list are allowed to communicate with your social login application.
Accepted content types
- application/x-www-form-urlencoded
- multipart/form-data
Authentication
This operation uses your social login API key for authentication. This key can be found on the Settings page of the Social Login Dashboard. See Get started for more information.
Base URL
The base URL for this operation is your application domain followed by /api/v2; for example:
https://educationcenter.rpxnow.com/api/v2
You can find your application domain in the Social Login dashboard on the Settings page.
Example request
This command adds three domains (localhost, somewhere.com, and *.examples.com) to the domains allow list for the social login application 1234567891234567891234567891234567891234. When configured, only the domains on the allow list are allowed to communicate with your social login application. Among other things, that means you can only login or register from domains on the list.
curl -X POST \
--data-urlencode apiKey=1234567891234567891234567891234567891234 \
--data-urlencode domains='localhost, somewhere.com, *.examples.com' \
https://janrain-docs.rpxnow.com/api/v2/add_domain_patterns
Example response
If your API call succeeds the response consists of the status ok:
{
"stat": "ok"
}
Parameters
Parameters can be configured as x-www-form-urlencoded or as multipart/form-data body parameters.
Parameter | Type | Required | Description |
---|---|---|---|
apiKey | string | ✓ | Social login secret for authenticating the operation. To verify your API key, log in to Console and, on the Manage Application page, check the value of the rpx_key setting. This value also appears on the Settings page in the Social Login dashboard. |
domains | string | ✓ | Comma-separated list of the domains you're adding to the allow list. Note that this operation doesn't affect any domains already on the list. |
Updated over 1 year ago