Delete a user

This endpoint deletes the given user from INUBIT system. By the request you need to decide whether any user references in the INUBIT system should be cleaned up as well, e.g. in diagrams, modules, repository.

This endpoint responds always with a 200 regardless whether the given user existed or not. In order to verify the user deletion you can use the Get all users endpoint.

Request

URL: /user/users/{username}

Method: DELETE

Authorization: required (user with role System Administrator)

DELETE /ibis/rest/user/users/{username} HTTP/1.1
Host: localhost:8080

Request Path Parameters

Name Description Required Allowed values

Name	Description	Required	Allowed values
`username`	User name to delete	yes	Any string

username

User name to delete

yes

Any string

Request Query Parameters

Name Description Required Allowed values

Name	Description	Required	Allowed values
`userReferences`	Delete user references	no	`true` or `false`
`userRepoReferences`	Delete repository file versions where user was the modifier. This will be effective only if `userReferences` is set to `true`	no	`true` or `false`

userReferences

Delete user references

true or false

userRepoReferences

Delete repository file versions where user was the modifier. This will be effective only if userReferences is set to true

true or false

Response

HTTP/1.1 200 OK
Content-Tye: application/json

{
  "message": "User deletion successful"
}

Errors

Bad request (400): INUBIT server was unable to understand the request. This can be caused by incorrect syntax or invalid characters in the URL

{
  "errorType": 400,
  "message": "The request could not be understood by the server due to malformed syntax."
}

Authorization Failed (401): Authorization with the given username and password failed. Please revisit both values and provide valid credentials.

<html>

    <head>
        <title>Status page</title>
    </head>

    <body style="font-family: sans-serif;">
        <p style="font-size: 1.2em;font-weight: bold;margin: 1em 0px;">Unauthorized</p>
        <p>The request requires user authentication</p>
        <p>You can get technical details <a
                href="http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.2">here</a>.<br>
            Please continue your visit at our <a href="/">home page</a>.
        </p>
    </body>
</html>

Server Error (500): Execution on the INUBIT server failed. Have a look into the response message, otherwise access to the INUBIT log is required to retrieve further information.
Service Unavailable (503): In maintenance mode the INUBIT server endpoint will not respond to incoming requests but return this error response. Once the maintenance mode is switched off the endpoint will respond normally.