DELETE | /users | Deletes a user | Deletes the logged in user account. |
---|
"use strict";
export class UserProfileResponse {
/** @param {{Id?:string,Firstname?:string,Lastname?:string,Phone?:string,Email?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {string} */
Id;
/** @type {string} */
Firstname;
/** @type {string} */
Lastname;
/** @type {string} */
Phone;
/** @type {string} */
Email;
}
export class AdminProfile {
/** @param {{CompanyId?:string,Id?:string,Firstname?:string,Lastname?:string,Email?:string,WorkerId?:string,Phone?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {string} */
CompanyId;
/** @type {string} */
Id;
/** @type {string} */
Firstname;
/** @type {string} */
Lastname;
/** @type {string} */
Email;
/** @type {string} */
WorkerId;
/** @type {string} */
Phone;
}
export class DeleteUserResponse {
/** @param {{ResponseStatus?:Object,UserName?:string,UserProfile?:UserProfileResponse,AdminProfile?:AdminProfile}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {Object} */
ResponseStatus;
/**
* @type {string}
* @description The user id for your profile. */
UserName;
/** @type {UserProfileResponse} */
UserProfile;
/** @type {AdminProfile} */
AdminProfile;
}
/** @typedef {number} */
export var KeyCloakRealm;
(function (KeyCloakRealm) {
KeyCloakRealm[KeyCloakRealm["BookMore"] = 1] = "BookMore"
KeyCloakRealm[KeyCloakRealm["BookMoreAdmin"] = 2] = "BookMoreAdmin"
KeyCloakRealm[KeyCloakRealm["SuperAdmin"] = 3] = "SuperAdmin"
})(KeyCloakRealm || (KeyCloakRealm = {}));
export class DeleteUser {
/** @param {{UserName?:string,Realm?:KeyCloakRealm,DeleteCustomerProfiles?:boolean,ForceDelete?:boolean,Token?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/**
* @type {string}
* @description The user name of your profile. */
UserName;
/**
* @type {KeyCloakRealm}
* @description The user realm for identity server. BookMore = 1, BookMoreAdmin = 2 */
Realm;
/**
* @type {boolean}
* @description If this equals true it will force delete all customer profiles on all company on there you have booked a time. */
DeleteCustomerProfiles;
/**
* @type {boolean}
* @description If this equals true it will check the request token value and try to delete user, if it is false it will send a delete confirmation email. */
ForceDelete;
/**
* @type {string}
* @description The value is only checked when ForceDelete is set to true. Contains the token value what was sent to email. */
Token;
}
To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
DELETE /users HTTP/1.1 Host: api.bokamera.se Accept: application/xml
HTTP/1.1 200 OK Content-Type: application/xml Content-Length: length <DeleteUserResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BokaMera.API.ServiceModel.Dtos"> <AdminProfile> <CompanyId>00000000-0000-0000-0000-000000000000</CompanyId> <Email>String</Email> <Firstname>String</Firstname> <Id>00000000-0000-0000-0000-000000000000</Id> <Lastname>String</Lastname> <Phone>String</Phone> <WorkerId>String</WorkerId> </AdminProfile> <ResponseStatus /> <UserName>String</UserName> <UserProfile> <Email>String</Email> <Firstname>String</Firstname> <Id>00000000-0000-0000-0000-000000000000</Id> <Lastname>String</Lastname> <Phone>String</Phone> </UserProfile> </DeleteUserResponse>