Skip to content
ssoossh

Update the caller's own web UI detail level

PUT
/api/users/me/display
curl --request PUT \
  --url https://example.com/api/users/me/display \
  --header 'Content-Type: application/json' \
  --header 'X-Ssoossh-Key-Secret: <X-Ssoossh-Key-Secret>' \
  --data '{}'

Sets how much of the approval and information pages the caller sees: “simplified” or “advanced”. Stored on the server, so it follows the caller between browsers. The email detail level is separate (see /api/users/me/notifications).

Authorizations

Section titled “Authorizations”

Request Bodyrequired

Section titled “Request Bodyrequired”

The new level

Media typeapplication/json
One of:
object

Responses

Section titled “Responses”

200

Section titled “200”

The level after saving

Media typeapplication/json
object
data
required
object
detail_level
required

DetailLevel is how much of the covered pages this person sees: “simplified” or “advanced”. Stored on the server so it follows the person between browsers; the email level is separate and travels with the notification preferences.

string
Allowed values: simplified advanced simplified advanced simplified advanced simplified advanced simplified advanced simplified advanced
error
string

Example 

{
  "data": {
    "detail_level": "simplified"
  }
}

400

Section titled “400”

Malformed body or an unknown level

Media typeapplication/json
object
data

Data is always null on an error response.

error
required

Error is a human-readable message. Branch on the HTTP status rather than this string; it is for humans and logs.

string
error_code
required

ErrorCode is a machine-readable error classifier. One of the error_code constants from internal/apitypes; use this to decide whether to retry or branch on the failure mode.

string

Example 

{
  "error": "certificate request \"9f1c…\" not found",
  "error_code": "not_found"
}

401

Section titled “401”

No valid session

Media typeapplication/json
object
data

Data is always null on an error response.

error
required

Error is a human-readable message. Branch on the HTTP status rather than this string; it is for humans and logs.

string
error_code
required

ErrorCode is a machine-readable error classifier. One of the error_code constants from internal/apitypes; use this to decide whether to retry or branch on the failure mode.

string

Example 

{
  "error": "certificate request \"9f1c…\" not found",
  "error_code": "not_found"
}

403

Section titled “403”

The session has no user record

Media typeapplication/json
object
data

Data is always null on an error response.

error
required

Error is a human-readable message. Branch on the HTTP status rather than this string; it is for humans and logs.

string
error_code
required

ErrorCode is a machine-readable error classifier. One of the error_code constants from internal/apitypes; use this to decide whether to retry or branch on the failure mode.

string

Example 

{
  "error": "certificate request \"9f1c…\" not found",
  "error_code": "not_found"
}