Retrieve a Lambda API
This API is used to retrieve a single Lambda by unique Id or all of the Lambdas.
Request#
OpenAPI Spec
OpenAPI Spec
OpenAPI Spec
Request Parameters#
type String required The lambda type. The possible values are:
AppleReconcileAvailable since1.17.0ClientCredentialsJWTPopulateAvailable since1.28.0EpicGamesReconcileAvailable since1.28.0ExternalJWTReconcileAvailable since1.17.0FacebookReconcileAvailable since1.17.0GoogleReconcileAvailable since1.17.0HYPRReconcileAvailable since1.17.0JWTPopulateLDAPConnectorReconcileAvailable since1.18.0LinkedInReconcileAvailable since1.23.0LoginValidationAvailable since1.53.0MFARequirementAvailable since1.62.0NintendoReconcileAvailable since1.36.0OpenIDReconcileSAMLv2PopulateSAMLv2ReconcileSCIMGroupRequestConverterAvailable since1.36.0SCIMGroupResponseConverterAvailable since1.36.0SCIMUserRequestConverterAvailable since1.36.0SCIMUserResponseConverterAvailable since1.36.0SelfServiceRegistrationValidationAvailable since1.43.0SonyPSNReconcileAvailable since1.28.0SteamReconcileAvailable since1.28.0TwitchReconcileAvailable since1.28.0TwitterReconcileAvailable since1.17.0UserInfoPopulateAvailable since1.50.0XboxReconcileAvailable since1.28.0
lambdaId UUID optional The unique Id of the Lambda to retrieve.
Response#
The response for this API contains either a single Lambda or all of the Lambdas. When you call this API with an Id the response will contain a single Lambda. When you call this API without an Id the response will contain all of the Lambdas. Both response types are defined below along with an example JSON response.
Response Codes| Code | Description |
|---|---|
| 200 | The request was successful. The response will contain a JSON body. |
| 400 | The request was invalid and/or malformed. The response will contain an Errors JSON Object with the specific errors. This status will also be returned if a paid FusionAuth license is required and is not present. |
| 401 | You did not supply a valid Authorization header. The header was omitted or your API key was not valid. The response will be empty. See Authentication. |
| 404 | The object you requested doesn't exist. The response will be empty. |
| 500 | There was an internal error. A stack trace is provided and logged in the FusionAuth log files. The response will be empty. |
Response Body#
lambda.body String The lambda function body, a JavaScript function.
lambda.debug Boolean Whether or not debug event logging is enabled for this Lambda.
lambda.enabled Boolean Deprecated This value is not used, and may be removed in a future version.
lambda.engineType String The JavaScript execution engine for the lambda. The possible values are:
GraalJSNashornDeprecated since1.35.0, Removed in1.49.0
lambda.id UUID The Id of the Lambda.
lambda.insertInstant Long The instant that the lambda created.
lambda.lastUpdateInstant Long The instant that the lambda was last updated.
lambda.name String The name of the lambda.
lambda.type String The lambda type. The possible values are:
AppleReconcileClientCredentialsJWTPopulateEpicGamesReconcileExternalJWTReconcileFacebookReconcileGoogleReconcileHYPRReconcileJWTPopulateLDAPConnectorReconcileLinkedInReconcileLoginValidationMFARequirementNintendoReconcileOpenIDReconcileSAMLv2PopulateSAMLv2ReconcileSCIMGroupRequestConverterSCIMGroupResponseConverterSCIMUserRequestConverterSCIMUserResponseConverterSelfServiceRegistrationValidationSonyPSNReconcileSteamReconcileTwitchReconcileTwitterReconcileUserInfoPopulateXboxReconcile
Example Response JSON
{
"lambda": {
"id": "7e66bac3-fa41-47fb-b8fd-12b35b5e1807",
"body": "function reconcile(user, registration, samlResponse) { registration.roles = samlResponse.assertion.attributes['roles'] || [];}",
"name": "Name",
"debug": false,
"enabled": true,
"engineType": "GraalJS",
"insertInstant": 1572469040579,
"lastUpdateInstant": 1595361143101,
"type": "SAMLv2Reconcile"
}
}Response Body#
lambdas Array The list of Lambda objects.
lambdas[x].body String The lambda function body, a JavaScript function.
lambdas[x].debug Boolean Whether or not debug event logging is enabled for this Lambda.
lambdas[x].enabled Boolean Deprecated This value is not used, and may be removed in a future version.
lambdas[x].engineType String The JavaScript execution engine for the lambda. The possible values are:
GraalJSNashornDeprecated since1.35.0, Removed in1.49.0
lambdas[x].id UUID The Id of the Lambda.
lambdas[x].insertInstant Long The instant that the lambda created.
lambdas[x].lastUpdateInstant Long The instant that the lambda was last updated.
lambdas[x].name String The name of the lambda.
lambdas[x].type String The lambda type. The possible values are:
AppleReconcileClientCredentialsJWTPopulateEpicGamesReconcileExternalJWTReconcileFacebookReconcileGoogleReconcileHYPRReconcileJWTPopulateLDAPConnectorReconcileLinkedInReconcileLoginValidationMFARequirementNintendoReconcileOpenIDReconcileSAMLv2PopulateSAMLv2ReconcileSCIMGroupRequestConverterSCIMGroupResponseConverterSCIMUserRequestConverterSCIMUserResponseConverterSelfServiceRegistrationValidationSonyPSNReconcileSteamReconcileTwitchReconcileTwitterReconcileUserInfoPopulateXboxReconcile
Example Response JSON for Lambda Search
{
"lambdas": [
{
"id": "7e66bac3-fa41-47fb-b8fd-12b35b5e1807",
"body": "function reconcile(user, registration, samlResponse) { registration.roles = samlResponse.assertion.attributes['roles'] || [];}",
"name": "SAML Reconcile",
"debug": false,
"enabled": true,
"engineType": "GraalJS",
"insertInstant": 1572469040579,
"lastUpdateInstant": 1595361143101,
"type": "SAMLv2Reconcile"
}
],
"total": 1
}Example Response JSON
{
"lambdas": [
{
"id": "7e66bac3-fa41-47fb-b8fd-12b35b5e1807",
"body": "function reconcile(user, registration, samlResponse) { registration.roles = samlResponse.assertion.attributes['roles'] || [];}",
"name": "Name",
"debug": false,
"enabled": true,
"engineType": "GraalJS",
"insertInstant": 1572469040579,
"lastUpdateInstant": 1595361143101,
"type": "SAMLv2Reconcile"
}
]
}