Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

General Information

...

  • Get the user by id or email or username where status is active
  • if not found add it to failed array in response
  • if found continue with the following steps:
    •  check if already invited to this tenant
    • if yes push user to failed array response with reason "User has already been invited."
    • if no, generate pin if code is set to yes 
      • if failed to generate pin push user to failed array response with reason "Failed to generate pin at this."
    • invite the user by updating its allowedTenants
    • send an email to the user with the generated pin 

...

NameSourceMandatoryTypeSpecial FormatDescription
usersBodyYESArrayincludes user object, groups array, and pin object



NameSourceMandatoryTypeSpecial FormatDescription
groupsBodyNOArrayArray of stringsGroups array
pinBodyNOObjectincludes code and allowed parametersPin Object



NameMandatoryTypeDescription
codeYESBooleanset to True to create a random generated code 
allowedYESBoolean

set to True if this user is allowed to start pin code login, and also it will be set to main tenant


userBodyYESObjectIncludes one of id, username, or emailUser Object

One of the following should exist under the user object:


NameMandatoryTypeSpecial FormatDescription
idYESStringN/AUser ID
usernameYESStringN/AUsername
emailYESStringN/AUser Email




Output

...

Response

SOAJS has a unified response. Check out this link to understand more the schema of SOAJS response 

...