Share via

Api Management Service - Get Domain Ownership Identifier

Service:
API Management
API Version:
2024-05-01

Get the custom domain ownership identifier for an API Management service.

POST https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.ApiManagement/getDomainOwnershipIdentifier?api-version=2024-05-01

URI Parameters

Name In Required Type Description
subscriptionId
 path True

string (uuid)

The ID of the target subscription. The value must be an UUID.
api-version
 query True

string

minLength: 1

The API version to use for this operation.

Responses

Name Type Description
200 OK

ApiManagementServiceGetDomainOwnershipIdentifierResult

The result of getting domain ownership identifier.
Other Status Codes

ErrorResponse

Error response describing why the operation failed.

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

ApiManagementServiceGetDomainOwnershipIdentifier

Sample request

POST https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.ApiManagement/getDomainOwnershipIdentifier?api-version=2024-05-01

Sample response

Status code:
200 
{
  "domainOwnershipIdentifier": "KLE1vdMblVeHECAi4nCe3oNaXXXXvNlLrXt2ev84KM="
}

Definitions

Name Description
ApiManagementServiceGetDomainOwnershipIdentifierResult

Response of the GetDomainOwnershipIdentifier operation.
ErrorAdditionalInfo

The resource management error additional info.
ErrorDetail

The error detail.
ErrorResponse

Error response

ApiManagementServiceGetDomainOwnershipIdentifierResult

Object

Response of the GetDomainOwnershipIdentifier operation.

Name Type Description
domainOwnershipIdentifier

string

The domain ownership identifier value.

ErrorAdditionalInfo

Object

The resource management error additional info.

Name Type Description
info

object

The additional info.
type

string

The additional info type.

ErrorDetail

Object

The error detail.

Name Type Description
additionalInfo

ErrorAdditionalInfo[]

The error additional info.
code

string

The error code.
details

ErrorDetail[]

The error details.
message

string

The error message.
target

string

The error target.

ErrorResponse

Object

Error response

Name Type Description
error

ErrorDetail

The error object.