← Back to plugin index

REST API Invocation
Description
Allows the UI to invoke the IAM REST API.
Type name
RestApiInvocation
Class
com.airlock.iam.flow.ui.application.configuration.configurable.RestApiInvocationConfig
May be used by
Form UI Element Button UI Element
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-endpoint
Example
/protected/self-service/my-endpoint
Method (method)
Description
The HTTP method to used when calling the URL.
Attributes
String
Optional
Default value
POST
Allowed values
GET, POST, PATCH, PUT, DELETE
Without Payload (withoutPayload)
Description
If enabled, no payload/JSON will be sent to the server.
Attributes
Boolean
Optional
Default value
false
YAML Template (with default values) 

type: RestApiInvocation
id: RestApiInvocation-xxxxxx
displayName: 
comment: 
properties:
  method: POST
  url:
  withoutPayload: false