9.5. Security for Generated REST Services

By default all the generated Rest based services are secured using "HTTPBasic" with security domain "teiid-security" and with security role "rest". However, these properties can be customized by defining the then in vdb.xml file.

Example 9.1. Example vdb.xml file security specification

<vdb name="sample" version="1">
    <property name="UseConnectorMetadata" value="true" />
    <property name="{http://teiid.org/rest}auto-generate" value="true"/>
    <property name="{http://teiid.org/rest}security-type" value="HttpBasic"/>
    <property name="{http://teiid.org/rest}security-domain" value="teiid-security"/>
    <property name="{http://teiid.org/rest}security-role" value="example-role"/>
    <property name="{http://teiid.org/rest}passthrough-auth" value="true"/>

    ...
</vdb>
  • security-type - defines the security type. allowed values are "HttpBasic" or "none". If omitted will default to "HttpBasic"
  • security-domain - defines JAAS security domain to be used with HttpBasic. If omitted will default to "teiid-security"
  • security-role - security role that HttpBasic will use to authorize the users. If omitted the value will default to "rest"
  • passthough-auth - when defined the pass-through-authentication is used to login in to JBoss Data Virtualization. When this is set to "true", make sure that the "embedded" transport configuration in standalone.xml has defined a security-domain that can be authenticated against. Failure to add the configuration change will result in authentication error. Defaults to false.

Important

it is our intention to provide other types of security based on ws-security in future releases.