| Required role: | SystemAdmin |
| POST | /usergroupuserinvite |
|---|
export class UserAuth
{
public id: number;
public userName: string;
public email: string;
public primaryEmail: string;
public phoneNumber: string;
public firstName: string;
public lastName: string;
public displayName: string;
public company: string;
public birthDate?: string;
public birthDateRaw: string;
public address: string;
public address2: string;
public city: string;
public state: string;
public country: string;
public culture: string;
public fullName: string;
public gender: string;
public language: string;
public mailAddress: string;
public nickname: string;
public postalCode: string;
public timeZone: string;
public salt: string;
public passwordHash: string;
public digestHa1Hash: string;
public roles: string[];
public permissions: string[];
public createdDate: string;
public modifiedDate: string;
public invalidLoginAttempts: number;
public lastLoginAttempt?: string;
public lockedDate?: string;
public recoveryToken: string;
public refId?: number;
public refIdStr: string;
public meta: { [index: string]: string; };
public constructor(init?: Partial<UserAuth>) { (Object as any).assign(this, init); }
}
export class UserGroupUserInvite
{
// @Validate(Validator="Email")
public eMail: string;
public responseStatus: ResponseStatus;
public constructor(init?: Partial<UserGroupUserInvite>) { (Object as any).assign(this, init); }
}
TypeScript UserGroupUserInvite DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /usergroupuserinvite HTTP/1.1
Host: sfgboxapi.dev.scadsoftware.com
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length
{
eMail: String,
responseStatus:
{
errorCode: String,
message: String,
stackTrace: String,
errors:
[
{
errorCode: String,
fieldName: String,
message: String,
meta:
{
String: String
}
}
],
meta:
{
String: String
}
}
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length
{
id: 0,
userName: String,
email: String,
primaryEmail: String,
phoneNumber: String,
firstName: String,
lastName: String,
displayName: String,
company: String,
birthDate: 0001-01-01,
birthDateRaw: String,
address: String,
address2: String,
city: String,
state: String,
country: String,
culture: String,
fullName: String,
gender: String,
language: String,
mailAddress: String,
nickname: String,
postalCode: String,
timeZone: String,
salt: String,
passwordHash: String,
digestHa1Hash: String,
roles:
[
String
],
permissions:
[
String
],
createdDate: 0001-01-01,
modifiedDate: 0001-01-01,
invalidLoginAttempts: 0,
lastLoginAttempt: 0001-01-01,
lockedDate: 0001-01-01,
recoveryToken: String,
refId: 0,
refIdStr: String,
meta:
{
String: String
}
}