REST API - Delete User Request

Updated by Stefenie Stockbridge 

/api/v1/users

Description

Deletes all specified users.

URL Structure

[Blueprint_URI]/api/v1/users

Supported Methods

HTTP Status Codes

  • 200: OK
  • 207: Partially Successful
    • Some of the users could not be created. Refer to the codes in the response for the reason for each unsuccessfully added user:
      • 1192: A required value is missing or invalid: username, display name, first name, last name, password.
      • 1193: The user was created, but could not be added to a group.
      • 1194: The assigned Instance Administrator role does not exist.
  • 400: Bad Request
    This error can occur for a variety of reasons:
    • At least one URI or request body parameter is invalid, such as one of the Filter, Traces, Offset or Limit parameters.
    • A required value has not been provided.
    • If you are submitting a POST or PATCH request and have not added the X-HTTP-Method-Override parameter to your request header.
  • 401: Unauthorized
    • The Blueprint token is missing, invalid or expired.
  • 403: Forbidden
    • The applicable permissions are needed. For example, this error can occur when:
      • An Author or Collaborate license is needed for access.
      • Comment permissions are needed on the artifact.
      • Edit permissions are needed on the change summary job.
  • 409: Conflict
    • Reason for failure can be found in the response body. Additional information may also be found in the log.

Examples

XML Example

Request URI

https://production.blueprintcloud.com/api/v1/users

Request Body

<?xml version="1.0" ?>
<Users xmlns="http://www.blueprintsys.com/blueprint/api/v1">
	<User>
		<DisplayName>quaaade</DisplayName>
		<Firstname>Douglas</Firstname>
		<Lastname>Quade</Lastname>
		<Name>dquade</Name>
		<Password>@Quaaade#1</Password>
	</User>
</Users>

Response Body

<UserAddResults xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://www.blueprintsys.com/blueprint/api/v1">
	<UserAddResult>
		<Message>User has been successfully deleted.</Message>
		<ResultCode>200</ResultCode>
		<User>
			<Email>dquade2084@dev.recall.com</Email>
			<Department>Devops</Department>
			<DisplayName>quaaade</DisplayName>
			<Enabled>false</Enabled>
			<Firstname>Douglas</Firstname>
			<Groups />
			<Id>3754</Id>
			<Lastname>Quade</Lastname>
			<Name>dquade</Name>
			<Title>Engineer</Title>
		</User>
	</UserAddResult>
</UserAddResults>
JSON Example

Request URI

https://production.blueprintcloud.com/api/v1/users

Request Body

[
	"Fanvid",
	"Noviseth"
]

Response Body

[
	{
		"User": {
			"Type": "User",
			"Id": 22,
			"Name": "Fanvid",
			"DisplayName": "David",
			"Firstname": "David",
			"Lastname": "Gao",
			"Title": "Tester",
			"Department": "RD",
			"Enabled": true,
			"Email": "WXZALZ3RSK@FLQAPZON90.com"
		},
		"Message": "User has been successfully deleted.",
		"ResultCode": 200
	},
	{
		"User": {
			"Type": "User",
			"Id": 31,
			"Name": "noviseth",
			"DisplayName": "Novina Sethuraman",
			"Firstname": "Novina",
			"Lastname": "Sethuraman",
			"Title": "Tester",
			"Department": "RD",
			"Enabled": true,
			"Email": "4SLH4FQOSA@M7DO1B7OB0.com"
		},
		"Message": "User has been successfully deleted.",
		"ResultCode": 200
	}
]

How did we do?