← Back to plugin index

Adminapp REST API Configuration

Description
Configures the Adminapp REST interface.
Type name
AdminappRest
Class
com.airlock.iam.admin.application.configuration.AdminappRestConfig
May be used by
Properties
SMS Service Settings (smsServiceConfig)
Description
Enables and configures endpoints for sending SMS and checking the delivery status over the REST API.
Attributes
Plugin-Link
Optional
Assignable plugins
Request Authentication (requestAuthentication)
Description
Determines how a credential is extracted and used to authenticate single requests.
Attributes
Plugin-Link
Mandatory
Assignable plugins
Hash Shared Secret (hashSharedSecret)
Description
The shared secret to be included in the hashed information.

Can be used together with the 'Hash Function' to externalize session information to the client.

Attributes
String
Optional
Sensitive
CORS Settings (corsSettings)
Description
The settings to allow cross-domain REST calls.
Attributes
Plugin-Link
Optional
Assignable plugins
CSRF Protection (csrfProtection)
Description

If enabled, REST endpoints are protected against CSRF attacks.

With this protection, the REST API only accepts requests that contain the custom header X-Same-Domain with an arbitrary non-empty value. In cross-origin resource sharing (CORS), such requests are not considered simple requests and thus must always be preceded by a preflight request, which prevents cross-site request forgery (CSRF) attacks.

Security warning: Disabling this feature may allow CSRF attacks. Only do so if the REST client is unable to comply with the aforementioned restrictions.

Attributes
Boolean
Optional
Default value
true
Username Transformation (usernameTransformers)
Description
Transforms user name aliases in REST resource URLs into real user names.
Attributes
Plugin-List
Optional
Assignable plugins
Link Response Rewriting Enabled (linkResponseRewritingEnabled)
Description
Enables rewriting of links in REST responses. If rewriting is disabled or cannot be done correctly due to missing information, the internal URI is written to the response.

If a 'Base URI' is configured, links are rewritten according to the configured value. Otherwise, links are rewritten according to the external view provided by the WAF (if configured an a WAF environment cookie is present).

Attributes
Boolean
Optional
Default value
true
Base URI (baseUri)
Description
Allows to change the base URI for all links in REST responses.

This property is useful in test environments where you want links contained in REST responses to be relative to the configured base URI. Note that configuring this property will take precedence over link rewriting based on the WAF environment cookie.

Example:

  • Property value: http://myhost:8090/test
  • The response from the REST call to /<adminapp-uri>/rest/maintenance-messages will contain a link to http://myhost:8090/test/rest/maintenance-messages.

Attributes
String
Optional
Example
https://myhost:8090/test
Default Page Size (defaultPageSize)
Description
The amount of records returned by a resource if the page size is not explicitly specified in the request by the page[limit] query parameter. Must be greater than 0 and smaller than or equal to the 'Max Page Size'.
Attributes
Integer
Optional
Default value
500
Max Page Size (maxPageSize)
Description
The maximum amount of records returned by a pageable resource. Must be greater than or equal to the 'Default Page Size'. This parameter also limits the maximum number of displayed results in some searches of the Adminapp.
Attributes
Integer
Optional
Default value
5000
YAML Template (with default values)

type: AdminappRest
id: AdminappRest-xxxxxx
displayName: 
comment: 
properties:
  baseUri:
  corsSettings:
  csrfProtection: true
  defaultPageSize: 500
  hashFunction:
  hashSharedSecret:
  linkResponseRewritingEnabled: true
  maxPageSize: 5000
  requestAuthentication:
  smsServiceConfig:
  usernameTransformers: