Skip to main content

PartnerConfig

namestring

Name of the partner.

user_typestring

Type of user account associated with the partner configuration.

uris object

Branded URLs for the partner portal (console, docs, API, and related links).

authstring

Authentication service URL.

docstring

Documentation site URL.

api_docstring

API reference documentation URL.

consolestring

Web console URL.

api_uristring

Base URL of the API.

landing_pagestring

Marketing landing page URL.

contact_usstring

Contact or support page URL.

support_emailstring

Support contact email address for the partner.

logos object

Logo image URLs for the partner branding.

lightstring

URL of the logo image used on light backgrounds.

darkstring

URL of the logo image used on dark backgrounds.

emailstring

User email address.

faviconstring

URL of the favicon image.

background_image_urlstring

URL of the background image used in the partner portal.

colors object

Brand color palette for the partner portal.

primary object

Primary brand colors for light and dark modes.

lightstring

Primary brand color used in light mode, as a hex value.

darkstring

Primary brand color used in dark mode, as a hex value.

secondary object

Secondary brand colors for light and dark modes.

lightstring

Secondary brand color used in light mode, as a hex value.

darkstring

Secondary brand color used in dark mode, as a hex value.

PartnerConfig
{
"name": "string",
"user_type": "string",
"uris": {
"auth": "string",
"doc": "string",
"api_doc": "string",
"console": "string",
"api_uri": "string",
"landing_page": "string",
"contact_us": "string"
},
"support_email": "string",
"logos": {
"light": "string",
"dark": "string",
"email": "string",
"favicon": "string"
},
"background_image_url": "string",
"colors": {
"primary": {
"light": "string",
"dark": "string"
},
"secondary": {
"light": "string",
"dark": "string"
}
}
}