UserAttr.delete - REST API

Overview

Deletes an existing user attribute or attributes. The operation cannot be undone. It is not an error to delete an attribute that does not exist.

While the call's Python equivalent has two versions, one for individual and the other for multiple attributes, with REST there is a single endpoint to cover both cases. Yet, just like in the Python call, it is more efficient to delete multiple attributes in one REST call instead of repeatedly deleting individual ones.

HTTP method: DELETE
URL path: /zato/sso/user/attr

Request

Name	Datatype	Optional	Notes
ust	string	---	Current user's session token (UST)
current_app	string	---	Name of application that the call is attempted from
user_id	string	Yes	ID of the user to delete an attribute or attributes of
name	string	Yes	If a single attribute is to be deleted, the attribute's name
data	list	Yes	If multiple attributes are to be deleted, this is a list of their names

Response

Name	Datatype	Optional	Notes
cid	string	---	Correlation ID assigned to request
status	string	---	Overall status code
sub_status	list	Yes	Returned only if status is not "ok", a list of error or warning codes

Usage

$ curl -XDELETE localhost:17010/zato/sso/user/attr -d '
  {
    "current_ust": "gAAAAABavk-65BuvKI0J...",
    "current_app": "CRM",
    "user_id": "zusr6fh6fdgd4997ksjkpx7qnk659q",
    "name": "my-attribute"
  }
  '

  {
    "status": "ok",
    "cid": "e07c2f8fa0bb5d3b17dcf181"
  }