See api-docs Menu
  1. Home >
  2. API >
  3. v1-v3 >
  4. Invite Link >
  5. Generate Invite Link

v1-v3 APIs have been deprecated.

Although these APIs are not shut off yet, all new development with APIs should use the newest version of our API if available, and the version /1 in all other cases. These later versions are based on RESTful principles, secured by OAuth 2.0, and provide JSON messages, search, pagination, sorting, and filtering.

Generate Invite Link

Generates a link you can use to invite a user to your OneLogin instance. The generated link leads to a page where the user can choose a password and then access your OneLogin instance.

Resource URL

Before calling this API, consider using its version /1 equivalent.

https://api.onelogin.com/api/v3/invites/get_invite_link

Parameters

api_key

required

string

 Set to the API key being used to make the call.

email

required

string

 Set to the email address associated with the API key being used to make the call.

Sample Response

  • 200 OK
  • 400 Bad Request
  • 400 Bad Request
{
    "status": {
    "type": "success",
    "message": "Success",
    "error": false,
    "code": 200
    },
    "data": [
    "http://api.onelogin.com/password/reset?token=x111111x11xxx1x1x1111xxxxxx1xx11x1111x11"
    ]
}
<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
    }
}

Response Elements

data

Provides the invite link. Email the link to a user.

The generated link leads to a page where the user can choose a password and then access the OneLogin application.

Sample cURL Request

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}"
}' \
https://api.onelogin.com/api/v3/invites/get_invite_link

Postman Collection

Run In Postman

    Clicking Run in Postman button navigates to the page where you can fork the collection to your workspace. Forking the collection into your workspace will enable you to contribute to the source collection using pull requests. You can also view the collection in a public workspace if you like and even import a copy of the collection using the links present on the screen.

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.