Get the users app preferences Beta
Requests the apps preferences for the user identified by the given token.
The preferences may only be returned if the client has the respective scope
or is identified by the clientId
. In order words all clients have their own
preferences namespace, only with the respective scope e.g. user:preferences:read:xyz
a client might be able to read the preferences of a different client.
In case no preferences were ever set an empty object {}
is returned.
Path parameters
-
clientId string
The ID of the client for that the preferences should be read.
Responses
-
200 application/json
Retrieves the persisted preferences
-
401 application/vnd.api+json
OAuth token missing or invalid or a linked identity is missing.
Linked identity missing is a special case where you need to make sure that the user has additionally logged in / authorized with a third-party.
This is not relevant for most use-cases.
The specific error code that identifies a missing linked identity is
missing-linked-identity
Example:
{ "errors": [ { "id": "cbgmhslmp1o9or9kh1p0", "title": "Missing linked identity for authorized access", "detail": "Linked identity is needed to access this resource, please check why the user does not have a linked identity", "status": "401", "code": "missing-linked-identity" } ] }
-
403 application/vnd.api+json
Forbidden
-
404 application/vnd.api+json
Resource not found
-
501 application/vnd.api+json
Internal server error
curl \
-X GET https://api.pace.cloud/user/2024-3/preferences/xyz \
-H "Authorization: Bearer $ACCESS_TOKEN"
{
"some": "value",
"everything": [
{
"is": "up",
"to": 123123,
"the": [
"client"
]
}
]
}
{
"errors": [
{
"id": "string",
"links": {
"about": "string"
},
"status": "string",
"code": "string",
"title": "string",
"detail": "string",
"source": {
"pointer": "string",
"parameter": "string"
},
"meta": {}
}
]
}
{
"errors": [
{
"id": "string",
"links": {
"about": "string"
},
"status": "string",
"code": "string",
"title": "string",
"detail": "string",
"source": {
"pointer": "string",
"parameter": "string"
},
"meta": {}
}
]
}
{
"errors": [
{
"id": "string",
"links": {
"about": "string"
},
"status": "string",
"code": "string",
"title": "string",
"detail": "string",
"source": {
"pointer": "string",
"parameter": "string"
},
"meta": {}
}
]
}
{
"errors": [
{
"id": "string",
"links": {
"about": "string"
},
"status": "string",
"code": "string",
"title": "string",
"detail": "string",
"source": {
"pointer": "string",
"parameter": "string"
},
"meta": {}
}
]
}