The Brands API allows you to customize the look and feel of pages and templates, such as the Okta-hosted sign-in page, error pages, email templates, and the Okta End-User Dashboard.
Each new org contains Okta default branding. You can upload your own assets (colors, background image, logo, and favicon) to replace the default assets and publish these assets directly to your pages and templates.
okta.brands.read
Lists all the brands in your org
expand | Array of strings Specifies additional metadata to be included in the response |
after | string The cursor to use for pagination. It is an opaque string that specifies your current location in the list and is obtained from the |
limit | integer [ 1 .. 200 ] Default: 20 A limit on the number of objects to return |
q | string Searches the records for matching value |
OK
Forbidden
Too Many Requests
[- {
- "id": "bnd114iNkrcN6aR680g4",
- "name": "Okta Default",
- "isDefault": true,
- "removePoweredByOkta": false,
- "customPrivacyPolicyUrl": null,
- "locale": "en",
- "emailDomainId": "OeD114iNkrcN6aR680g4",
- "defaultApp": {
- "appInstanceId": "0oa114iNkrcN6aR680g4",
- "appLinkName": null,
- "classicApplicationUri": null
}, - "_links": {
- "self": {
- "hints": {
- "allow": [
- "GET",
- "PUT",
- "DELETE"
]
}
}, - "themes": {
- "hints": {
- "allow": [
- "GET"
]
}
}
}
}
]
okta.brands.manage
Creates a new brand in your org
expand | Array of strings Specifies additional metadata to be included in the response |
after | string The cursor to use for pagination. It is an opaque string that specifies your current location in the list and is obtained from the |
limit | integer [ 1 .. 200 ] Default: 20 A limit on the number of objects to return |
q | string Searches the records for matching value |
Created
Bad Request
Forbidden
Too Many Requests
{- "name": "My Awesome Brand"
}
{- "id": "bnd114iNkrcN6aR680g5",
- "removePoweredByOkta": false,
- "customPrivacyPolicyUrl": null,
- "name": "My Awesome Brand",
- "locale": "en",
- "defaultApp": {
- "appInstanceId": "0oa114iNkrcN6aR680g4",
- "appLinkName": null,
- "classicApplicationUri": null
}, - "isDefault": false,
- "_links": {
- "self": {
- "hints": {
- "allow": [
- "GET",
- "PUT",
- "DELETE"
]
}
}, - "themes": {
- "hints": {
- "allow": [
- "GET"
]
}
}
}
}
okta.brands.read
Retrieves a brand by brandId
OK
Forbidden
Not Found
Too Many Requests
{- "id": "bnd114iNkrcN6aR680g4",
- "removePoweredByOkta": false,
- "customPrivacyPolicyUrl": null,
- "name": "Okta Default",
- "isDefault": true,
- "locale": "en",
- "emailDomainId": "OeD114iNkrcN6aR680g4",
- "defaultApp": {
- "appInstanceId": "0oa114iNkrcN6aR680g4",
- "appLinkName": null,
- "classicApplicationUri": null
}, - "_links": {
- "self": {
- "hints": {
- "allow": [
- "GET",
- "PUT",
- "DELETE"
]
}
}, - "themes": {
- "hints": {
- "allow": [
- "GET"
]
}
}
}
}
okta.brands.manage
Replaces a brand by brandId
agreeToCustomPrivacyPolicy | boolean |
customPrivacyPolicyUrl | string |
object (DefaultApp) | |
emailDomainId | string |
locale | string (Language) The language specified as an IETF BCP 47 language tag |
name | string |
removePoweredByOkta | boolean |
OK
Bad Request
Forbidden
Not Found
Too Many Requests
{- "agreeToCustomPrivacyPolicy": true,
- "removePoweredByOkta": true,
- "name": "New Name For Brand",
- "emailDomainId": "OeD114iNkrcN6aR680g4",
- "locale": "en",
- "defaultApp": {
- "appInstanceId": "0oa114iNkrcN6aR680g4",
- "appLinkName": null,
- "classicApplicationUri": null
}
}
{- "id": "bnd114iNkrcN6aR680g4",
- "removePoweredByOkta": true,
- "agreeToCustomPrivacyPolicy": true,
- "name": "New Name For Brand",
- "isDefault": true,
- "emailDomainId": "OeD114iNkrcN6aR680g4",
- "defaultApp": {
- "appInstanceId": "0oa114iNkrcN6aR680g4",
- "appLinkName": null,
- "classicApplicationUri": null
}, - "locale": "en",
- "_links": {
- "self": {
- "hints": {
- "allow": [
- "GET",
- "PUT",
- "DELETE"
]
}
}, - "themes": {
- "hints": {
- "allow": [
- "GET"
]
}
}
}
}
okta.brands.manage
Deletes a brand by brandId
Successfully deleted the brand.
Forbidden
Not Found
Conflict
Too Many Requests
{- "errorCode": "E0000006",
- "errorSummary": "You do not have permission to perform the requested action",
- "errorLink": "E0000006",
- "errorId": "sampleNUSD_8fdkFd8fs8SDBK",
- "errorCauses": [ ]
}
okta.brands.read
Lists all domains associated with a brand by brandId
OK
Forbidden
Not Found
Too Many Requests
[- {
- "brandId": "bndul904tTZ6kWVhP0g3",
- "certificateSourceType": "MANUAL",
- "dnsRecords": [
- {
- "expiration": "string",
- "fqdn": "_oktaverification.login.example.com",
- "recordType": "TXT",
- "values": [
- "79496f234c814638b1cc44f51a782781"
]
}
], - "domain": "login.example.com",
- "id": "OcDz6iRyjkaCTXkdo0g3",
- "publicCertificate": {
- "expiration": "2021-05-11T05:13:05.000Z",
- "fingerprint": "73:68:82:7B:83:2E:48:29:A5:5E:E8:40:41:80:B3:AA:03:C4:42:43:05:73:45:BC:AA:47:00:23:A3:70:E5:C4",
- "subject": "CN=login.example.com"
}, - "validationStatus": "VERIFIED",
- "_links": {
- "self": {
- "hints": {
- "allow": [
- "DELETE"
]
}, - "href": "string",
- "name": "string",
- "type": "string"
}, - "brand": {
- "hints": {
- "allow": [
- "DELETE"
]
}, - "href": "string",
- "name": "string",
- "type": "string"
}, - "certificate": {
- "hints": {
- "allow": [
- "DELETE"
]
}, - "href": "string",
- "name": "string",
- "type": "string"
}, - "verify": {
- "hints": {
- "allow": [
- "DELETE"
]
}, - "href": "string",
- "name": "string",
- "type": "string"
}
}
}
]
okta.brands.read
Retrieves the error page sub-resources. The expand
query parameter specifies which sub-resources to include in the response.
Successfully retrieved the error page.
Forbidden
Not Found
Too Many Requests
{- "_embedded": {
- "default": {
- "pageContent": "string"
}, - "customized": {
- "pageContent": "string"
}, - "preview": {
- "pageContent": "string"
},
}, - "_links": {
- "self": {
- "hints": {
- "allow": [
- "DELETE"
]
}, - "href": "string",
- "name": "string",
- "type": "string"
}, - "default": {
- "hints": {
- "allow": [
- "DELETE"
]
}, - "href": "string",
- "name": "string",
- "type": "string"
}, - "customized": {
- "hints": {
- "allow": [
- "DELETE"
]
}, - "href": "string",
- "name": "string",
- "type": "string"
}, - "preview": {
- "hints": {
- "allow": [
- "DELETE"
]
}, - "href": "string",
- "name": "string",
- "type": "string"
}
}
}
okta.brands.read
Retrieves the customized error page. The customized error page appears in your live environment.
Successfully retrieved the customized error page.
Forbidden
Not Found
Too Many Requests
{- "pageContent": "string",
- "contentSecurityPolicySetting": {
- "mode": "enforced",
- "reportUri": "string",
- "srcList": [
- "string"
]
}
}
okta.brands.manage
Replaces the customized error page. The customized error page appears in your live environment.
Successfully replaced the customized error page.
Bad Request
Forbidden
Not Found
Too Many Requests
{- "pageContent": "string",
- "contentSecurityPolicySetting": {
- "mode": "enforced",
- "reportUri": "string",
- "srcList": [
- "string"
]
}
}
{- "pageContent": "string",
- "contentSecurityPolicySetting": {
- "mode": "enforced",
- "reportUri": "string",
- "srcList": [
- "string"
]
}
}
okta.brands.manage
Deletes the customized error page. As a result, the default error page appears in your live environment.
Successfully deleted the customized error page.
Forbidden
Not Found
Too Many Requests
{- "errorCode": "E0000006",
- "errorSummary": "You do not have permission to perform the requested action",
- "errorLink": "E0000006",
- "errorId": "sampleNUSD_8fdkFd8fs8SDBK",
- "errorCauses": [ ]
}
okta.brands.read
Retrieves the default error page. The default error page appears when no customized error page exists.
Successfully retrieved the default error page.
Forbidden
Not Found
Too Many Requests
{- "pageContent": "string",
- "contentSecurityPolicySetting": {
- "mode": "enforced",
- "reportUri": "string",
- "srcList": [
- "string"
]
}
}
okta.brands.read
Retrieves the preview error page. The preview error page contains unpublished changes and isn't shown in your live environment. Preview it at ${yourOktaDomain}/error/preview
.
Successfully retrieved the preview error page.
Forbidden
Not Found
Too Many Requests
{- "pageContent": "string",
- "contentSecurityPolicySetting": {
- "mode": "enforced",
- "reportUri": "string",
- "srcList": [
- "string"
]
}
}
okta.brands.manage
Replaces the preview error page. The preview error page contains unpublished changes and isn't shown in your live environment. Preview it at ${yourOktaDomain}/error/preview
.
Successfully replaced the preview error page.
Bad Request
Forbidden
Not Found
Too Many Requests
{- "pageContent": "string",
- "contentSecurityPolicySetting": {
- "mode": "enforced",
- "reportUri": "string",
- "srcList": [
- "string"
]
}
}
{- "pageContent": "string",
- "contentSecurityPolicySetting": {
- "mode": "enforced",
- "reportUri": "string",
- "srcList": [
- "string"
]
}
}
okta.brands.manage
Deletes the preview error page. The preview error page contains unpublished changes and isn't shown in your live environment. Preview it at ${yourOktaDomain}/error/preview
.
Successfully deleted the preview error page.
Forbidden
Not Found
Too Many Requests
{- "errorCode": "E0000006",
- "errorSummary": "You do not have permission to perform the requested action",
- "errorLink": "E0000006",
- "errorId": "sampleNUSD_8fdkFd8fs8SDBK",
- "errorCauses": [ ]
}
okta.brands.read
Retrieves the sign-in page sub-resources. The expand
query parameter specifies which sub-resources to include in the response.
Successfully retrieved the sign-in page.
Forbidden
Not Found
Too Many Requests
{- "_embedded": {
- "default": {
- "pageContent": "string"
}, - "customized": {
- "pageContent": "string"
}, - "preview": {
- "pageContent": "string"
},
}, - "_links": {
- "self": {
- "hints": {
- "allow": [
- "DELETE"
]
}, - "href": "string",
- "name": "string",
- "type": "string"
}, - "default": {
- "hints": {
- "allow": [
- "DELETE"
]
}, - "href": "string",
- "name": "string",
- "type": "string"
}, - "customized": {
- "hints": {
- "allow": [
- "DELETE"
]
}, - "href": "string",
- "name": "string",
- "type": "string"
}, - "preview": {
- "hints": {
- "allow": [
- "DELETE"
]
}, - "href": "string",
- "name": "string",
- "type": "string"
}
}
}
okta.brands.read
Retrieves the customized sign-in page. The customized sign-in page appears in your live environment.
Successfully retrieved the customized sign-in page.
Forbidden
Not Found
Too Many Requests
{- "pageContent": "string",
- "contentSecurityPolicySetting": {
- "mode": "enforced",
- "reportUri": "string",
- "srcList": [
- "string"
]
}, - "widgetCustomizations": {
- "signInLabel": "string",
- "usernameLabel": "string",
- "usernameInfoTip": "string",
- "passwordLabel": "string",
- "passwordInfoTip": "string",
- "showPasswordVisibilityToggle": true,
- "showUserIdentifier": true,
- "forgotPasswordLabel": "string",
- "forgotPasswordUrl": "string",
- "unlockAccountLabel": "string",
- "unlockAccountUrl": "string",
- "helpLabel": "string",
- "helpUrl": "string",
- "customLink1Label": "string",
- "customLink1Url": "string",
- "customLink2Label": "string",
- "customLink2Url": "string",
- "authenticatorPageCustomLinkLabel": "string",
- "authenticatorPageCustomLinkUrl": "string",
- "classicRecoveryFlowEmailOrUsernameLabel": "string"
}, - "widgetVersion": "string"
}
okta.brands.manage
Replaces the customized sign-in page. The customized sign-in page appears in your live environment.
pageContent | string |
object (ContentSecurityPolicySetting) | |
object | |
widgetVersion | string (Version) ^(0|[1-9]\d*)\.(0|[1-9]\d*)\.(0|[1-9]\d*)(?:-... The version specified as a Semantic Version. |
Successfully replaced the customized sign-in page.
Bad Request
Forbidden
Not Found
Too Many Requests
{- "pageContent": "string",
- "contentSecurityPolicySetting": {
- "mode": "enforced",
- "reportUri": "string",
- "srcList": [
- "string"
]
}, - "widgetCustomizations": {
- "signInLabel": "string",
- "usernameLabel": "string",
- "usernameInfoTip": "string",
- "passwordLabel": "string",
- "passwordInfoTip": "string",
- "showPasswordVisibilityToggle": true,
- "showUserIdentifier": true,
- "forgotPasswordLabel": "string",
- "forgotPasswordUrl": "string",
- "unlockAccountLabel": "string",
- "unlockAccountUrl": "string",
- "helpLabel": "string",
- "helpUrl": "string",
- "customLink1Label": "string",
- "customLink1Url": "string",
- "customLink2Label": "string",
- "customLink2Url": "string",
- "authenticatorPageCustomLinkLabel": "string",
- "authenticatorPageCustomLinkUrl": "string",
- "classicRecoveryFlowEmailOrUsernameLabel": "string"
}, - "widgetVersion": "string"
}
{- "pageContent": "string",
- "contentSecurityPolicySetting": {
- "mode": "enforced",
- "reportUri": "string",
- "srcList": [
- "string"
]
}, - "widgetCustomizations": {
- "signInLabel": "string",
- "usernameLabel": "string",
- "usernameInfoTip": "string",
- "passwordLabel": "string",
- "passwordInfoTip": "string",
- "showPasswordVisibilityToggle": true,
- "showUserIdentifier": true,
- "forgotPasswordLabel": "string",
- "forgotPasswordUrl": "string",
- "unlockAccountLabel": "string",
- "unlockAccountUrl": "string",
- "helpLabel": "string",
- "helpUrl": "string",
- "customLink1Label": "string",
- "customLink1Url": "string",
- "customLink2Label": "string",
- "customLink2Url": "string",
- "authenticatorPageCustomLinkLabel": "string",
- "authenticatorPageCustomLinkUrl": "string",
- "classicRecoveryFlowEmailOrUsernameLabel": "string"
}, - "widgetVersion": "string"
}
okta.brands.manage
Deletes the customized sign-in page. As a result, the default sign-in page appears in your live environment.
Successfully deleted the sign-in page.
Forbidden
Not Found
Too Many Requests
{- "errorCode": "E0000006",
- "errorSummary": "You do not have permission to perform the requested action",
- "errorLink": "E0000006",
- "errorId": "sampleNUSD_8fdkFd8fs8SDBK",
- "errorCauses": [ ]
}
okta.brands.read
Retrieves the default sign-in page. The default sign-in page appears when no customized sign-in page exists.
Successfully retrieved the default sign-in page.
Forbidden
Not Found
Too Many Requests
{- "pageContent": "string",
- "contentSecurityPolicySetting": {
- "mode": "enforced",
- "reportUri": "string",
- "srcList": [
- "string"
]
}, - "widgetCustomizations": {
- "signInLabel": "string",
- "usernameLabel": "string",
- "usernameInfoTip": "string",
- "passwordLabel": "string",
- "passwordInfoTip": "string",
- "showPasswordVisibilityToggle": true,
- "showUserIdentifier": true,
- "forgotPasswordLabel": "string",
- "forgotPasswordUrl": "string",
- "unlockAccountLabel": "string",
- "unlockAccountUrl": "string",
- "helpLabel": "string",
- "helpUrl": "string",
- "customLink1Label": "string",
- "customLink1Url": "string",
- "customLink2Label": "string",
- "customLink2Url": "string",
- "authenticatorPageCustomLinkLabel": "string",
- "authenticatorPageCustomLinkUrl": "string",
- "classicRecoveryFlowEmailOrUsernameLabel": "string"
}, - "widgetVersion": "string"
}
okta.brands.read
Retrieves the preview sign-in page. The preview sign-in page contains unpublished changes and isn't shown in your live environment. Preview it at ${yourOktaDomain}/login/preview
.
Successfully retrieved the preview sign-in page.
Forbidden
Not Found
Too Many Requests
{- "pageContent": "string",
- "contentSecurityPolicySetting": {
- "mode": "enforced",
- "reportUri": "string",
- "srcList": [
- "string"
]
}, - "widgetCustomizations": {
- "signInLabel": "string",
- "usernameLabel": "string",
- "usernameInfoTip": "string",
- "passwordLabel": "string",
- "passwordInfoTip": "string",
- "showPasswordVisibilityToggle": true,
- "showUserIdentifier": true,
- "forgotPasswordLabel": "string",
- "forgotPasswordUrl": "string",
- "unlockAccountLabel": "string",
- "unlockAccountUrl": "string",
- "helpLabel": "string",
- "helpUrl": "string",
- "customLink1Label": "string",
- "customLink1Url": "string",
- "customLink2Label": "string",
- "customLink2Url": "string",
- "authenticatorPageCustomLinkLabel": "string",
- "authenticatorPageCustomLinkUrl": "string",
- "classicRecoveryFlowEmailOrUsernameLabel": "string"
}, - "widgetVersion": "string"
}
okta.brands.manage
Replaces the preview sign-in page. The preview sign-in page contains unpublished changes and isn't shown in your live environment. Preview it at ${yourOktaDomain}/login/preview
.
pageContent | string |
object (ContentSecurityPolicySetting) | |
object | |
widgetVersion | string (Version) ^(0|[1-9]\d*)\.(0|[1-9]\d*)\.(0|[1-9]\d*)(?:-... The version specified as a Semantic Version. |
Successfully replaced the preview sign-in page.
Bad Request
Forbidden
Not Found
Too Many Requests
{- "pageContent": "string",
- "contentSecurityPolicySetting": {
- "mode": "enforced",
- "reportUri": "string",
- "srcList": [
- "string"
]
}, - "widgetCustomizations": {
- "signInLabel": "string",
- "usernameLabel": "string",
- "usernameInfoTip": "string",
- "passwordLabel": "string",
- "passwordInfoTip": "string",
- "showPasswordVisibilityToggle": true,
- "showUserIdentifier": true,
- "forgotPasswordLabel": "string",
- "forgotPasswordUrl": "string",
- "unlockAccountLabel": "string",
- "unlockAccountUrl": "string",
- "helpLabel": "string",
- "helpUrl": "string",
- "customLink1Label": "string",
- "customLink1Url": "string",
- "customLink2Label": "string",
- "customLink2Url": "string",
- "authenticatorPageCustomLinkLabel": "string",
- "authenticatorPageCustomLinkUrl": "string",
- "classicRecoveryFlowEmailOrUsernameLabel": "string"
}, - "widgetVersion": "string"
}
{- "pageContent": "string",
- "contentSecurityPolicySetting": {
- "mode": "enforced",
- "reportUri": "string",
- "srcList": [
- "string"
]
}, - "widgetCustomizations": {
- "signInLabel": "string",
- "usernameLabel": "string",
- "usernameInfoTip": "string",
- "passwordLabel": "string",
- "passwordInfoTip": "string",
- "showPasswordVisibilityToggle": true,
- "showUserIdentifier": true,
- "forgotPasswordLabel": "string",
- "forgotPasswordUrl": "string",
- "unlockAccountLabel": "string",
- "unlockAccountUrl": "string",
- "helpLabel": "string",
- "helpUrl": "string",
- "customLink1Label": "string",
- "customLink1Url": "string",
- "customLink2Label": "string",
- "customLink2Url": "string",
- "authenticatorPageCustomLinkLabel": "string",
- "authenticatorPageCustomLinkUrl": "string",
- "classicRecoveryFlowEmailOrUsernameLabel": "string"
}, - "widgetVersion": "string"
}
okta.brands.manage
Deletes the preview sign-in page. The preview sign-in page contains unpublished changes and isn't shown in your live environment. Preview it at ${yourOktaDomain}/login/preview
.
Successfully deleted the preview sign-in page.
Forbidden
Not Found
Too Many Requests
{- "errorCode": "E0000006",
- "errorSummary": "You do not have permission to perform the requested action",
- "errorLink": "E0000006",
- "errorId": "sampleNUSD_8fdkFd8fs8SDBK",
- "errorCauses": [ ]
}
okta.brands.read
Lists all sign-in widget versions supported by the current org
Successfully listed the sign-in widget versions.
Forbidden
Not Found
Too Many Requests
[- "string"
]
okta.brands.read
Retrieves the sign-out page settings
Successfully retrieved the sign-out page settings.
Forbidden
Not Found
Too Many Requests
{- "type": "EXTERNALLY_HOSTED",
- "url": "string"
}
okta.brands.manage
Replaces the sign-out page settings
Successfully replaced the sign-out page settings.
Bad Request
Forbidden
Not Found
Too Many Requests
{- "type": "EXTERNALLY_HOSTED",
- "url": "string"
}
{- "type": "EXTERNALLY_HOSTED",
- "url": "string"
}
okta.templates.read
Lists all email templates
after | string The cursor to use for pagination. It is an opaque string that specifies your current location in the list and is obtained from the |
limit | integer [ 1 .. 200 ] Default: 20 A limit on the number of objects to return |
expand | Array of strings Specifies additional metadata to be included in the response |
Successfully returned the list of email templates.
Forbidden
Not Found
Too Many Requests
[- {
- "name": "UserActivation",
- "_links": {
- "self": {
- "hints": {
- "allow": [
- "GET"
]
}
}, - "settings": {
- "hints": {
- "allow": [
- "GET",
- "PUT"
]
}
}, - "defaultContent": {
- "hints": {
- "allow": [
- "GET"
]
}
}, - "customizations": {
- "hints": {
- "allow": [
- "GET",
- "POST",
- "DELETE"
]
}
}, - "test": {
- "hints": {
- "allow": [
- "POST"
]
}
}
}
}
]
okta.templates.read
Retrieves the details of an email template by name
Successfully retrieved the email template.
Forbidden
Not Found
Too Many Requests
{- "name": "UserActivation",
- "_links": {
- "self": {
- "hints": {
- "allow": [
- "GET"
]
}
}, - "settings": {
- "hints": {
- "allow": [
- "GET",
- "PUT"
]
}
}, - "defaultContent": {
- "hints": {
- "allow": [
- "GET"
]
}
}, - "customizations": {
- "hints": {
- "allow": [
- "GET",
- "POST",
- "DELETE"
]
}
}, - "test": {
- "hints": {
- "allow": [
- "POST"
]
}
}
}
}
okta.templates.read
Lists all customizations of an email template
after | string The cursor to use for pagination. It is an opaque string that specifies your current location in the list and is obtained from the |
limit | integer [ 1 .. 200 ] Default: 20 A limit on the number of objects to return |
Successfully retrieved all email customizations for the specified email template.
Forbidden
Not Found
Too Many Requests
[- {
- "language": "en",
- "isDefault": true,
- "subject": "Welcome to ${org.name}!",
- "body": "<!DOCTYPE html><html><body><p>Hello, ${user.profile.firstName}. Click <a href=\"${activationLink}\">here</a> to activate your account.</body></html>",
- "id": "oel11u6DqUiMbQkpl0g4",
- "created": "2021-11-09T20:38:10.000Z",
- "lastUpdated": "2021-11-11T20:38:10.000Z",
- "_links": {
- "self": {
- "hints": {
- "allow": [
- "GET",
- "PUT",
- "DELETE"
]
}
}, - "template": {
- "hints": {
- "allow": [
- "GET"
]
}
}, - "preview": {
- "hints": {
- "allow": [
- "GET"
]
}
}, - "test": {
- "hints": {
- "allow": [
- "POST"
]
}
}
}
}
]
okta.templates.manage
Creates a new email customization
body required | string The email's HTML body. May contain variable references. |
subject required | string The email's subject. May contain variable references. |
isDefault | boolean Whether this is the default customization for the email template. Each customized email template must have exactly one default customization. Defaults to |
language required | string (Language) The language specified as an IETF BCP 47 language tag |
Successfully created the email customization.
Bad Request
Forbidden
Not Found
Could not create the email customization because it conflicts with an existing email customization.
Too Many Requests
{- "language": "fr",
- "subject": "Bienvenue dans ${org.name}!",
- "body": "<!DOCTYPE html><html><body><p>Bonjour ${user.profile.firstName}. <a href=\"${activationLink}\">Activer le compte</a></p></body></html>",
- "isDefault": false
}
{- "language": "fr",
- "subject": "Bienvenue dans ${org.name}!",
- "body": "<!DOCTYPE html><html><body><p>Bonjour ${user.profile.firstName}. <a href=\"${activationLink}\">Activer le compte</a></p></body></html>",
- "isDefault": false,
- "id": "oel11u6DqUiMbQkpl0g4",
- "created": "2021-11-09T20:38:10.000Z",
- "lastUpdated": "2021-11-11T20:38:10.000Z",
- "_links": {
- "self": {
- "hints": {
- "allow": [
- "GET",
- "PUT",
- "DELETE"
]
}
}, - "template": {
- "hints": {
- "allow": [
- "GET"
]
}
}, - "preview": {
- "hints": {
- "allow": [
- "GET"
]
}
}, - "test": {
- "hints": {
- "allow": [
- "POST"
]
}
}
}
}
okta.templates.manage
Deletes all customizations for an email template
Successfully deleted all customizations for the email template.
Forbidden
Not Found
Too Many Requests
{- "errorCode": "E0000006",
- "errorSummary": "You do not have permission to perform the requested action",
- "errorLink": "E0000006",
- "errorId": "sampleNUSD_8fdkFd8fs8SDBK",
- "errorCauses": [ ]
}
okta.templates.read
Retrieves an email customization by its unique identifier
Successfully retrieved the email customization.
Forbidden
Not Found
Too Many Requests
{- "language": "en",
- "isDefault": true,
- "subject": "Welcome to ${org.name}!",
- "body": "<!DOCTYPE html><html><body><p>Hello, ${user.profile.firstName}. Click <a href=\"${activationLink}\">here</a> to activate your account.</body></html>",
- "id": "oel11u6DqUiMbQkpl0g4",
- "created": "2021-11-09T20:38:10.000Z",
- "lastUpdated": "2021-11-11T20:38:10.000Z",
- "_links": {
- "self": {
- "hints": {
- "allow": [
- "GET",
- "PUT",
- "DELETE"
]
}
}, - "template": {
- "hints": {
- "allow": [
- "GET"
]
}
}, - "preview": {
- "hints": {
- "allow": [
- "GET"
]
}
}, - "test": {
- "hints": {
- "allow": [
- "POST"
]
}
}
}
}
okta.templates.manage
Replaces an existing email customization using the property values provided
Request
body required | string The email's HTML body. May contain variable references. |
subject required | string The email's subject. May contain variable references. |
isDefault | boolean Whether this is the default customization for the email template. Each customized email template must have exactly one default customization. Defaults to |