Endpoints and authentication

The service endpoints are available at https://red-<region>.mysecuredatavault.com/swagger, where <region> is your location. Use the endpoint routes specified in the Swagger documentation to make your API calls.

Do not call the API repeatedly. Do not make more than 50 requests for any route per hour, and do not create more than 100 users per hour. If you are abusing the API, OpenText reserves the right to disable your account.

 

Authentication in the form of a JSON Web Token (JWT) is used in the header of each request. For each API call, you will need to authenticate, receive a JWT, insert the JWT into the header of your request, and then make the authenticated call. You do this by using an API secret key and your email address to make the request.

1. Obtain the API secret key from the vault dashboard.
   1. Log in to the dashboard and go to Users.
   2. Select the user that has been assigned API access.
   3. Go to the Key Management tab. You will not see this tab if the user was not granted API access on the backend.
   4. Enable Allow API access for this user.
   5. Click Create new key.
   6. Copy the key that is displayed. This is the only time you will see the key, so you must copy it when you see it.

2. Using the API secret key you copied and your email address, make the authorization request.

   Copy

   curl -X POST --header 'Content-Type: application/json' --header 'Accept: application/json' -d
   '{
      "ApiKeySecret": "CopiedSecretCopied",
      "Email": "Name@domain.com",
   }'
   'https://red-region.mysecuredatavault.com/api/tokens/apikey'

The authorization request, if successful, will return the JWT. The access token must be used in the header of your API calls. The token expiration is one hour, after which you will need to request a new token.

See Sample code for cURL examples for creating a company and a user.