Skip to main content

Delete Address

Delete Address API will delete the address of the requested user.

Resource Informations​

NameValue
Requires authentication?Yes
Rate limited?No

Request​

Request headers​

KeyValue
AuthorizationBearer token
Content-Typeapplication/json

HTTP request URL​

DELETE https://{hostname}/auth/realms/{tenantId}/address/{userName}/delete
note

Digitanium support for this API will be provided on request.

note

API requests must be made over https. Calls made over plain http will fail.

Parameters​

No parameters fields are required.

Request body(*Required)​

Field NameTypeDescription
*addressIDStringDefine the addressID given for a particular address.

Sample Request​

{
    "addressID" : "0a7373c0-a934-49bc-be76-8d80bdf0f45c"
}

Response​

Field NameTypeDescription
messageStringMessage explains result of the API call. Refer Response status Information for details.
statusStringThe status of the API call. Refer Response status Information for details.
subSystemIntegersubSystem categorizes the type of API that has been called. Refer Subsystem details for details.

Sample Response​

{
    "message": "Address deleted successfully",
    "status": "Success",
    "subSystem": 5
}

Response Status Information​

Status CodeStatusMessage
200OKAddress deleted successfully
400BAD_REQUESTMandatory data is missing
401UnauthorizedHTTP 401 Unauthorized
404USER_NOT_FOUNDUser does not exist
404NOT_FOUNDInvalid address