This configuration template is used to register an external Client application to AGE's Authorization Broker by particular API Key, or to unregister this application using this key. The configuration root controller of this template is called age_auth_api. The value supported by this controller is also a configuration object that consists of the following fields: •key - This is the API Key used to authenticate the client's application. •name - Contains a short name (title) of the client's application. •secret - (optional) Contains a kind of secret string sequence used for some authorizations, such as OAuth2 Authorization Code and Client Credentials. •callback - (optional) Reference to client's resource eventually granted with an access token or other authorization credentials. •scope - (optional) The scope of authorization is described with one or more values that would be recognized by the respective resources or services. The following separators are supported: , (comma) or ; (semicolon) or | (vertical bar) or + (plus).
This controller supports the following actions: •add - inserts or updates API registration by key. This is the default value, meaning that when the actions qualifier is omitted then the default action is applied. •delete - unregisters an API registration by key.
Some additional notes: ✓This configuration template can be used in configuration collection with other templates. ✓Multiple actions can be executed in priority selected by the specified order within the actions list. ✓Be aware that the actions can be duplicated in the list, so use them wisely. |
#{ |