← Back to plugin index

Initial REST API Invocation
Description
Allows the UI to initially invoke the IAM REST API before loading the custom UI itself. This can be used to fetch an authentication challenge for example.
Type name
InitialRestApiInvocation
Class
com.airlock.iam.flow.ui.application.configuration.configurable.InitialRestApiInvocationConfig
May be used by
Custom Configuration-based User Self-Registration UI Custom Configuration-based Authentication UI Custom Configuration-based Self-Service UI Custom Configuration-based Public Self-Service UI
Properties
URL (url)
Description
The URL to call which is relative to IAM's toplevel 'rest' path. For example, when deploying IAM to https://mycompany.com/auth, all REST APIs will be available under https://mycompany.com/auth/rest. The URL to configure is relative to the latter.
Attributes
String
Mandatory
Example
/public/my-company/my-custom-auth-method
Method (method)
Description
The HTTP method to used when calling the URL.
Attributes
String
Optional
Default value
GET
Allowed values
GET, POST, DELETE
YAML Template (with default values) 

type: InitialRestApiInvocation
id: InitialRestApiInvocation-xxxxxx
displayName: 
comment: 
properties:
  method: GET
  url: