• Workforce Connect Provisioning Manager Customer Administrator Guide
Provisioning Manager APIs
Provisioning Manager APIs

Provisioning Manager APIs

The Provisioning Manager provides APIs to manage tokens, bootstraps, and devices. A Swagger API page details API information and allows the administrator to try the APIs.
To access the
Swagger API
 page,
  1. In the top toolbar, click the
    Show
     menu and select
    Swagger APIs
    .
    The
    Swagger API
    page opens in a separate browser.
    Provisioning Manager REST API
    The API provides an auth-controller that contains a login procedure. An access token with a token type of Bearer is returned in the response. This token must be included in an authorization header in all other API requests as a form of authentication. An example header is below:
    authorization: Bearer <accessToken>
    When the Swagger page is used, we recommend using the button on the top right instead of the auth-controller as described in the following steps 2 through 5.
  2. Click the button to authorize the API access.
    The
    Available Authorization
     screen appears.
  3. Enter the username and password, and do not modify any other field.
  4. Click
    Authorize
     button.
    The
    Authorized
     screen appears.
  5. Click
    Close
    .
  6. The remaining controllers provided in the Provisioning Manager API are as follows:
    • bootstrap-controller
       allows viewing and managing bootstraps as follows:
      • Add/update a bootstrap by name
      • Delete  a bootstrap by name
      • Get a bootstrap by name
      • Get a list of all bootstraps
    • admin-controller allows deleting devices by device  ID to obsolete the selected device and return all assigned licenses for that device to the pool of available licenses.
    • tokens-controller
        allows viewing and managing tokens and their association with bootstrap parameters as follows:
      • Add/update a token by name
      • Delete a token by name
      • Get a token by name
      • Get a list of all tokens
  7. To access the API endpoint information, select the carat symbol
    >
     at the far right of each controller group. The
    Swagger API
     page provides API details and an option to try the APIs.
  8. To return to the Provisioning Manager interface, select thes browser tab where the Provisioning Manager application is running.
When updating information for the Provisioning Manager, use either the Provisioning Manager interface or the Provisioning Manager APIs. Do not use the interface and the APIs at the same time, as this could cause synchronization issues.