See api-docs Menu
  1. Home >
  2. API >
  3. 1 >
  4. Invite Links >
  5. Send Invite Link

Send Invite Link

Send an invite link to an existing user in your OneLogin account.

The user clicks the link to set their password and access your OneLogin portal.

Resource URL

https://<subdomain>/api/1/invites
/send_invite_link

Header Parameters

Authorization

required

string

Set to bearer:<access_token>.

Set <access_token> to the access token you generated using the Generate Token API.

Generate the access token with the API credential pair created using the scope required to call this API. Call this API using the Manage All scope only.

Content-Type

required

string

Set to application/json.

Request Parameters

email

required

string

Set to the user email address to generate an invite link.

The value is case sensitive.

personal_email

string

 To send an invite email to a different address than the one provided in email, provide it here. The invite link is sent to this address instead.

Sample Request Body

{
  "email":"jennifer.hasenfus@mycompany.com",
  "personal_email":"jennifer.hasenfus@mail.com"
}

Sample Response

  • 200 OK
  • 400 Bad Request
  • 401 Unauthorized
{
    "status": {
        "type": "success",
        "message": "Email sent successfully to jennifer.hasenfus@mail.com",
        "error": false,
        "code": 200
    }
}
{
    "status": {
        "type": "bad request",
        "message": "No User exists for input email",
        "error": true,
        "code": 400
    }
}

{
    "status": {
        "type": "bad request",
        "message": "Email Input is in incorrect format",
        "error": true,
        "code": 400
    }
}

{
    "status": {
        "type": "bad request",
        "message": "Email Parameter is missing",
        "error": true,
        "code": 400
    }
}

{
    "status": {
        "error": true,
        "code": 400,
        "type": "bad request",
        "message": "Content Type is not specified or specified incorrectly. 
                    Content-Type header must be set to application/json"
    }
}

Typically, the following error indicates the Authorization header value is missing or incorrectly formatted. The Authorization header value uses this format: bearer:<access_token>.

{
    "status": {
        "error": true,
        "code": 400,
        "type": "bad request",
        "message": "Authorization Information is incorrect"
    }
}

{
    "status": {
        "error": true,
        "code": 400,
        "type": "bad request",
        "message": "Input JSON is not valid"
    }
}

This error indicates an invalid access token.

{
    "status": {
        "error": true,
        "code": 401,
        "type": "Unauthorized",
        "message": "Authentication Failure"
    }
}

The following error indicates that an API with insufficient API credentials generated the access token that made the call. Call this API using the Manage All scope only.

{
    "status": {
        "error": true,
        "code": 401,
        "type": "Unauthorized",
        "message": "Insufficient Permission"
    }
}

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.

Sample cURL Request

Replace sample values indicated by < > with your actual values.

curl "https://<subdomain>/api/1/invites/send_invite_link" \
-X POST \
-H "Authorization: bearer:<access_token>" \
-H "Content-Type: application/json" \
-d '{
    "email":"<user_email>",
    "personal_email":"<user_personal_email>"
}'

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.