{
"opencollection": "1.0.0",
"info": {
"name": "Auth0 Authentication actions branding API",
"version": "1.0.0"
},
"items": [
{
"info": {
"name": "branding",
"type": "folder"
},
"items": [
{
"info": {
"name": "Get Branding Settings",
"type": "http"
},
"http": {
"method": "GET",
"url": "{auth0_domain}/branding"
},
"docs": "Retrieve branding settings."
},
{
"info": {
"name": "Update Branding Settings",
"type": "http"
},
"http": {
"method": "PATCH",
"url": "{auth0_domain}/branding",
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Update branding settings."
},
{
"info": {
"name": "Get a List of Phone Providers",
"type": "http"
},
"http": {
"method": "GET",
"url": "{auth0_domain}/branding/phone/providers",
"params": [
{
"name": "disabled",
"value": "",
"type": "query",
"description": "Whether the provider is enabled (false) or disabled (true)."
}
]
},
"docs": "Retrieve a list of phone providers details set for a Tenant. A list of fields to include or exclude may also be specified.\n"
},
{
"info": {
"name": "Configure the Phone Provider",
"type": "http"
},
"http": {
"method": "POST",
"url": "{auth0_domain}/branding/phone/providers",
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Create a phone provider.\nThe credentials object requires different properties depending on the phone provider (which is specified using the name property).\n"
},
{
"info": {
"name": "Get a Phone Provider",
"type": "http"
},
"http": {
"method": "GET",
"url": "{auth0_domain}/branding/phone/providers/:id",
"params": [
{
"name": "id",
"value": "",
"type": "path"
}
]
},
"docs": "Retrieve phone provider details. A list of fields to include or exclude may also be specified.\n"
},
{
"info": {
"name": "Update the Phone Provider",
"type": "http"
},
"http": {
"method": "PATCH",
"url": "{auth0_domain}/branding/phone/providers/:id",
"params": [
{
"name": "id",
"value": "",
"type": "path"
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Update a phone provider.\nThe credentials object requires different properties depending on the phone provider (which is specified using the name property).\n"
},
{
"info": {
"name": "Deletes a Phone Provider",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "{auth0_domain}/branding/phone/providers/:id",
"params": [
{
"name": "id",
"value": "",
"type": "path"
}
]
},
"docs": "Delete the configured phone provider.\n"
},
{
"info": {
"name": "Send a Test Phone Notification for the Configured Provider",
"type": "http"
},
"http": {
"method": "POST",
"url": "{auth0_domain}/branding/phone/providers/:id/try",
"params": [
{
"name": "id",
"value": "",
"type": "path"
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Send a Test Phone Notification for the Configured Provider"
},
{
"info": {
"name": "Get a List of Phone Notification Templates",
"type": "http"
},
"http": {
"method": "GET",
"url": "{auth0_domain}/branding/phone/templates",
"params": [
{
"name": "disabled",
"value": "",
"type": "query",
"description": "Whether the template is enabled (false) or disabled (true)."
}
]
},
"docs": "Get a List of Phone Notification Templates"
},
{
"info": {
"name": "Create a Phone Notification Template",
"type": "http"
},
"http": {
"method": "POST",
"url": "{auth0_domain}/branding/phone/templates",
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Create a Phone Notification Template"
},
{
"info": {
"name": "Get a Phone Notification Template",
"type": "http"
},
"http": {
"method": "GET",
"url": "{auth0_domain}/branding/phone/templates/:id",
"params": [
{
"name": "id",
"value": "",
"type": "path"
}
]
},
"docs": "Get a Phone Notification Template"
},
{
"info": {
"name": "Update a Phone Notification Template",
"type": "http"
},
"http": {
"method": "PATCH",
"url": "{auth0_domain}/branding/phone/templates/:id",
"params": [
{
"name": "id",
"value": "",
"type": "path"
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Update a Phone Notification Template"
},
{
"info": {
"name": "Delete a Phone Notification Template",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "{auth0_domain}/branding/phone/templates/:id",
"params": [
{
"name": "id",
"value": "",
"type": "path"
}
]
},
"docs": "Delete a Phone Notification Template"
},
{
"info": {
"name": "Resets a Phone Notification Template Values",
"type": "http"
},
"http": {
"method": "PATCH",
"url": "{auth0_domain}/branding/phone/templates/:id/reset",
"params": [
{
"name": "id",
"value": "",
"type": "path"
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Resets a Phone Notification Template Values"
},
{
"info": {
"name": "Send a Test Phone Notification for the Configured Template",
"type": "http"
},
"http": {
"method": "POST",
"url": "{auth0_domain}/branding/phone/templates/:id/try",
"params": [
{
"name": "id",
"value": "",
"type": "path"
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Send a Test Phone Notification for the Configured Template"
},
{
"info": {
"name": "Get Template for New Universal Login Experience",
"type": "http"
},
"http": {
"method": "GET",
"url": "{auth0_domain}/branding/templates/universal-login"
},
"docs": "Get Template for New Universal Login Experience"
},
{
"info": {
"name": "Set Template for New Universal Login Experience",
"type": "http"
},
"http": {
"method": "PUT",
"url": "{auth0_domain}/branding/templates/universal-login",
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Update the Universal Login branding template.\n\n
When content-type header is set to application/json:
\n{\n \"template\": \"<!DOCTYPE html>{% assign resolved_dir = dir | default: \"auto\" %}<html lang=\"{{locale}}\" dir=\"{{resolved_dir}}\"><head>{%- auth0:head -%}</head><body class=\"_widget-auto-layout\">{%- auth0:widget -%}</body></html>\"\n}\n\n\n\n When content-type header is set to text/html:\n"
},
{
"info": {
"name": "Delete Template for New Universal Login Experience",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "{auth0_domain}/branding/templates/universal-login"
},
"docs": "Delete Template for New Universal Login Experience"
},
{
"info": {
"name": "Create Branding Theme",
"type": "http"
},
"http": {
"method": "POST",
"url": "{auth0_domain}/branding/themes",
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Create branding theme."
},
{
"info": {
"name": "Get Default Branding Theme",
"type": "http"
},
"http": {
"method": "GET",
"url": "{auth0_domain}/branding/themes/default"
},
"docs": "Retrieve default branding theme."
},
{
"info": {
"name": "Get Branding Theme",
"type": "http"
},
"http": {
"method": "GET",
"url": "{auth0_domain}/branding/themes/:themeId",
"params": [
{
"name": "themeId",
"value": "",
"type": "path",
"description": "The ID of the theme"
}
]
},
"docs": "Retrieve branding theme."
},
{
"info": {
"name": "Update Branding Theme",
"type": "http"
},
"http": {
"method": "PATCH",
"url": "{auth0_domain}/branding/themes/:themeId",
"params": [
{
"name": "themeId",
"value": "",
"type": "path",
"description": "The ID of the theme"
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Update branding theme."
},
{
"info": {
"name": "Delete Branding Theme",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "{auth0_domain}/branding/themes/:themeId",
"params": [
{
"name": "themeId",
"value": "",
"type": "path",
"description": "The ID of the theme"
}
]
},
"docs": "Delete branding theme."
}
]
}
],
"bundled": true
}