/admin/add

This call adds an administrator user to a Relying Party.

Note. Multiple user entities can be associated to the same email address. When you set verify to false, attempting to add an admin user with such an ambiguous email returns an error.

Accepted Content-types

  • application/x-www-form-urlencoded
  • multipart/form-data

This endpoint includes the following methods:

  • POST


POST

Authentication

This endpoint supports Basic authentication. 

How to Create an Authentication String

Base URL

The base URL for this endpoint is your application domain followed by /partner/v2; for example:

https://educationcenter.rpxnow.com/partner/v2

You can find your application domain in the Social Login (Engage Dashboard) on the Settings page:

Example Request


curl -X POST \
    --data-urlencode apiKey=1234567891234567891234567891234567891234\
    --data-urlencode partnerKey=9876543219876543219876543219876\
    --data-urlencode email=example@example.com \
   https://rpxnow.com/partner/v2/admin/add
   
      Running this command in Postman

Example Response


{
  "stat": "ok"
}
   

Query Parameters

Parameter Type Required Description
apiKey string Yes Social Login API key. This key can be found on the Janrain Dashboard.
 
email string Yes Email address of the administrator being added.
 
format string Data format for the command response. Allowed values are:
  • xml
  • json (the default value)
partnerKey string Yes Social Login partner key. This key can be found on the Janrain Dashboard.
 
verify string When set to true (the default value) a verification email is sent to the prospective administrator; the user must click the link in this email before he or she can access the website. If set to false, then user cannot be added as an administrator unless he or she is already an administrator with one or more of the partner relying parties.