Query parameters for aa:attributes

This page defines common query parameters that can be used when querying an aa:attributes resource.

attributes

A comma separated list of attribute names that shall be returned.

If a comma (',') is part of an attribute’s name, it needs to be escaped. For example, the attribute name "escape,me" must be passed as "escape\,me".

If the query parameter is missing or empty, the result depends on the URL query parameter exclude-multi-value:

  • If exclude-multi-value is not given or false: returns all attributes.

  • If exclude-multi-value is true: returns all attributes except multi-value attributes.

exclude-multi-value

Only used if ?attributes is not given or is empty.

If true, all attributes except multi-value attributes are returned.

If not given or false, all attributes are returned.

lang

Specifies the language or locale for localizable information, if supported. The value must be a must be a valid IETF BCP 47 language tag.

  • If missing or empty, labels for language "en" will be returned.

  • If there is no label for the given language tag, the response will automatically fall back to another label (usually the English one), but return it with the given language tag. Example: If the caller asks for ?lang=fr and there is no French label, then the response will contain "fr" as language tag, but a fallback label as value:

{
  "labels": {
    "fr": "English label"
  }
}