Skip to content
API Cloud

Enable Oneway TLS or Mutual TLS

Prerequisties

  • Register your application with Trimble Cloud Console.
  • Subscribe the registered application to the SSL Management API in the Trimble Developer Marketplace.
  • Generate Access Key.

Use the following API to enable oneway or mutual TLS connection.

Create a proxy with TLS

The following API creates a Proxy and enables oneway or mutual TLS connection.

  • API CALL:

Post http://cloud.api.trimble.com/ssl-management/publisher/api//version//environment//ssl?product=<API_PRODUCTS>

+ APINAME - holds the name of the api proxy
+ VERSION - holds the version name of the api proxy i.e. 1.0 / v1
+ ENV - holds the apigee environment (dev/qa/stage/prod)
+ API\_PRODUCTS - holds comma separated API PRODUCTS to be bundled with the api proxy
  • HEADERS
  • Accept: application/json

This may be automatically added by your development tool. Postman and curl add this header to all requests.

– Authorization: Bearer {bearer token}

Include Trimble Identity OAuth Bearer token for your application (see get access token instructions for more information).

  • BODY

– basepath : Holds the base path of the api proxy

– targetUrl : Holds the complete target endpoint

– tls : Holds one of the following enums (ONE_WAY_TLS / TWO_WAY_TLS). If you fail to provide a value, it defaults to ONE_WAY_TLS

– namespace: Namespace is a way to tag API Proxies by Trimble applications or products. For example, SketchUp, Trimble Cloud Platform, Tekla and so on. For more details, see Add a Namespace.

  {
   "basepath":"/<BASE_PATH>",
   "targetUrl":<TARGET_URL>,
   "tls":<TLS>,
   "namespace": <NAMESPACE>
  }

Update an existing proxy with TLS

The following API enables oneway or mutual TLS connection in an existing Proxy.

  • API CALL

POST http://cloud.api.trimble.com/ssl-management/publisher/api//version//environment//ssl?product=<API_PRODUCTS>

+ APINAME - Name of the API proxy
+ VERSION - Version of the API proxy i.e. 1.0 / v1
+ ENV - environment (dev/qa/stage/prod)
  • HEADERS

– Accept: application/json

This may be automatically added by your development tool. Postman and curl add this header to all requests.

– Authorization: Bearer {bearer token}

Include Trimble Identity OAuth Bearer token for your application (see get access token instructions for more information).

  • BODY
  {
   "backendUrl": "https://mockapi.apigee.apigee.com",
   "tls" : “ONE_WAY_TLS”,
       }

– backendUrl : Backend URL of the API that is updated for TLS connection.

– tls : Provide one of the following enums (ONE_WAY_TLS / TWO_WAY_TLS). If you fail to provide a value, it defaults to ONE_WAY_TLS.