Skip to content

oidcext:OIDCScopedString

Scott Cantor edited this page Feb 16, 2021 · 12 revisions

OIDCScopedString encoder encodes an IdPAttribute with scoped string values as a JSON object with string value. This encoder typically combines the value and scope strings, adds a delimiter, and produces a simple string-valued element. If IdPAttribute has multiple scoped string values they are catenated to a single string value with space as delimeter. Multiple values may be encoded also as a JSON array.

Schema Name and Location

This xsi:type is defined by the org.geant.idpextension.oidc.attribute.encoder schema, which is located at https://github.com/CSCfi/shibboleth-idp-oidc-extension/blob/master/idp-oidc-extension-impl/src/main/resources/schema/idp-oidc-extension-attribute-encoder.xsd and used by the reference installation from classpath:/schema/idp-oidc-extension-attribute-encoder.xsd

JSON Encoder Attributes

  • scopeDelimiter, can be used to replace the default scope delimeter '@'.
  • asArray, set values to JSON Array. Default value is "false".
  • stringDelimiter, delimiter used when catenating multiple values to single string. Default is " ".
  • setToToken, Default is "false". If set to true the value is to encoded to Authorization Code or to Access Token to ensure availability in Token and Userinfo endpoints.
  • placeToIDToken, Default is "false". By default attributes are delivered in userinfo response unless response type is "id_token". Setting the flag true will include attribute in id token regardless of response type.
  • denyUserinfo, Default is "false". By default attributes are delivered in userinfo response unless response type is "id_token". Setting the flag true excludes attribute from userinfo response.

Example

<AttributeEncoder xsi:type="oidcext:OIDCScopedString" name="eppn"/>

<AttributeEncoder xsi:type="oidcext:OIDCScopedString" name="eppn" scopeDelimiter="#"/>

(Migrated)