How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Okta Brand API

The Brand API from Okta — 15 operation(s) for brand.

Okta Brand API is one of 28 APIs that Okta publishes on the APIs.io network, described by a machine-readable OpenAPI specification and an AsyncAPI event-driven specification.

This API exposes 4 JSON Schema definitions.

Tagged areas include Brand. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an AsyncAPI specification, authentication docs, rate-limit docs, a JSON-LD context, and 4 JSON Schemas.

This API exposes 24 operations across 15 paths, and defines 13 schemas. It is described by OpenAPI 3.0.1, at version 2.16.0.

Requests are made against a single base URL, https://your-subdomain.okta.com/.

24 operations 15 paths 13 schemas 5 DELETE11 GET5 POST3 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.1
API Version
2.16.0
Base URL
https://your-subdomain.okta.com
Authentication
API Key
License
Terms of Service
Resource Areas
1

Authentication & Security 1

Okta Brand API declares 1 security scheme for authenticating requests. An API key is passed in the header as Authorization (api_token).

  • api_token — SSWS {API Token}

Paths & Operations 24

Across 15 paths, the API surfaces 24 operations — 5 DELETE, 11 GET, 5 POST, 3 PUT. Each is listed below with its method, path, parameters, and response codes.

Brand 24
GET
/api/v1/brands
Okta List Brands
listBrands → 200
GET
/api/v1/brands/{brandId}
Okta Get Brand
getBrand 1 param → 200404
PUT
/api/v1/brands/{brandId}
Okta Update Brand
updateBrand 1 param body → 200400
GET
/api/v1/brands/{brandId}/templates/email
Okta List Email Templates
listEmailTemplates 3 params → 200
GET
/api/v1/brands/{brandId}/templates/email/{templateName}
Okta Get Email Template
getEmailTemplate 2 params → 200
GET
/api/v1/brands/{brandId}/templates/email/{templateName}/customizations
Okta List Email Template Customization
listEmailTemplateCustomizations 2 params → 200
POST
/api/v1/brands/{brandId}/templates/email/{templateName}/customizations
Okta Create Email Template Customization
createEmailTemplateCustomization 2 params body → 200409
DELETE
/api/v1/brands/{brandId}/templates/email/{templateName}/customizations
Okta Delete Email Template Customization
deleteEmailTemplateCustomizations 2 params → 204
GET
/api/v1/brands/{brandId}/templates/email/{templateName}/customizations/{customizationId}
Okta Get Email Template Customization
getEmailTemplateCustomization 3 params → 200
PUT
/api/v1/brands/{brandId}/templates/email/{templateName}/customizations/{customizationId}
Okta Update Email Customization
updateEmailTemplateCustomization 3 params body → 200409
DELETE
/api/v1/brands/{brandId}/templates/email/{templateName}/customizations/{customizationId}
Okta Delete Email Customization
deleteEmailTemplateCustomization 3 params → 204409
GET
/api/v1/brands/{brandId}/templates/email/{templateName}/customizations/{customizationId}/preview
Okta Get Preview Content of Email Customization
getEmailTemplateCustomizationPreview 3 params → 200
GET
/api/v1/brands/{brandId}/templates/email/{templateName}/default-content
Okta Get Default Content of Email Template
getEmailTemplateDefaultContent 2 params → 200
GET
/api/v1/brands/{brandId}/templates/email/{templateName}/default-content/preview
Okta Get Preview of Email Template Default Content
getEmailTemplateDefaultContentPreview 2 params → 200
POST
/api/v1/brands/{brandId}/templates/email/{templateName}/test
Okta Get Preview of Email Template Default Content
sendTestEmail 2 params body → 204
GET
/api/v1/brands/{brandId}/themes
Okta Get Brand Themes
listBrandThemes 1 param → 200
GET
/api/v1/brands/{brandId}/themes/{themeId}
Okta Get a theme for a brand
getBrandTheme 2 params → 200
PUT
/api/v1/brands/{brandId}/themes/{themeId}
Okta Update a theme for a brand
updateBrandTheme 2 params body → 200400404
POST
/api/v1/brands/{brandId}/themes/{themeId}/background-image
Okta Updates the background image for your Theme
uploadBrandThemeBackgroundImage 2 params body → 201400404
DELETE
/api/v1/brands/{brandId}/themes/{themeId}/background-image
Okta Deletes a Theme background image
deleteBrandThemeBackgroundImage 2 params → 204404
POST
/api/v1/brands/{brandId}/themes/{themeId}/favicon
Okta Updates the favicon for your theme
uploadBrandThemeFavicon 2 params body → 201400404
DELETE
/api/v1/brands/{brandId}/themes/{themeId}/favicon
Deletes a Theme favicon. The org then uses the Okta default favicon.
deleteBrandThemeFavicon 2 params → 204404
POST
/api/v1/brands/{brandId}/themes/{themeId}/logo
Okta Update a themes logo
uploadBrandThemeLogo 2 params body → 200400404
DELETE
/api/v1/brands/{brandId}/themes/{themeId}/logo
Deletes a Theme logo. The org then uses the Okta default logo.
deleteBrandThemeLogo 2 params → 204404

Schemas 13

The contract defines 13 schemas that model the data the API accepts and returns. The most detailed are ThemeResponse (13 properties), Theme (10 properties), EmailTemplateCustomization (8 properties), Brand (5 properties). Each schema is shown below with its type and property counts.

EmailTemplateCustomization
object
8 properties
EmailTemplateTouchPointVariant
string
EmailTemplateContent
object
5 properties
SignInPageTouchPointVariant
string
EndUserDashboardTouchPointVariant
string
Brand
object
5 properties
EmailTemplate
object
2 properties
EmailTemplateCustomizationRequest
object
4 properties
EmailTemplateTestRequest
object
1 property
ImageUploadResponse
object
1 property
Theme
object
10 properties
ErrorPageTouchPointVariant
string
ThemeResponse
object
13 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

okta-brand-api-openapi.yml Raw ↑

Other APIs Okta publishes across the network.

Cross-App Access (XAA)
Okta for AI Agents
Okta Application API
Okta Authenticator API
Okta AuthorizationServer API
Okta Domain API
Okta EventHook API
Okta Feature API
Okta Group API
Okta GroupSchema API
Okta IdentityProvider API
Okta InlineHook API
Where this information came from

This is an independent, third-party profile of Okta Brand API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.