Theme

Connectors ​

API endpoints for Connectors management in WORKSPACE.

Create Connector ​

http
POST /v1/:wid/:ctype/:xcode/connectors

Headers ​

  • de-user-agent (required)
  • de-auth-token (required)
  • de-auth-device (required)

Request Body ​

typescript
interface Create ConnectorRequest {
  type: string;
  name: string;
  description: string;
  config: {
    protocol: string;
    version: string;
    scope: string[]
  };
}

Example:

json
{
  "type": "ASI",
  "name": "mijo-lsp-auth",
  "description": "Mijo Auth & User accounts Service management access",
  "config": {
    "protocol": "http1",
    "version": "1",
    "scope": [
      "name",
      "country",
      "photo",
      "theme",
      "settings"
    ]
  }
}

Response ​

- Create MSI Connector:

Status: 201

json
{
  "error": false,
  "status": "CONNECTOR::CREATED",
  "connectorId": "mgx0mdg",
  "trace": "36bc3499-e402-4efe-909f-528d3c86dfa9"
}

- Create IoT Connector:

Status: 201

json
{
  "error": false,
  "status": "CONNECTOR::CREATED",
  "connectorId": "mgx0oup",
  "trace": "2e3d0efa-48bb-40c5-ba9c-b97e246a70b6"
}

- Create API Connector for LSP:

Status: 201

json
{
  "error": false,
  "status": "CONNECTOR::CREATED",
  "connectorId": "mgx17dn",
  "trace": "b063272d-7417-47c2-a2b5-270b913342de"
}

- Create API connector for IoTSP:

Status: 201

json
{
  "error": false,
  "status": "CONNECTOR::CREATED",
  "connectorId": "mh58tw8",
  "trace": "a0667777-7046-4257-a22d-0ad9b8241ee3"
}

- Create ASI Connector for LSP:

Status: 201

json
{
  "error": false,
  "status": "CONNECTOR::CREATED",
  "connectorId": "mhuc0hf",
  "trace": "80bc22f9-a8ed-4461-9619-ded263c29166"
}

Retreive Connector Information ​

http
GET /v1/:wid/:ctype/:xcode/connectors/:id

Headers ​

  • de-user-agent (required)
  • de-auth-token (required)
  • de-auth-device (required)

Get All Connectors ​

http
GET /v1/:wid/:ctype/:xcode/connectors

Headers ​

  • de-user-agent (required)
  • de-auth-token (required)
  • de-auth-device (required)

Update Connector Information ​

http
PATCH /v1/:wid/:ctype/:xcode/connectors/:id

Headers ​

  • de-user-agent (required)
  • de-auth-token (required)
  • de-auth-device (required)

Enable/Disabled Connector ​

http
PATCH /v1/:wid/:ctype/:xcode/connectors/:id/:action

Headers ​

  • de-user-agent (required)
  • de-auth-token (required)
  • de-auth-device (required)

Update Connector Access ​

http
PATCH /v1/:wid/:ctype/:xcode/connectors/:id/access

Headers ​

  • de-user-agent (required)
  • de-auth-token (required)
  • de-auth-device (required)

Request Body ​

typescript
interface Update Connector AccessRequest {
  origins: string[];
}

Example:

json
{
  "origins": [
    "{{DemoOrigin}}"
  ]
}

Rotate Connector Access Secret ​

http
PATCH /v1/:wid/:ctype/:xcode/connectors/:id/secret/rotate

Headers ​

  • de-user-agent (required)
  • de-auth-token (required)
  • de-auth-device (required)

Set Connector Configuration ​

http
PUT /v1/:wid/:ctype/:xcode/connectors/:id/config

Headers ​

  • de-user-agent (required)
  • de-auth-token (required)
  • de-auth-device (required)

Request Body ​

typescript
interface Set Connector ConfigurationRequest {
  protocol: string;
  version: string;
  scope: string[];
  auth: string;
}

Example:

json
{
  "protocol": "http1",
  "version": "1",
  "scope": [
    "*"
  ],
  "auth": "external"
}

Update Connector Configuration Subset ​

http
PATCH /v1/:wid/:ctype/:xcode/connectors/:id/config

Headers ​

  • de-user-agent (required)
  • de-auth-token (required)
  • de-auth-device (required)

Delete Connector ​

http
DELETE /v1/:wid/:ctype/:xcode/connectors/:id

Headers ​

  • de-user-agent (required)
  • de-auth-token (required)
  • de-auth-device (required)