@trimble-oss/trimble-id

@trimble-oss/trimble-id

Trimble Identity SDK developer documentation for TypeScript.

📚 Documentation - 🚀 Getting Started - 💬 Support

Documentation

• Developer guide - Our Dev guide to work with various authentication grant types and its providers.
• Reference documentation - Our code reference documentation for various grant token providers from code comments.
• Samples - a code guided samples for all supported grant type token providers.
• FAQs - frequently asked questions answering the most common questions.
• Release Notes - release notes about trimble-id SDK.

Getting Started

Installation

Using npm in your project directory run the following command:

npm install @trimble-oss/trimble-id

Configure Trimble Identity

Create a new application in the Trimble Developer Console portal and configure the following settings:

To register your service application in Trimble Developer Console:

• On the left pane select Identity Management > Applications.

• On the Applications home page, in the top right corner select + NEW APPLICATION. The Create Application page displays.

• Select Continue to enter the applications details.

  Field	Description
  Name	Name of your application
  Display Name	Provide a display name of the application.
  Description	Provide a description for the application.

• Configure Grant Type and Token preferences of your application choice.

  Field	Description
  Application Grant Types	Select the grant types that will be used for authenticating users or applications.
  Allowed Callback URLS	Refers to the redirect URI of the application after logging into Identity. More than one URL can be added to this field. The total URI length should not exceed 400kb. This field appears only when you select the Authorization Grant type.
  Allowed Logout URLS	The URIs that Identity can redirect to after log out. More than one UL can be added to this field. The total URI length should not exceed 400kb. This field appears only when you select the Authorization Grant type.

• Select "Create Application" to save changes.

Take note of the Client ID and URLs under the "Basic Information" section. You'll need these values to configure the SDK.

For more information, see Authentication documentation.

Raise an issue

To provide feedback or report a bug, please raise an issue on our issue tracker.

Support

Send email to [e-mail]