OAuth 2.0 is the industry-standard protocol for authorization. This API returns an JSON web token (JWT) which is required to authorize API calls for a given app.
You can request up to 5 CLIENT_ID + CLIENT_Secret per company account.
API features
- access tokens generated by this API are valid for a limited period (30 mins) which is returned in the API response.
- If the token expires, this API will need to be called again.
API Details
Status | LIVE |
Version | v1 |
Maturity status | Production |
Endpoint (Production) | https://apis.colt.net/authentication/v1/oauth/token |
Endpoint (Sandbox) | https://sandbox.apis.colt.net/authentication/v1/oauth/token |
Error returned in the response
| Http response | code | reason | message | details (for reference only) |
|---|---|---|---|---|
400 Bad request | 001 | Validation not met | The request is missing authorization parameter. | The request is missing authorization parameter |
| 002 | Validation not met | The request is missing grant_type. | The request is missing grant_type | |
| 003 | Validation not met | The request is missing content_type header | The request is missing content_type header | |
| 004 | Validation not met | The request is missing x-tracking-id. | The request is missing x-tracking-id | |
| 005 | Validation not met | Invalid input parameter | The request contains
| |
| 006 | Validation not met | The authorization grant type is not supported by authorization server | The authorization grant type is not supported by authorization server | |
401 Unauthorized | 001 | Authentication error | The authorization parameter is missing. | Client authentication failed due to no client authentication included in the request. |
| 002 | Authentication error | The authorization parameter is not valid. | Client authentication failed due to unsupported authentication method other than Basic. | |
415 Unsupported Media Type | 001 | Validation not met | The format of the posted body is not supported by the endpoint. | The format of the posted body is not supported by the endpoint. |
500 Internal server error | 001 | Internal error | An unknown internal error occurred | Generic failure message used if no more precise code can be provided. |
| 002 | internal error | O Auth server failed. | The server failed to generate access token | |
503 Service unavailable | 001 | service unavailable | The service is temporarily unavailable | Backend unavailable. |
authorization_v1.0.0_28Nov2024 2_0.yaml
(11.29 KB)
authorization_v1.0.0_28Nov2024 2_1.yaml
(11.29 KB)