Getting authorization to use REST APIs

You must authorize before you can use APIs for management services in the REST API UI. You must provide cluster admin credentials and a client ID to obtain an access token. Each token lasts approximately ten minutes. After a token expires, you can authorize again for a new access token.

Before you begin

About this task

Authorization functionality is set up for you during management node installation and deployment. The token service is based on the storage cluster you defined during setup.

Steps

  1. Open the REST API UI on the management node: https://[management node IP]/mnode
  2. Click Authorize and complete the following:
    Note: Alternately, you can click on a lock icon next to any service API and follow these same steps to authorize.
    1. Enter the cluster user name and password.
    2. Select Request body from the type drop-down list if the value is not already selected.
    3. Enter the client ID as mnode-client if the value is not already populated.
    4. Do not enter a value for the client secret.
    5. Click Authorize to begin a session.
      Note: If the error message Auth Error TypeError: Failed to fetch is returned after you attempt to authorize, you might need to accept the SSL certificate for the MVIP of your cluster. Copy the IP in the Token URL, paste the IP into another browser tab, and authorize again.
      The Available authorizations screen indicates Authorized and the button to authorize has changed to Logout.
  3. Close the Available authorizations dialog box.
    Note: If you attempt to run a command after the token expires, a 401 Error: UNAUTHORIZED message is returned. If you receive this response, authorize again.