Documentation Powered by ReDoc

Altair SLC Hub User Preferences (2024.0.0)

Download OpenAPI specification:Download

Authentication

bearerAuth

Security Scheme Type HTTP
HTTP Authorization Scheme bearer
Bearer format "JWT"

Returns all preference values for the calling user

Authorizations:
bearerAuth

Responses

Response samples

Content type
application/json
{
  • "property1": {
    },
  • "property2": {
    }
}

Returns the value of a specific preference for the calling user

Authorizations:
bearerAuth
path Parameters
preferenceName
required
string

The name of the preference. This must be passed as a single URL path element, so any forward slashes must be URL encoded. OpenAPI generated clients will do this automatically

Responses

Response samples

Content type
application/json
{
  • "value": null
}

Sets the value of a preference for the calling user

Authorizations:
bearerAuth
path Parameters
preferenceName
required
string

The name of the preference. This must be passed as a single URL path element, so any forward slashes must be URL encoded. OpenAPI generated clients will do this automatically

Request Body schema: application/json
value
required
any

Responses

Request samples

Content type
application/json
{
  • "value": null
}

Deletes a specific preference for the calling user

Authorizations:
bearerAuth
path Parameters
preferenceName
required
string

The name of the preference. This must be passed as a single URL path element, so any forward slashes must be URL encoded. OpenAPI generated clients will do this automatically

Responses