Versions Compared

Key

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

...


Management API

The Management API is used to provision scopes and register clients via HTTP. Clients need to be registered before any access token can be requested.

The Management API configuration is used to configure the base endpoint in the Authorization Server that will be used to host the Management API.

For more information on the function of the Management API, refer to New Management API

Parameter NameDescription
enable-basic-auth

Enable HTTP Basic Authentication for Management API

Info

It is recommended to have enable-basic-auth set to true. This is so the list of clients and scope will not be accessible to anyone without the proper credentials mentioned below.


username
Username for HTTP Basic Authentication (if enabled)
password
Password for HTTP Basic Authentication (if enabled). Must be encrypted using "mzsh encryptpassword" command


JWT

The Authorization Server generates JSON Web Token (JWT) based access token and requires the JWT to be digitally signed. Currently, only the RSA private/public key pair signing method is supported.

The JWT block is used to configure the keystore and the RSA private/public key pair details.

Parameter NameDescription
keystore-location
Path to the keystore where the RSA private/public key pair used for JWT is stored. Only Java KeyStore (JKS) format is supported.
keystore-password
Password of the keystore. Must be encrypted using "mzsh encryptpassword" command
key-id
Alias of the RSA private/public key pair used for JWT
key-password
Password of the RSA private/public key pair used for JWT
signature-algorithm
Signature algorithm to be used for JWT sigining. Only RS256, RS384 and RS512 are supported