Delete User

Details

API Details
NameDelete User
DescriptionDeletes the disabled user with the specified User ID.
MethodDELETE
URI
  • v1/users/userId
  • v1/users?searchField=externalId&searchString=rash&searchOper=cn
CloudCenter Release
  • Introduced in CloudCenter 4.0.
  • Enhanced in CloudCenter 4.4 to support user deletion based on the External ID.
Notes
  • For additional context on <PORT> usage in the following example(s), see Base URI Format.
  • A user cannot be successfully deleted unless the "status" attribute of the user is NEW or DISABLED.
ESB Header
  • action: delete.users.userId
  • action: delete.users
    actionparam: searchField=externalId&searchString=rash&searchOper=cn

Example – Based on CloudCenter User ID

curl -k -X DELETE -H "Accept: application/json" -u cloudcenteradmin:40E45DBE57E35ECB "https://<HOST>:<PORT>/v1/users/2"

Response

The server responds with the HTTP Response code 204 No Content if the deletion of the user is successful.

Example – Based on External ID

curl -k -X DELETE -H "Accept: application/json" -u cloudcenteradmin:40E45DBE57E35ECB "https://<HOST>:<PORT>/v1/users/3?searchField=externalId&searchString=rash&searchOper=cn"

Request Body

 {
    "resource": "https://<HOST>:<PORT>/v1/users?searchField=externalId&searchString=rash&searchOper=cn",
    "users": [{
            "id": "3",
            "resource": "https://<HOST>:<PORT>/v1/users/3?searchField=externalId&
searchString=rash&searchOper=cn",
            "perms": [],
            "username": "rash_3",
            "password": "== red-acted ==",
            "enabled": true,
            "type": "STANDARD",
            "firstName": "rash",
            "lastName": "cloudCenter",
            "companyName": "company",
            "tenantId": "1",
            "emailAddr": "rash@company.com",
            "emailVerified": true,
            "phoneNumber": "",
            "externalId": "rash",
            "accessKeys": "https://<HOST>:<PORT>/v1/users/3/keys",
            "disableReason": null,
            "accountSource": "AdminCreated",
            "status": "ENABLED",
            "detail": null,
            "activationData": null,
            "created": 1447963377000,
            "lastUpdated": 1453766293000,
            "coAdmin": false,
            "activationProfileId": null,
            "hasSubscriptionPlanType": false
        }
    ]
}

 

Response

The server responds with the HTTP Response code 204 No Content if the deletion of the user is successful.

Request Attributes

userId
  • Description: Unique, system-generated identifier for a user
  • Type: String
searchField
  • Description: The CloudCenter API attribute on which you perform this search operation. For example, externalId.
  • Type: String

externalId
  • DescriptionIdentity provider ID for external access (for example, SSO). This value must match the corresponding user's SAML subject Name ID value. Defaults to empty string if not set.
  • Type: String

searchString
  • Description: The exact string to use for this search task.
  • Type: String

searchOper
  • Description: Identifies the search operator to be used for this task. The accepted values are:
    • eq (is equal to)
    • ne (is not equal to)
    • bw (begins with)
    • bn (does not begin with)
    • ew (ends with)
    • en (does not end with)
    • gt (is greater than)
    • lt (is less than)
    • le (is less or equal to)
    • ge (is greater or equal to)
    • cn (contains)
    • nu (null)
    • nn (not null)
  • Type: String

resource
  • Description: Unique URL to access this resource.
  • Type: String
users (click for additional details)

 

 

Response Attributes

None