User - Delete
Deletes specific user.
DELETE https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/users/{userId}?api-version=2021-08-01
DELETE https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/users/{userId}?deleteSubscriptions={deleteSubscriptions}¬ify={notify}&api-version=2021-08-01&appType={appType}
URI Parameters
Name | In | Required | Type | Description |
---|---|---|---|---|
resource
|
path | True |
string |
The name of the resource group. |
service
|
path | True |
string |
The name of the API Management service. Regex pattern: |
subscription
|
path | True |
string |
Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. |
user
|
path | True |
string |
User identifier. Must be unique in the current API Management service instance. |
api-version
|
query | True |
string |
Version of the API to be used with the client request. |
app
|
query |
Determines the type of application which send the create user request. Default is legacy publisher portal. |
||
delete
|
query |
boolean |
Whether to delete user's subscription or not. |
|
notify
|
query |
boolean |
Send an Account Closed Email notification to the User. |
Request Header
Name | Required | Type | Description |
---|---|---|---|
If-Match | True |
string |
ETag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update. |
Responses
Name | Type | Description |
---|---|---|
200 OK |
The user details were successfully deleted. |
|
204 No Content |
The user details were successfully deleted. |
|
Other Status Codes |
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
ApiManagementDeleteUser
Sample request
Sample response
Definitions
Name | Description |
---|---|
App |
Determines the type of application which send the create user request. Default is legacy portal. |
Error |
Error Field contract. |
Error |
Error Response. |
AppType
Determines the type of application which send the create user request. Default is legacy portal.
Name | Type | Description |
---|---|---|
developerPortal |
string |
User create request was sent by new developer portal. |
portal |
string |
User create request was sent by legacy developer portal. |
ErrorFieldContract
Error Field contract.
Name | Type | Description |
---|---|---|
code |
string |
Property level error code. |
message |
string |
Human-readable representation of property-level error. |
target |
string |
Property name. |
ErrorResponse
Error Response.
Name | Type | Description |
---|---|---|
error.code |
string |
Service-defined error code. This code serves as a sub-status for the HTTP error code specified in the response. |
error.details |
The list of invalid fields send in request, in case of validation error. |
|
error.message |
string |
Human-readable representation of the error. |