REST API Reference

REST API Reference

Logging In

Logging In

To access the TDM REST API Swagger page, enter the host name and port number of the TDM server in a web browser.
To log in, enter a valid TDM user name and password.
  1. In the address bar of a web browser, enter the URL in the following format:
    http(s)://<host name>:<port number>/api
    Where:
    • <host name>
      is the host name or IP address of the machine where you installed TDM.
    • <port number>
      is the port number. The default is 6643 if Transport Layer Security is enabled. The default is 6605 if Transport Layer Security is not enabled.
  2. Select the required scheme from the list of schemes.
  3. Click Authorize to open the Authorization window.
    TDM REST API uses Basic Auth for authorization. Basic authentication is a simple authentication scheme built into the HTTP protocol. The client sends HTTP requests with the Authorization header that contains the word Basic followed by a space and a base64-encoded string
    username:password
    .
  4. Enter a user name in the following format:
    <Security domain>/<user name>
    Where:
    • <Security domain>
      is the name of the security domain to which the user belongs.
    • <user name>
      is the domain user name.
    For example,
    Native/user1
  5. Enter the password and click
    Authorize
    .
Every REST API call must contain the authentication information in the Authorization header. The information is validated and then the API call is processed. If the information is not valid, it generates an error. Based on the client you use, the authorization information might be added to Authorization headers by default or you might need to add it to the header of each request.

0 COMMENTS

We’d like to hear from you!