Skip to main content

Delete access app

The endpoint provides functionality to delete an access app of an existing user.

HTTP request

DELETE https://$instanceId.id.nevis.cloud/nevis/api/v1/users/$userId/access-apps/$accessAppId

Parameters

ParameterInTypeRequired / OptionalDescription
instanceIdpathstringrequiredThe ID of your Identity Cloud instance
userIdpathstringrequiredThe ID of the user
accessAppIdpathstringrequiredThe ID of the access app

Example request

Set the user ID and access app ID.

userId=your-user-id-123
accessAppId=your-access-app-id-123
curl --request DELETE "https://$instanceId.id.nevis.cloud/nevis/api/v1/users/$userId/access-apps/$accessAppId" \
--header "Authorization: Bearer $accessKey"

HTTP response

On success

HTTP/1.1 204 is returned if the access app is successfully deleted.

On missing user

HTTP/1.1 404 is returned with an error message if the user with the given userId is not found.

Example response

{
"error": "User with id: cdc891da-51ea-11ec-bf63-0242ac130002 cannot be found."
}

On missing access app

HTTP/1.1 404 is returned with an error message if an access app with the given accessAppId is not found.

Example response

{
"error": "Access app with id: 0d663c2a-50dc-4261-9faf-7a909683260a cannot be found."
}

On failure

HTTP/1.1 401 is returned if the authorization fails due to an invalid access key.

HTTP/1.1 422 is returned if invalid request content is given.

HTTP/1.1 500 is returned if an unexpected error occurs.