Skip to content
/
Invite a user to set a pa...

Invite a user to set a password

Request

Sends an invitation to a user to join your identity. Once a user is created using the userCreate operation, an invitation needs to be sent to the user in order to be able to set up the password for the first time. The invitation email, which remains valid for 1 month, will contain a URL having all information required to setup the password via the userInviteConsume.

To give a user that already exists on another identity access to your identity, use userLink instead.

Security
auth_token and api-key
Path
user_idstring(UserId)^[0-9]+$required

The unique identifier for the user.

Headers
idempotency-refstring

A unique call reference generated by the caller that, taking into consideration the payload as well as the operation itself, helps avoid duplicate operations. Idempotency reference uniqueness is maintained for at least 24 hours.

curl -i -X POST \
  'https://sandbox.weavr.io/multi/users/{user_id}/invite' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'api-key: YOUR_API_KEY_HERE' \
  -H 'idempotency-ref: string'

Responses

Success - No Content.

Headers
request-refstringrequired

A request identifier. Providing this reference when contacting our support team will help us investigate your query.

Response
No content