v1-v3 APIs have been deprecated
Don't worry, these APIs are deprecated, but they aren't shut off yet.
All new development with APIs should use the newest version of our API: /1. API /1 is based on RESTful principles, is secured by OAuth 2.0, and provides JSON messages, search, pagination, sorting, and filtering.
Send Invite Link
Emails a link that invites a user to your OneLogin instance. The link leads to a page where the user can choose a password and then access your OneLogin instance.
Resource URL
https://api.onelogin.com/api/v3/invites/
send_invite_link
Parameters
api_key required string |
Set to the API key being used to make the call. |
required string |
Set to the email address associated with the API key being used to make the call. |
personal_email string |
To email the invite link to an address other than the email value, provide a |
Sample Response
- 200 OK
- 400 Bad Request
- 400 Bad Request
{
"status": {
"type": "success",
"message": "Email sent successfully to email@example.com",
"error": false,
"code": 200
}
<error>
<message>API key is invalid or missing</message>
<code>invalid_or_missing_api_key</code>
</error>
{
"status": {
"type": "bad request",
"message": "No User exists for input email",
"error": true,
"code": 400
}
}
Sample cURL Request
Try it out with a test account first: Start off with using this cURL request with a test OneLogin account and API key. Once you’ve familiarized yourself with the API’s behavior, switch over to using your production OneLogin account and API key.
Be sure to replace placeholder values surrounded by { }
with actual values.
curl -X POST -H "Content-Type: application/json" \
-d '{
"api_key":"{api_key}",
"email":"{email}",
"personal_email":"{personal_email}"
}' \
https://api.onelogin.com/api/v3/invites/send_invite_link
Postman Collection
Try it out with a test account first: Start off with using this Postman Collection with a test OneLogin account and API key. Once you’ve familiarized yourself with the API’s behavior, switch over to using your production OneLogin account and API key.
Be sure to set Postman-specific environment variables indicated by {{ }}
.
Download for the Invite Link API
Have a Question?

Found a problem or a bug? Submit a support ticket.

Looking for walkthroughs or how-to guides on OneLogin's user and admin features? Check out the documentation in our Knowledge Base.

Have a product idea or request? Share it with us in our Ideas Portal.