Skip to main content

Modify 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
  • SlashID-Required-Consistency string

    Possible values: [local_region, all_regions]

    Default value: local_region

    The consistency level required for this request. If the consistency level is not achieved within the timeout, the request will fail with a 408 Request Timeout error. 408 Request Timeout error indicates that request was not handled within the timeout, but it may still be handled after request timeout. Allowed values: * local_region: Wait while the request executes in the local region. * all_regions: Wait while the request executes across all regions. You can learn more about our replication model on our Cross-region Replication Model page.

  • SlashID-Required-Consistency-Timeout integer

    Possible values: >= 1 and <= 120

    Default value: 30

    The maximum amount of seconds to wait for the requested consistency level to be achieved. If the consistency level is not achieved within this time, the request will fail with a 408 Request Timeout error. 408 Request Timeout error indicates that request was not handled within the timeout, but it may still be handled after request timeout. You can learn more about our replication model on our Cross-region Replication Model page.

Request Body
  • dynamicFlowConfig object

    Configuration for dynamic flow

  • dynamicFlowEnabled boolean

    Whether dynamic flow is enabled

  • handleTypes string[]

    The types of handles that can be used to authenticate

  • logoUrl string

    The URL of the logo to display in the login form

  • pageBackgroundColor string

    The background color of the page

  • showBadge boolean

    Whether to show the SlashID badge

  • storeLastFactor boolean

    Whether to store the last factor used for authentication

  • supportURL string

    If set, the support link will be displayed in the error state

  • alternativeAuthURL string

    If set, the alternative auth link will be displayed in the self-registration-not-allowed error state

  • faviconUrl string

    The URL of the favicon to display in the browser tab

  • pageTitle string

    The title of the page

  • themeVars object

    The SlashID theme CSS variables

  • property name* string
  • textOverrides object

    Text keys and overriden values

  • property name* string
Responses

Created

Schema
  • meta object
  • pagination object
  • limit integer
  • offset integer
  • total_count int64
  • errors object[]
  • httpcode integer
  • message string
  • result object
  • dynamicFlowConfig object

    Configuration for dynamic flow

  • dynamicFlowEnabled boolean

    Whether dynamic flow is enabled

  • handleTypes string[]

    The types of handles that can be used to authenticate

  • logoUrl string

    The URL of the logo to display in the login form

  • pageBackgroundColor string

    The background color of the page

  • showBadge boolean

    Whether to show the SlashID badge

  • storeLastFactor boolean

    Whether to store the last factor used for authentication

  • supportURL string

    If set, the support link will be displayed in the error state

  • alternativeAuthURL string

    If set, the alternative auth link will be displayed in the self-registration-not-allowed error state

  • faviconUrl string

    The URL of the favicon to display in the browser tab

  • pageTitle string

    The title of the page

  • themeVars object

    The SlashID theme CSS variables

  • property name* string
  • textOverrides object

    Text keys and overriden values

  • property name* string