Create Partner Login

This request creates an additional login for a partner.

post	/oauth/logins

Sample

A sample POST request to creates a partner sub-login:

curl -X POST \
'https://api.carrierx.com/core/v2/oauth/logins' \
-H 'Content-Type: application/json' \
--data-binary '{"login":"carrierx_partner","password":"myStrongPassword123","token_scopes":["partners.read","partners.update"]}' \
-H 'Authorization: Bearer 5ebc03d6-8b2b-44ad-bf65-72d4f1491dda'

Response

200 status code with a serialized copy of the Partner Login object:

{
    "login": "carrierx_partner",
    "login_sid": "abcf6b1f-7281-4da9-a4d6-3fb53e3a76de",
    "partner_sid": "edebf627-ebce-4f77-8160-75db76154168",
    "token_scopes": [
        "partners.read",
        "partners.update"
    ]
}

Required Scopes

To create a Partner Login object, the partner must have one of the following scopes enabled:

• oauth.manage
• oauth.create

Body Arguments

JSON representation of the fields and values of the Partner Login object to be created.

Required fields to create a partner login are:

• login
• password
• token_scopes

note

The login attribute has the following naming conventions:

• the first part must contain the current partner login to the system (<partner.login>);
• the second part contains the sub-login used as additional login to the system (<sub-login>);
• the two parts must be separated with the underscore.

Thus, the login attribute value must look like the following:

<partner.login>_<sub-login> (e.g., carrierx_sublogin)

Refer to this table to view all fields that appear in the Partner Login object.