Skip to main content
Delphix

Logging into and Connecting to the Masking API Client (KBA5754)

 

KBA

KBA# 5754

Applicable Delphix Versions

Click here to view the versions of the Delphix engine to which this article applies
Major Release All Sub Releases
6.0 6.0.0.0, 6.0.1.0, 6.0.1.1

5.3

5.3.0.0, 5.3.0.1, 5.3.0.2, 5.3.0.3, 5.3.1.0, 5.3.1.1, 5.3.1.2, 5.3.2.0, 5.3.3.0, 5.3.3.1, 5.3.4.0, 5.3.5.0 5.3.6.0, 5.3.7.0, 5.3.7.1, 5.3.8.0, 5.3.8.1, 5.3.9.0

Issue

This article aims to show how to access and login to the Masking API Client :

photo_of_maskingAPIclient.png

 

Prerequisites

Before trying to logon to the Masking Engine API client, check that you can successfully connect to the Masking Engine via the Masking Admin GUI.

Connecting to the Masking Engine API client

  1. Bring up the API client on your browser, by entering the following URL into the address bar of your browser, replacing  
    <myMaskingEngine.myDomain.com> with the name or IP address of your masking engine

    Format:
    http://<myMaskingEngine.myDomain.com>/masking/api-client/

    URL example:   
    http://md539mask5.dc4.delphix.com/masking/api-client/


    The Client front end then gets displayed:
    photo_of_maskingAPIclient.png
  2. Scroll down and click login. 
     
  3. Click Log in to the Masking Engine.
    2-Login_options.png
     
  4. Provide the Parameters Value required for login.
    To save time typing the format of the value, click within the box under 
    'Example Value'. This action copies the contents under the Example Value into the Required field.
    3-provide_login_credentials.png
     
  5. Type the username and password to be used by the login,and then click 4-click-on-TryitOut.png
    A successful login returns with an Authorization string under the Response Body and a response code of 200.
  6. Copy the red-highlighted string within the double-quotes.
    5-Copy_the-authorisation-code.png
     
  7. You also need to authorize for further Client API activities during this session.
    Scroll up to the top of the screen and click on 7-a-click-on-Authorize-at-the-top-of-thepage.png.

    The API key authorization' popup will be displayed. 
    8-a_api-key-authorization-popup.png
     
  8. Copy/paste or type the authorization string into the api_key field, then click Authorize. If you click on 'Authorize' again you will get an indication that you are authorized as the Logout button becomes available. 
    8-c-This-indicates_youare_authorised-todofurtheractions.png

You have now completed logging into the Masking API Client.

A short video of this procedure can also be found in the Delphix Community by navigating to the following URL: How to Login into the Masking API Client (A Video) .

Related Articles

The following articles may provide more information or related information to this article: