| GET | /subusers/list | Get all sub users |
|---|
"use strict";
export class Authentication {
/** @param {{apiUserId?:string,apiUserKey?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/**
* @type {string}
* @description The API User ID provided by us when you signed up to use our API */
apiUserId;
/**
* @type {string}
* @description The API User Key provided by us when you signed up to use our API */
apiUserKey;
}
export class BaseRequest {
/** @param {{authentication?:Authentication}} [init] */
constructor(init) { Object.assign(this, init) }
/**
* @type {Authentication}
* @description The authentication credentials */
authentication;
}
export class ResponseError {
/** @param {{errorCode?:string,fieldName?:string,message?:string,meta?:{ [index: string]: string; }}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {string} */
errorCode;
/** @type {string} */
fieldName;
/** @type {string} */
message;
/** @type {{ [index: string]: string; }} */
meta;
}
export class ArrayOfResponseError extends Array {
constructor(init) { super(init); Object.assign(this, init) }
}
export class ResponseStatus {
/** @param {{errorCode?:string,message?:string,stackTrace?:string,errors?:ArrayOfResponseError,meta?:{ [index: string]: string; }}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {string} */
errorCode;
/** @type {string} */
message;
/** @type {string} */
stackTrace;
/** @type {ArrayOfResponseError} */
errors;
/** @type {{ [index: string]: string; }} */
meta;
}
export class BaseResponse {
/** @param {{responseStatus?:ResponseStatus}} [init] */
constructor(init) { Object.assign(this, init) }
/**
* @type {ResponseStatus}
* @description The status of the response */
responseStatus;
}
export class ArrayOfUserNames extends Array {
constructor(init) { super(init); Object.assign(this, init) }
}
export class SubUser {
/** @param {{isMainUser?:boolean,userId?:string,userName?:string,name?:string,email?:string,isAdmin?:boolean,canResolveSearches?:boolean,canDeleteSearches?:boolean,permissions?:ArrayOfUserNames}} [init] */
constructor(init) { Object.assign(this, init) }
/**
* @type {boolean}
* @description Is this user the main user (i.e. the user who created the account) */
isMainUser;
/**
* @type {string}
* @description The sub user's id (GUID) */
userId;
/**
* @type {string}
* @description The sub user's UserName (i.e. the sign-in username) */
userName;
/**
* @type {string}
* @description The sub user's name */
name;
/**
* @type {string}
* @description The sub user's email address */
email;
/**
* @type {boolean}
* @description Does this sub user have admin privileges, such as managing purchases and sub users */
isAdmin;
/**
* @type {boolean}
* @description Can this sub user resolve searches (UpdateSearch) they have access to */
canResolveSearches;
/**
* @type {boolean}
* @description Can this sub user delete searches (DeleteSearch) they have access to */
canDeleteSearches;
/**
* @type {ArrayOfUserNames}
* @description The user names for which searches will be made available to the sub user */
permissions;
}
export class GetSubUsersData extends BaseResponse {
/** @param {{subUsers?:SubUser[],responseStatus?:ResponseStatus}} [init] */
constructor(init) { super(init); Object.assign(this, init) }
/**
* @type {SubUser[]}
* @description The list of sub users */
subUsers;
}
export class GetSubUsersResponse {
/** @param {{data?:GetSubUsersData}} [init] */
constructor(init) { Object.assign(this, init) }
/**
* @type {GetSubUsersData}
* @description The response data */
data;
}
export class GetSubUsers extends BaseRequest {
/** @param {{includeMainUser?:boolean,authentication?:Authentication}} [init] */
constructor(init) { super(init); Object.assign(this, init) }
/**
* @type {boolean}
* @description If this is 'True' the main user will be included in the list of sub users */
includeMainUser;
}
To override the Content-type in your clients, use the HTTP Accept Header, append the .json suffix or ?format=json
To embed the response in a jsonp callback, append ?callback=myCallback
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
GET /subusers/list HTTP/1.1 Host: api.sanctionssearch.com Accept: application/json
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length
{"data":{"subUsers":[{"isMainUser":false,"userName":"String","name":"String","email":"String","isAdmin":false,"canResolveSearches":false,"canDeleteSearches":false,"permissions":["String"]}],"responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}}}}