App Service Certificate Orders - Retrieve Site Seal

This method is used to obtain the site seal information for an issued certificate. A site seal is a graphic that the certificate purchaser can embed on their web site to show their visitors information about their SSL certificate. If a web site visitor clicks on the site seal image, a pop-up page is displayed that contains detailed information about the SSL certificate. The site seal token is used to link the site seal graphic image to the appropriate certificate details pop-up page display when a user clicks on the site seal. The site seal images are expected to be static images and hosted by the reseller, to minimize delays for customer page load times.

POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CertificateRegistration/certificateOrders/{certificateOrderName}/retrieveSiteSeal?api-version=2023-01-01

URI Parameters

Name In Required Type Description
certificateOrderName
path True

string

Name of the certificate order.

resourceGroupName
path True

string

Name of the resource group to which the resource belongs.

Regex pattern: ^[-\w\._\(\)]+[^\.]$

subscriptionId
path True

string

Your Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000).

api-version
query True

string

API Version

Request Body

Name Type Description
lightTheme

boolean

If true use the light color theme for site seal; otherwise, use the default color theme.

locale

string

Locale of site seal.

Responses

Name Type Description
200 OK

SiteSeal

OK

Other Status Codes

DefaultErrorResponse

App Service error response.

Security

azure_auth

Azure Active Directory OAuth2 Flow

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name Description
user_impersonation impersonate your user account

Examples

Retrieve Site Seal

Sample Request

POST https://management.azure.com/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.CertificateRegistration/certificateOrders/SampleCertOrder/retrieveSiteSeal?api-version=2023-01-01

{
  "lightTheme": true,
  "locale": "en-us"
}

Sample Response

{
  "html": "<html>SiteSeal</html>"
}

Definitions

Name Description
DefaultErrorResponse

App Service error response.

Details
Error

Error model.

SiteSeal

Site seal

SiteSealRequest

Site seal request.

DefaultErrorResponse

App Service error response.

Name Type Description
error

Error

Error model.

Details

Name Type Description
code

string

Standardized string to programmatically identify the error.

message

string

Detailed error description and debugging information.

target

string

Detailed error description and debugging information.

Error

Error model.

Name Type Description
code

string

Standardized string to programmatically identify the error.

details

Details[]

Detailed errors.

innererror

string

More information to debug error.

message

string

Detailed error description and debugging information.

target

string

Detailed error description and debugging information.

SiteSeal

Site seal

SiteSealRequest

Site seal request.

Name Type Description
lightTheme

boolean

If true use the light color theme for site seal; otherwise, use the default color theme.

locale

string

Locale of site seal.