Skip to main content

Get Partner Login by SID

This request returns data for a partner login, targeted by secure ID.

get /oauth/logins/{login_sid}

Sample

A sample GET request to get a partner login, targeted by secure ID:

curl -X GET \
'https://api.carrierx.com/core/v2/oauth/logins/abcf6b1f-7281-4da9-a4d6-3fb53e3a76de' \
-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"
]
}

This request is enabled for Field Filtering.

Required Scopes

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

  • oauth.manage
  • oauth.read

Path Arguments

ParameterData TypeDescription
login_sid requiredstringThe partner login secure ID.