Admin Portal SSO - Stytch Docs

AdminPortalSSO is a drop-in component for the Organization settings page in your application. It allows Organization Members with the required RBAC roles (ie. admin) to manage SSO connections for their Organization. AdminPortalSSO must be wrapped inside a StytchB2BProvider. Take a look at our installation guide for more information on how to configure the StytchB2BProvider for your framework.

Props

styles

object

The style configuration allows you to customize the look of the Admin Portal. You can specify some of them or none at all. We’ll use our defaults for the ones you don’t specify.

Show properties

container

object

The configuration object for the Admin Portal container.

Show properties

backgroundColor

string

The background color of the Admin Portal container.

borderColor

string

The border color of the Admin Portal container.

borderRadius

string

The border radius of the Admin Portal container.

width

string

The width of the Admin Portal container.

colors

object

The configuration object for colors used in the Admin Portal.

Show properties

primary

string

Your primary brand color. This will be applied to most of the text in the Admin Portal.

secondary

string

Your secondary brand color. This will be applied to text disclaimers and other visual elements.

success

string

A success color to be used in visual elements.

error

string

An error color to be used in visual elements.

accentText

string

The text color for accent elements. This will be used for tags and select chips in the Admin Portal.

accent

string

An accent color to be used in visual elements. This will be applied to the background of tags and select chips in the Admin Portal.

subtle

string

The color used for miscellaneous elements that don’t require visual elements, like dividers and table, popover menu, and accordion borders.

buttons

object

The configuration object for buttons in the Admin Portal.

Show properties

primary

object

The configuration object for primary buttons.

Show properties

backgroundColor

string

The background color of the primary button.

textColor

string

The text color of the primary button.

borderColor

string

The border color of the primary button.

borderRadius

string

The border radius of the primary button.

secondary

object

The configuration object for secondary buttons.

Show properties

backgroundColor

string

The background color of the secondary button.

textColor

string

The text color of the secondary button.

borderColor

string

The border color of the secondary button.

borderRadius

string

The border radius of the secondary button.

disabled

object

The configuration object for disabled buttons.

Show properties

backgroundColor

string

The background color of the disabled button.

textColor

string

The text color of the disabled button.

borderColor

string

The border color of the disabled button.

borderRadius

string

The border radius of the disabled button.

inputs

object

The configuration object for text inputs in the Admin Portal.

Show properties

backgroundColor

string

The background color of the text inputs.

textColor

string

The text color of the text inputs.

placeholderColor

string

The color of the placeholder text in the text inputs.

borderColor

string

The border color of the text inputs.

borderRadius

string

The border radius of the text inputs.

fontFamily

string

The font family that will apply to text in the Admin Portal.

borderRadius

string

The default border radius for elements in the Admin Portal.

config

object

The configuration object for the Admin Portal SSO UI.

Show properties

getRoleDisplayName

(role: Role) => string

A function that returns the display name for a role. By default, the role.role_id is used as the display name.

getRoleDescription

(role: Role) => string

A function that returns the description for a role. By default, the role.description is used as is.

getRoleSortOrder

(roles: Role[]) => string[]

A function that determines the sort order of the roles. Returns a list of role IDs in the desired order.

The URL used when testing SSO connections via the test button on the SSO Connection Details screen. If this value is not passed, the default login_redirect_url that you set in your Dashboard is used.

The URL used when testing SSO connections via the test button on the SSO Connection Details screen. If this value is not passed, the default signup_redirect_url that you set in your Dashboard is used.

​Props

Props