BEbeyondidentity
Themes

Create a New Theme

To create a theme, send a POST request to /v1/tenants/$TENANT_ID/realms/$REALM_ID/themes/$THEME_ID. Values in the request body for read-only fields will be ignored. All non-read-only fields are optional and will be populated with defaults if unspecified. Currently, each realm only supports a single theme. If a theme already exists for the realm, you will receive a 409 error.

post/v1/tenants/{tenant_id}/realms/{realm_id}/themes

Request

Path parameters

tenant_idstring required
Example:000176d94fd7b4d1

A unique identifier for a tenant.

realm_idstring required
Example:19a95130480dfa79

A unique identifier for a realm.

Request body

Example request

{
  "theme": {
    "id": "88ef08fb-c3f9-44e2-b174-fbb239e1dc47",
    "tenant_id": "0001b42d80372976",
    "realm_id": "7df92e4a38ba0993",
    "create_time": "2022-07-28T18:00:00.000Z",
    "update_time": "2022-07-30T16:00:00.000Z",
    "email_realm_name": "Realm Administrators",
    "logo_url_light": "https://example.com/logo_url_light.png",
    "logo_url_dark": "https://example.com/logo_url_dark.png",
    "support_url": "https://example.com/support",
    "button_color": "#4673D3",
    "button_text_color": "#FFFFFF"
  }
}

Response

The response will be a JSON object containing the standard attributes associated with a theme.

idstring

A unique identifier for a theme. This is automatically generated on creation. This field is immutable and read-only. This field is unique within the realm.

tenant_idstring

A unique identifier for the theme's tenant. This is automatically set on creation. This field is immutable and read-only.

realm_idstring

A unique identifier for the theme's realm. This is automatically set on creation. This field is immutable and read-only.

create_timestring date-time

Timestamp of when the theme was created. This field is immutable and read-only.

update_timestring date-time

Timestamp of when the theme was last updated. This field is read-only.

email_realm_namestring

Realm name that is used in email templates.

logo_url_lightstring

URL for resolving the logo image for light mode.

logo_url_darkstring

URL for resolving the logo image for dark mode.

support_urlstring url

URL for the customer support portal.

button_colorstring

Hexadecimal color code to use for buttons.

button_text_colorstring

Hexadecimal color code to use for button text.

Example response

{
  "id": "88ef08fb-c3f9-44e2-b174-fbb239e1dc47",
  "tenant_id": "0001b42d80372976",
  "realm_id": "7df92e4a38ba0993",
  "create_time": "2022-07-28T18:00:00.000Z",
  "update_time": "2022-07-30T16:00:00.000Z",
  "email_realm_name": "Realm Administrators",
  "logo_url_light": "https://example.com/logo_url_light.png",
  "logo_url_dark": "https://example.com/logo_url_dark.png",
  "support_url": "https://example.com/support",
  "button_color": "#4673D3",
  "button_text_color": "#FFFFFF"
}

Changes

No recorded changes to this operation across all 2 revisions of this API.