Invite new guest user

Prev Next
Post
/identity/users/customerGuest

Invites a user to a specific customer.
Once invited, the target user will receive an email with a link that must be clicked in order to:
   - complete the registration if the invited user is a new user.
   - accept the invitation by performing an explicit login.

Required permissions: READ_GUEST_USER, INVITE_GUEST_USER.

Security
HTTP
Type bearer
Header parameters
X-Servitly-Tenant
stringRequired

The name of the target tenant (e.g. acme).

Query parameters
customerId
stringRequired

The customer identifier where the user must be invited to.

Minimum1.0
Exampleabcd1234
Body parameters

The invited user details.

object
firstName
string

The invited user first name.

lastName
string

The invited user last name.

email
string

The invited user email address.

Responses
201

Invite succeeded.

object
userId
string

The id of the invited user.

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
404

Resource was not found.

object
message
string

The error response.

ExampleResource not found
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