Microsoft ApiManagement
Best practices and references below are based on published guidance from the cloud service provider and may reference native capabilities the cloud service provider offers. If you are not using the native security capabilities, the same security requirement can be met using other security capabilities your organization utilizes
Design Guidance:
Identity-Type | ||
Additional Properties-Client Id | ||
Additional Properties-Principal Id | ||
Certificates |
Subscription Required | ||
O Auth2-Authorization Server Id | ||
O Auth2-Scope | ||
Openid-Bearer Token Sending Methods | ||
Openid-Openid Provider Id |
Allowed Tenants | ||
Signin Tenant | ||
Name |
Subscription Required |
Owner Id |
Name | ||
Client Id | ||
Client Secret | ||
Display Name |
Design Guidance:
Name | ||
Api Version Constraint-Min Api Version | ||
Hostname Configurations-Host Name | ||
Hostname Configurations-Type |
Name | ||
Api Revision | ||
Api Type | ||
Api Version Set-Id | ||
Api Version Set-Name | ||
Display Name | ||
Is Current | ||
Source Api Id |
Name |
Name | ||
Display Name |
Name |
Name |
Name |
Name |
Name | ||
State |
Name | ||
Display Name |
Name | ||
Display Name | ||
Url Template |
Name | ||
Protocol | ||
Resource Id | ||
Url |
Virtual Network Configuration-Subnet Resource Id | ||
Virtual Network Configuration-Subnet Resource Id | ||
Virtual Network Type |
Design Guidance:
Certificate-Expiry | ||
Certificate-Expiry |
Certificate-Thumbprint | ||
Certificate-Thumbprint |
Design Guidance:
Certificates-Certificate Password | ||
Hostname Configurations-Certificate Password |
Client Authentication Method | ||
Resource Owner Password | ||
Resource Owner Username |
Password |
Secret | ||
Value |
Design Guidance:
Certificates-Encoded Certificate | ||
Hostname Configurations-Encoded Certificate | ||
Hostname Configurations-Key Vault Id |
Protocols |
Name | ||
Data |
Certificate Id | |
Hostname |
TLS-Validate Certificate Chain | ||
TLS-Validate Certificate Name |
Certificates-Store Name | ||
Certificate-Subject |
Design Guidance:
Enable Client Certificate | ||
Hostname Configurations-Negotiate Client Certificate |
Bearer Token Sending Methods | ||
Client Id | ||
Client Registration Endpoint | ||
Client Secret |
Negotiate Client Certificate |
Authorization-Parameter | ||
Authorization-Scheme | ||
Credentials-Certificate | ||
Service Fabric Cluster-Client Certificatethumbprint | ||
Service Fabric Cluster-Management Endpoints |
Hostname Configurations-Default SSL Binding |
Subscription Key Parameter Names-Header | ||
Subscription Key Parameter Names-Query |
Token Body Parameters-Name | ||
Token Body Parameters-Value | ||
Token Endpoint |
Design Guidance:
Api Version Set-Version Header Name | ||
Api Version Set-Versioning Scheme | ||
Api Version Set-Version Query Name |
Version Header Name | ||
Versioning Scheme | ||
Version Query Name |
Design Guidance:
Format |
Headers-Default Value | ||
Headers-Name | ||
Headers-Type | ||
Headers-Values | ||
Query Parameters-Default Value | ||
Query Parameters-Name | ||
Query Parameters-Type | ||
Query Parameters-Values | ||
Representations-Content Type | ||
Form Parameters-Default Value | ||
Form Parameters-Name | ||
Form Parameters-Type | ||
Form Parameters-Values | ||
Representations-Schema Id |
Path | ||
Wsdl Selector-Wsdl Endpoint Name | ||
Wsdl Selector-Wsdl Service Name |