Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

This page describes the high-level steps of how an external application communicates with the Usage Engine APIs using Client Credentials. You need authorization token to be able to access the Usage Engine CE API. See the following example of an authorization token:

...

Rw ui steps macro
Rw step

The external application uses the credentials (Client ID and Client Secret) to authenticate with the Usage Engine Identity Provider (IdP) and requests a token to access the API. To create token you also need to provide audience and grant type. See Configuring Application Access for information on how to create the application access.

Only Administrators can create Application accesses.

Rw step

The IdP verifies the credentials and generates a temporary token, referred to as <access token> in the following steps.

Rw step

The external application sends the <access token> to access a resource in an API, for example, Usage Metering API.

Rw step

The API checks with the IdP if the <access token> is valid and if the application has permission to access the requested resource/functionality.

Rw step

If the <access token> is valid, the permission is granted.

Rw step

The API responds to the requests with the results of the operation.

...