Comodo ONE 3rd Party Company API Definition

Release Time

12/18/2017

Views

33275 times

Tags

Description

1. Introduction

3rd Party Company API provides micro service to manage companies by 3rd party applications . With this mechanism client APIs can access C1 Platform and create new company .

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 of authentication API (pls see: 3rd Party Authentication API Definition). With access token clients can access protected resources of company.

2. Endpoints

2.1. Company Create Service

Endpoint	https://api.one.comodo.com/company
Method	POST
Authentication	HTTP Basic (Client API Credentials)
Content-Type	JSON (application/json)
Authorization	Bearer Access-Token

Descriptions:

REQUEST
NAME	TYPE	REQUIRED	DESCRIPTIONS
name	string	required	Company name.
description	string	required	Company description
contactEmail	string	required	Contact email of user.
address	string		Company address.
postalCode	string		Postal code of company location.
authenticatedAdminIds	list	required	Authenticated admin id list.
RESPONSE
NAME	TYPE	REQUIRED	DESCRIPTIONS
status	string		Service response status.
code	string		Response status code.
message	string		Response status message.
data	string		Created company data.
parentId	string		Company's parent id. (MSP id)
entry	string		Company entry json value.
displayName	string		Company name.
types	string

REQUEST
NAME		TYPE	REQUIRED	DESCRIPTIONS
name		string	required	Company name.
description		string	required	Company description
contactEmail		string	required	Contact email of user.
address		string		Company address.
postalCode		string		Postal code of company location.
authenticatedAdminIds		list	required	Authenticated admin id list.
RESPONSE
NAME		TYPE	REQUIRED	DESCRIPTIONS
status		string		Service response status.
code		string		Response status code.
message		string		Response status message.
data		string		Created company data.
parentId		string		Company's parent id. (MSP id)
entry		string		Company entry json value.
displayName		string		Company name.
types		string
description		string		Company description.
contactEmail		string		Company email.
address		string		Company address.
postalCode		string		Postal code of company location.
authenticatedAdminIds		list		Authenticated Admin Id list
lockedBy		string
lockedTime		datetime string
lockedByEmail		string
creationTime		datetime string		Company creation time.
path		list
_id		string		Created company object id.
HTTP CODE	MESSAGE	DESCRIPTIONS
401	Not authorized	Access token is invalid.
400	Invalid request	Request parameters are missing or invalid.

Execution

Sample execution can be handled via Postman Application.

{
    "name" :"company_name",
    "description" : "description",
    "contactEmail":"email@email.com",
    "address" : "Address",
    "postalCode":"06",
}

Header part can be handled via Postman Application

Success Output

{
  "status": "SUCCESS",
  "code": "SUCCESS_ADD_COMPANY",
  "message": "add successful",
  "data": {
    "parentId": "5915b2f3b47be9537f0ce2a6",
    "entry": {
      "displayName": "company_name",
      "types": [
        "c1-company"
      ],
      "description": "description",
      "contactEmail": "email@email.com",
      "address": "Address",
      "postalCode": "06",
      "authenticatedAdminIds": [
        "5915b30ab47be9537f0ce2a7"
      ],
      "lockedBy": "5915b30ab47be9537f0ce2a7",
      "lockedTime": "2017-05-26T15:39:26.807Z",
      "lockedByEmail": "mail@mail.com"
    },
    "creationTime": "2017-05-26T15:39:26.809Z",
    "path": [
      "553e3fa9bea444761cae020d",
      "5915b2f3b47be9537f0ce2a6"
    ],
    "_id": "59284c2ee918ca4e976230ed"
  }
}

Error Output

{
  "status": "ERROR",
  "code": "ERR_ALREADY_EXIST",
  "message": "User already exists."
}