Generate OAuth Bearer Token for Sub-partner

This request generates the token for a sub-partner, targeted by secure ID.

post	/oauth/token/{partner_sid}

Sample

A sample POST request to generate an OAuth bearer token for a sub-partner:

Unlike most CarrierX API requests, this request must be sent with Content-Type: application/x-www-form-urlencoded, not application/json.

curl -X POST \
'https://api.carrierx.com/core/v2/oauth/token/cee93bf3-5746-43fe-a1a2-822c05fef687' \
-H 'Content-Type: application/x-www-form-urlencoded' \
--data-binary 'client_id=5c7965f285344165b003ce1a3202e589&client_secret=5033909114fe442cbbcb83b674dbf90c'

Response

200 status code with a serialized copy of the OAuth Token object:

{
    "access_token": "8bfd6c6d-6291-488a-bed1-8784c195ce87",
    "client_id": "5c7965f285344165b003ce1a3202e589",
    "date_created": "2024-09-11T13:46:42.211Z",
    "date_expiration_access_token": "2124-08-18T13:46:42.169Z",
    "date_expiration_refresh_token": "2124-08-18T13:46:42.169Z",
    "date_last_accessed": null,
    "ip_last_accessed": null,
    "name": "test_token",
    "partner_sid": "cee93bf3-5746-43fe-a1a2-822c05fef687",
    "refresh_token": "ed07dcd6-dfc5-4d7b-b7b4-891441371b3e",
    "scopes": [
        "accesscontrol.manage",
        "endpoints.manage",
        "oauth.manage",
        "partners.manage",
        "phonenumber.manage",
        "push.manage",
        "shortener.manage",
        "sms.manage",
        "storage.manage",
        "trunk_groups.manage",
        "trunk_groups.trunks.manage"
    ],
    "status": "active",
    "token_sid": "b3f45e4d-7d46-467b-9724-272f57ac420e",
    "token_type": "bearer"
}

Required Scopes

To generate an OAuth token for a sub-partner the partner must have one of the following scopes enabled:

• oauth.manage_all_tokens
• oauth.manage
• oauth.create

Path Arguments

Parameter	Data Type	Description
partner_sid required	string	The sub-partner secure ID.

Parameter	Data Type	Description
access_token_expires_in	integer	The access token expiration in seconds.
client_id required	string	The OAuth client ID, used together with the client secret to authenticate this request. Contact CarrierX support at [email protected] to obtain your client ID and client secret.
client_secret required	string	The OAuth client secret, used together with the client ID to authenticate this request. Contact CarrierX support at [email protected] to obtain your client ID and client secret.
name	string	The friendly name used to identify the token.
refresh_token_expires_in	integer	The refresh token expiration in seconds.
scope	string	The list of comma-separated partner scopes available for the generated token.