See also
GET
/user/{id}/assets/{assetIds}GET
/user/{id}/assetsGET
/asset/{id}/users/countPOST
/user/{id}/asset/{assetId}DELETE
/user/{id}/asset/{assetId}
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/{id}/asset/{assetId}
id | required path parameterID of the user to associate data with |
---|---|
assetId | required path parameterThe asset id. Max length is 255 bytes. |
Example request
cURL
curl https://login.schibsted.com/api/2/user/1337/asset/vg-pluss-slik-er-skam-stjernene -G \
-d "oauth_token=[access token]"
Java
SpidOAuthToken token = spidClient.getUserToken(code);
String responseJSON = spidClient.
GET(token, "/user/1337/asset/vg-pluss-slik-er-skam-stjernene").
getResponseBody();
This example is an excerpt, see a full example
PHP
<?php
$client->auth();
echo var_dump($client->api("/user/1337/asset/vg-pluss-slik-er-skam-stjernene"));
This example is an excerpt, see a full example
Clojure
(ns example
(:require [spid-client-clojure.core :as spid]))
(let [client (spid/create-client "[client-id]" "[secret]")
token (spid/create-user-token client "[code]")]
(spid/GET client token "/user/1337/asset/vg-pluss-slik-er-skam-stjernene"))
Response
This endpoint supports the JSON response format.
Success: 200 OK
Returns true if the user has access.
Asset Access
Defines user access to the asset.
merchantId ✓ | integer (as string)The ID of the merchant the client belongs to |
---|---|
uuid ✓ | stringUser identifier |
userId ✓ | integer (as string)User identifier |
assetId ✓ | assetIdAsset identifier |
accessUntil | date-timeAccess expiration date |
status ✓ | Asset Access statusAsset access current status |
updated ✓ | date-timeThe time the access was last updated |
created ✓ | date-timeThe time the access was created |
The check mark ✓ indicates that the field always contains a valid non-empty value.
Asset Access status
An enum, with the following possible values:
| Deleted |
---|---|
| Active |
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.
- 400 Bad Request Multiple ids provided
- 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 User does not have access
- 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
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.