accessmanagerapikey

This configuration is required when using the plugin AccessManager_ApiKey.

  • Documentation

  • YAML Format

  • XML Format

Fill relevant inputs (blue boxes) and click the blue bars on the left to copy XML configuration snippets.
<adminApiClientConfiguration
>
required

Configuration of the authentication for the Published Administration API endpoints via API-Key and the hash-signature.

<clients
<client
<clientId
>
requiredmax. 1
string

Unique identifier string, is used as login user

</clientId>
<apiKey
xsd:string
validUntil
optional
=
date

optional expire date (ISO-8601 compliant YYYY-MM-DD)

>
requiredmax. 1

Unique identifier, is used to identify the the client

</apiKey>
<encodedSignatureKey
>
requiredmax. 1
string

HMAC signing key Base64 encoded

</encodedSignatureKey>
<groups
<group
>
optionalmax. unbounded
string

Name of an accessible user group

</group>
>
optionalmax. 1

List of accessible user groups

</groups>
>
optionalmax. unbounded

Configuration for a client

</client>
>
optionalmax. 1

List of configurations for various clients

</clients>
</adminApiClientConfiguration>
This is a generated sample file with fake data and all the possible options shown, refer to the Documentation tab for what combinations are valid and what is required or not. 
cadenzaconfig:
  settings:
    accessmanagerapikey:
      clients:
      - clientId: "text"
        apiKey:
          validUntil: "2024-12-16T12:34:56"
          value: "text"
        encodedSignatureKey: "text"
        groups:
        - "text"
        - "text"
      - clientId: "text"
        apiKey:
          validUntil: "2024-12-16T12:34:56"
          value: "text"
        encodedSignatureKey: "text"
        groups:
        - "text"
        - "text"

Filename: accessmanagerapikey-config.xml

This is a generated sample file with fake data and all the possible options shown, refer to the Documentation tab for what combinations are valid and what is required or not. 
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<adminApiClientConfiguration>
  <clients>
    <client>
      <clientId>text</clientId>
      <apiKey validUntil="2024-12-16">text</apiKey>
      <encodedSignatureKey>text</encodedSignatureKey>
      <groups>
        <group>text</group>
        <group>text</group>
      </groups>
    </client>
    <client>
      <clientId>text</clientId>
      <apiKey validUntil="2024-12-16">text</apiKey>
      <encodedSignatureKey>text</encodedSignatureKey>
      <groups>
        <group>text</group>
        <group>text</group>
      </groups>
    </client>
  </clients>
</adminApiClientConfiguration>