SCIM - options description is contradictory and code does not work

[RichardJECooke]

While busy writing an article for SCIM on #2854, I found that in https://fusionauth.io/docs/extend/code/lambdas/scim-user-request-converter#lambda-structure it says:

options - request options. This object is read-only.
...
You may add or modify anything in the user and options objects.

One of these lines is false and should be changed. Both lines cannot be true.

But either way, I don't see why the request parameter is available in the SCIM User Request Converter Lambda, because it doesn't work.

If you set

function convert(user, options, scimUser) {
options.applicationId = 'e9fdb985-9173-4e01-9d73-ac2d60d1dc8e';
options.disableDomainBlock = false;
options.sendSetPasswordEmail = false;
options.skipVerification = true;

in the lambda, the user still isn't registered for the application.

Additionally, https://fusionauth.io/docs/lifecycle/migrate-users/scim/#adding-registrations says that you can create a registration for a new user in a lambda only by making an HTTP call to the user API in the SCIM User Response Converter Lambda (not Request Converter Lambda), which I'm about to test is possible tomorrow. (And that lambda has no options parameter).

It seems like the options parameter should be removed from the code and documentation, because it does nothing but mislead users.