Using a REST API, you can register and approve a partner
user. With repeated calls to the API with different values, you can
register partner users in bulk.
Before you begin, you need REST or SOAP client software.
However, there is no requirement to use specific client software.
One example of REST client software that can be used is a REST plug-in
for the Mozilla Firefox browser.
You also must know the XML
format information to enter in the REST client software, including
a user name and password for basic authentication. For more information
on the XML information to enter, see Bulk uploads.
-
Sign in to the PEM Portal as a Sponsor Administrator.
- Open your REST or SOAP client software.
Important: Use the REST or SOAP client software for the remainder of the commands in
this procedure. However, it is necessary for correct permissions that you sign in to PEM Portal first.
- In the client software, select .
Enter
the user name and password into the fields that are provided, and
click OK or a similar command in the client
software.
- In the client software, select POST as
the HTTP request method.
- Set the header 'Content-Type: application/xml'.
- Enter the following URL pattern to access the Create Partner
User REST API:
https://<registered domain name>/mrmws/sponsors/<sponsor-context>/partners/
<partner-key>/users
Where:
- <registered domain name> is the domain name of your server
- <sponsor-context> is the sponsor context URI (short name to identify the
company)
- <partner-key> is the string of characters in the response when the
partner was registered
Note: The <partner-key> acts as a partner key for authentication. The
partner key was included in the success response when the partner was created with an API.
- Enter or paste the XML information for the new partner
user in the Body portion of the request.
This example shows an entry to create a user with Standard User
permissions.
<create userId="yourname@in.ibm.com" firstName="partner" lastName="user"
participantRole="PARTNER_STANDARD" comments="created by admin through REST
service" officePhone="5554567890" question="Company name?" answer="IBM"/>
Allowed
values for the participantRole parameter are PARTNER_STANDARD and PARTNER_ADMIN.
- Click Send or a similar command
in your client software to post the request.
If the
user was created successfully, you get a response with the status
code HTTP/1.1 201 Created. This response
means that the partner user was created successfully.