Initiating a UCP Advisor API session

Unified Compute Platform (UCP) Advisor Administration Guide

Version
4.6.x
Audience
anonymous
Part Number
MK-92UCP119-15
ft:lastEdition
2024-09-24

You must generate an authentication token for the UCP system managed by UCP Advisor before you can run any administrative API on those systems.

Access the UCP Advisor API, and then run the userLogin operation in the administration collection to generate a global bearer token that can be used for any of the APIs. You do not need to re-enter the token when you try out other APIs.

  1. Access the UCP Advisor API.
  2. Expand the administration collection, and then click userLogin (POST /v2/auth/login).
    Click userLogin

  3. Click Try it out.
  4. In the payload pane, enter the following for the UCP system to which you want to connect:
    • username: Enter your username.
    • password: Enter your password.
  5. Click Execute.
    Click Execute

    The token is returned in the response body. Copy the required authentication token.
  6. Click Authorize at the top of the Swagger UI page.

    Click Authorize

  7. Paste the token in the Value field, and then click Authorize. Note: Do not enter a prefix, such as Bearer.

    Paste the token in the Value field, and then click Authorize

  8. Click Close. The authorization token is passed to any API that you try out in the current session.

    Click Close