Retrieve the configuration for the hosted UI
The configuration is used to theme the hosted UI.
Path Parameters
- oauth_client_id string required
An OAuth client ID
Header Parameters
- SlashID-OrgID string required
The organization ID
Example: af5fbd30-7ce7-4548-8b30-4cd59cb2aba1
Responses
- 200
- 403
- 404
OK
- application/json
- Schema
- Example (from schema)
Schema
meta object
pagination object
limit integeroffset integertotal_count int64errors object[]
httpcode integermessage stringresult object
dynamicFlowConfig object
Configuration for dynamic flow
dynamicFlowEnabled booleanWhether dynamic flow is enabled
handleTypes string[]The types of handles that can be used to authenticate
logoUrl stringThe URL of the logo to display in the login form
pageBackgroundColor stringThe background color of the page
showBadge booleanWhether to show the SlashID badge
storeLastFactor booleanWhether to store the last factor used for authentication
supportURL stringIf set, the support link will be displayed in the error state
alternativeAuthURL stringIf set, the alternative auth link will be displayed in the self-registration-not-allowed error state
faviconUrl stringThe URL of the favicon to display in the browser tab
pageTitle stringThe title of the page
themeVars object
The SlashID theme CSS variables
property name*
stringtextOverrides object
Text keys and overriden values
property name*
string
{
"meta": {
"pagination": {
"limit": 0,
"offset": 0,
"total_count": 0
}
},
"errors": [
{
"httpcode": 0,
"message": "string"
}
],
"result": {
"dynamicFlowConfig": {},
"dynamicFlowEnabled": true,
"handleTypes": [
"string"
],
"logoUrl": "string",
"pageBackgroundColor": "string",
"showBadge": true,
"storeLastFactor": true,
"supportURL": "string",
"alternativeAuthURL": "string",
"faviconUrl": "string",
"pageTitle": "string",
"themeVars": {},
"textOverrides": {}
}
}
Forbidden
- application/json
- Schema
- Example (from schema)
Schema
meta object
pagination object
limit integeroffset integertotal_count int64errors object[]
httpcode integermessage string
{
"meta": {
"pagination": {
"limit": 0,
"offset": 0,
"total_count": 0
}
},
"errors": [
{
"httpcode": 0,
"message": "string"
}
]
}
Not Found
- application/json
- Schema
- Example (from schema)
Schema
meta object
pagination object
limit integeroffset integertotal_count int64errors object[]
httpcode integermessage string
{
"meta": {
"pagination": {
"limit": 0,
"offset": 0,
"total_count": 0
}
},
"errors": [
{
"httpcode": 0,
"message": "string"
}
]
}