Instant Auth

Create instant login URLs for your employees

post/api/v1/instant_auth

Request

  • Base URL
    https://app.workramp.com
  • URL
    https://app.workramp.com/api/v1/instant_auth
  • Auth
    API key in header Authorization

Headers

Content-Typestring

application/json

Request body

emailstring required

Email address of the user

redirect_tostring

A relative WorkRamp URL to redirect the user to after login

namestring

Full name of the user

isAdminboolean

Is the user an admin?

isManagerboolean

Is the user a manager?

groupsinteger[]

IDs of groups that the user should be added to

managersinteger[]

IDs of managers that the user should be managed by

managerEmailsstring[]

Email addresses of managers that the user should be managed by (managers takes precedence)

managerNamesstring[]

Names of managers that the user should be managed by (managers and manager_emails take precedence)

Response

200

urlstring

Example response

{
  "url": "https://random-example.app.workramp.com/instant-login/1234567890abcdef"
}

Changes

No recorded changes to this operation across all 1 revision of this API.