JumpCloud: start sign-in

Overview

Redirect the user to begin JumpCloud sign-in.

Use this when the user clicks sign in.

You'll need JumpCloud configured for your partner.

The user is sent through JumpCloud and returned signed in: JumpCloud sends them back to JumpCloud: callback, and the dashboard then redeems the one-time code with JumpCloud: exchange the code.

Open this URL in the browser (a link or a full-page navigation), not with fetch or XHR: the response is a redirect, and the sign-in state is kept in a session cookie. Check which sign-in methods an email can use returns this URL as sso_url.

Prerequisites

• None. The user must have JumpCloud sign-in turned on; that's checked at the callback.

Base URL

Endpoint

GET /api/v1/auth/sso/jumpcloud/redirect

Authentication

Public (no token)

• Nobody is identified at this step; it only sends the browser to JumpCloud.
• Who can sign in is checked at the callback: users with JumpCloud sign-in turned on, whose company is a partner, an account or a location.

Rate limit

10 requests per minute, counted per client IP address. See Rate limits.

Request parameters

None.

Request body

None.

Request payload

None.

Response body

None. The response is a 302 redirect to JumpCloud's sign-in page, asking for the openid, profile and email scopes.

Response payload

HTTP/1.1 302 Found
Location: https://oauth.id.jumpcloud.com/oauth2/auth?client_id=<client_id>&redirect_uri=https%3A%2F%2Fproduction-api.shoutaboutus.com%2Fapi%2Fv1%2Fauth%2Fsso%2Fjumpcloud%2Fcallback&scope=openid%2Cprofile%2Cemail&response_type=code&state=<state>

Examples

Success payload

See Response payload.

Error payload

429 Too many requests

{
  "message": "Too Many Attempts."
}

Example request

curl --request GET \
  --url "https://production-api.shoutaboutus.com/api/v1/auth/sso/jumpcloud/redirect" \
  --header 'Accept: application/json'