Token Validation Service

Release Time

12/18/2017

Views

20892 times

Tags

Description

Introduction:

3rd Party Authentication and Authorization API provides a security mechanism similar to OAuth2 standard. With this mechanism client APIs can access C1 Platform Resources in a secure way.

There are some prerequisites before usage of this API.

Client API credentials. Credentials will be provided by the C1 team. The credentials shall be used for HTTP Basic Authentication of endpoints.
Resource owner credentials. Credentials shall be used for login endpoint. Username/password and TLS Client Certificate Verification.

First clients need to obtain access and refresh tokens via login endpoint. With access token clients can access protected resources. Please see section "Usage Of Access Token" to use access tokens.

For testing purposed on Preview Environment following credentials is created.

For User Client (name):

username: user

password: *******************************

On order to access Authentication API TLS Client Certificate Verification is also performed. Therefore the test certificate must be shared with Comodo to grad access.Access tokens are short lived tokens. Therefore they expire quickly. New access tokens can be obtained without resource owner credentials via renew endpoint. Refresh tokens are used to create new access tokens. Refresh tokens are long lived tokens and can be persisted for longer use. They are critical for the security of protected resources. Because of that please store them in a secure way and do not share them with any other 3rd parties.

For details of the transactions for authentication API please look at 3rd Party API

Token Validation Service:

Endpoint	https://api.one.comodo.com/auth/validate
Method	GET
Authentication	HTTP Basic (Client API Credentials)
Content-Type	JSON (application/json)

Descriptions:

REQUEST
NAME	TYPE	REQUIRED	DESCRIPTIONS
accessToken	string	required
RESPONSE
NAME	TYPE	REQUIRED	DESCRIPTIONS
id	string	required	access token identifier for internal use
issuer	string	required	Always c1portal
requestedBy	string	required	Client API Identifier
customerId	string	required	MSP/Enterprise ID
expiresAt	integer (UNIX Timestamp)	required	Expiration date of the access token
issuedAt	integer (UNIX Timestamp)	required	Issue date of the access token
tokenType	string	required	Always bearer
scope	Object (key/value)	required	Key value pairs. Contains granted scopes.

HTTP CODE	METHOD	DESCRIPTIONS
401	Not authorized	Client credentials or access token is invalid.
402	Invalid request	Request parameters are missing or invalid.

Execution

Sample execution can be handled via Postman Application.

Header part can be handled via Postman Application

https://api.one.comodo.com/auth/validate?accessToken=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6Imlwbmg3eHp5YmxtdnZoMmp4cDIwdW53c3Z5N3BoMHB6b3NtcTFvZmUiLCJpc3N1ZXIiOiJjMXBvcnRhbCIsInJlcXVlc3RlZEJ5IjoiNTA3ZjFmNzdiY2Y4NmNkNzk5NDM5MDExIiwiY3VzdG9tZXJJZCI6IjUwN2YxZjc3YmNmODZjZDc5OTQzOTAxMSIsImV4cGlyZXNBdCI6MTQ4MzcxMTY1MCwiaXNzdWVkQXQiOjE0ODM3MDgwNTAsInRva2VuVHlwZSI6ImJlYXJlciIsInNjb3BlIjp7Iml0c20tZG9tYWluIjoic3ViZG9tYWluLW1zcCJ9fQ.3ctZUI9rDMA_2Tyy0YnFgSXwoEoWfGcS9ROUSvimmro

Success Output

{
    "id": "ipnh7xzyblmvvh2jxp20unwsvy7ph0pzosmq1ofe",
    "issuer": "c1portal",
    "requestedBy": "clientapi",
    "customerId": "507f1f77bcf86cd799439011",
    "expiresAt": 1483711650,
    "issuedAt": 1483708050,
    "tokenType": "bearer",
    "scope": {
        "itsmDomain": "subdomain-msp"
    }
}

Token Validation Service

Execution

Success Output

Error Output