POST

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

{
    "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