Post
/identity/users/preliminaryRegister
When invoked the user will receive an email with a registration URL.
https://acme.servitly.com/create-new-account/47b09651-526c-46a3-9267-a123b465a691
Note that the last part of the url (47b09651-526c-46a3-9267-a123b465a691) represents the token required by the user registration API.
The token has a duration of 60 minutes.
Security
HTTP
Type bearer
Header parameters
X-Servitly-Tenant
stringRequired
The name of the target tenant (e.g. acme).
Query parameters
apiKey
stringRequired
The API KEY identifying the client.
Example{{apiKey}}
Body parameters
The target email to send the reset password link.
object
email
string
The target user email address to register.
Responses
201
User registration successful triggered.
400
Request data not valid.
object
message
string
The error response.
ExampleBad request
401
User not authenticated.
object
message
string
The error response.
ExampleUser not authenticated
403
User not authorized.
object
message
string
The error response.
ExampleUser not authorized
429
API call rate limit exeeded.
object
message
string
The error response.
ExampleAPI call rate limit exeeded
500
Internal server error.
object
message
string
The error response.
ExampleInternal Server Error