Partner Login Object

The Partner Login Object defines additional partner logins (sub-logins) that can be used to access CarrierX API or the CarrierX Portal under a partner account. Each sub-login can have its own password and a specific set of scopes determining which API resources it can access.

Partner Login Object Attributes

The fields listed in the table below will be returned in a JSON object when a successful request has been made.

note

Currently, the partner additional logins are only used with the requests sent from CarrierX portal.

Attribute	Data Type	Description
login create	string	The partner additional login (sub-login) to the system.
login_sid read only	string	The partner login secure ID.
partner_sid read only	string	The secure ID of the partner associated with the partner sub-login.
password createupdate	string	The partner password for the partner sub-login to the system. This field is required to create a Partner Login object, but is hidden in the serialized copy of the Partner Login objects received in responses to the requests for the security reasons.
token_scopes createupdate	array	The list of scopes that will be applied to the tokens created with this partner sub-login.

Sample 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"
    ]
}