---
title: "Instant Auth"
method: POST
path: "/api/v1/instant_auth"
---

# Instant Auth

`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`

Create instant login URLs for your employees

## Headers

- `Content-Type` string

## Request body

- object
  - `email` string, required: Email address of the user
  - `redirect_to` string: A relative WorkRamp URL to redirect the user to after login
  - `name` string: Full name of the user
  - `isAdmin` boolean: Is the user an admin?
  - `isManager` boolean: Is the user a manager?
  - `customAttributes` object: A mapping of api_name->value for custom attributes to set for the user
    - `key` string: API key for this custom attribute
    - `value` string: Value to set this custom attribute to
  - `groups` integer[]: IDs of groups that the user should be added to
  - `managers` integer[]: IDs of managers that the user should be managed by
  - `managerEmails` string[]: Email addresses of managers that the user should be managed by (managers takes precedence)
  - `managerNames` string[]: Names of managers that the user should be managed by (managers and manager_emails take precedence)

## Response `200`

200

- object
  - `url` string

## Other responses

- `400`: 400

---

[API](https://skmtc.dev/workramp/apis/json-api.md) - [All operations](https://skmtc.dev/workramp/apis/json-api/llms.txt) - [OpenAPI document](https://skmtc.dev/workramp/apis/json-api/revisions/2cb77bf12793?raw)