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. The value must start with the parent partner's login followed by an underscore. For example, if the parent partner's login is john, a valid sub-login is john_reports.
login_sid read only	string	The partner login secure ID.
mfa createupdate	object	The MFA configuration for this login. When set, and the OAuth Client used to authenticate has mfa_required set to true, logging in with this login requires an extra verification step. The default value is null, meaning MFA is not configured for this login. Refer to the table below for more information.
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 create	array	The list of scopes that will be applied to the tokens created with this partner sub-login.

MFA Object

The MFA object defines how a verification code is delivered and validated for this login when authenticating through an OAuth Client that has mfa_required set to true.

Attribute	Data Type	Description
methodcreate update	string	The MFA method. Values accepted in this field are email, sms, and totp. Required if the mfa object is present.
emailcreate update	string	The email address the verification code is sent to. Required if method is email.
phonenumbercreate update	string	The phone number the verification code is sent to via SMS. Required if method is sms.
totp_verifiedread only	boolean	Whether a TOTP secret has been enrolled and verified for this login. method cannot be set to totp until this is true.

note

Self-service enrollment of a TOTP secret (e.g., scanning a QR code into an authenticator app like Google Authenticator) is not currently available through the API. Setting method to totp before totp_verified is true for the login returns a 400 error.

Sample Partner Login object

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