Identity Management

GET /user/{userId}/trigger/{trigger}

Requires authentication with server access token.

Trigger a new password or verify email email from SPiD to the user's primary email address.

Help us improve

Did you spot an error? Or maybe you just have a suggestion for how we can improve? Leave us a comment.

Request

GET /api/2/user/{userId}/trigger/{trigger}

userId

required path parameter

The user's uuid or userId (not to be mistaken with the deprecated id).

trigger

required path parameter

What kind of email trigger to send. Currently only two options:

  • emailverification - Sends an email to the user, asking them to verify their email address.
  • newpassword - Sends an email to the user with a link to create a new password. The password reset link is valid for 24 hours.

redirectUri

optional

Where to redirect the user after completing triggered action.

Example request

cURL
Minimal example
curl https://login.schibsted.com/api/2/user/42/trigger/emailverification -G \
   -d "oauth_token=[access token]"
With all parameters
curl https://login.schibsted.com/api/2/user/42/trigger/emailverification -G \
   -d "oauth_token=[access token]" \
   -d "redirectUri=http://somewhere.com/else/"
Java
Minimal example
SpidOAuthToken token = spidClient.getServerToken();
String responseJSON = spidClient.
    GET(token, "/user/42/trigger/emailverification").
    getResponseBody();
With all parameters
Map<String, String> params = new HashMap<>() {{
    put("redirectUri", "http://somewhere.com/else/");
}};

SpidOAuthToken token = spidClient.getServerToken();
String responseJSON = spidClient.
    GET(token, "/user/42/trigger/emailverification", params).
    getResponseBody();

This example is an excerpt, see a full example

PHP
Minimal example
<?php
$client->auth();
echo var_dump($client->api("/user/42/trigger/emailverification"));
With all parameters
<?php
$params = array(
    "redirectUri" => "http://somewhere.com/else/"
);

$client->auth();
echo var_dump($client->api("/user/42/trigger/emailverification", $params));

This example is an excerpt, see a full example

Clojure
Minimal example
(ns example
  (:require [spid-client-clojure.core :as spid]))

(let [client (spid/create-client "[client-id]" "[secret]")
      token (spid/create-server-token client)]
  (spid/GET client token "/user/42/trigger/emailverification"))
With all parameters
(ns example
  (:require [spid-client-clojure.core :as spid]))

(let [client (spid/create-client "[client-id]" "[secret]")
      token (spid/create-server-token client)]
  (spid/GET client token "/user/42/trigger/emailverification" {"redirectUri" "http://somewhere.com/else/"}))

Response

This endpoint supports the JSON and JSON-P response formats.

Success: 201 Created

Returns an indication of whether or not the trigger was sent successfully.

Success indicator

success

boolean

Failure cases

Some HTTP response codes are used for multiple error situations. There is no consistent way to tell these apart, but the error object will contain a textual explanation of the reason for the error. For explanation on OAuth related failures and errors see OAuth authentication failures.

  • 401 Unauthorized You don't have administration rights for this client.
  • 401 Unauthorized Your client doesn't have administration rights for this client.
  • 403 Forbidden Client is not authorized to access this API endpoint. Contact SPiD to request access.
  • 403 Forbidden Requesting IP is not whitelisted
  • 403 Forbidden Access token rejected
  • 404 Not Found Unknown client ID
  • 404 Not Found Client ID mismatch. The client making the request is no the owner of this resource, and does not have administrative privileges for it.
  • 420 Request Ratelimit exceeded

Sample response

JSON
{
  "success": true
}
JSON-P
callback({
  "success": true
});

Comments/feedback

Do you have questions, or just want to contribute some newly gained insight? Want to share an example? Please leave a comment. SPiD reads and responds to every question. Additionally, your experience can help others using SPiD, and it can help us continuously improve our documentation.