| Required role: | SystemAdmin |
| POST | /usergroupuserinvite |
|---|
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| body | string | No | ||
| ResponseStatus | body | ResponseStatus | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Id | form | int | No | |
| UserName | form | string | No | |
| form | string | No | ||
| PrimaryEmail | form | string | No | |
| PhoneNumber | form | string | No | |
| FirstName | form | string | No | |
| LastName | form | string | No | |
| DisplayName | form | string | No | |
| Company | form | string | No | |
| BirthDate | form | DateTime? | No | |
| BirthDateRaw | form | string | No | |
| Address | form | string | No | |
| Address2 | form | string | No | |
| City | form | string | No | |
| State | form | string | No | |
| Country | form | string | No | |
| Culture | form | string | No | |
| FullName | form | string | No | |
| Gender | form | string | No | |
| Language | form | string | No | |
| MailAddress | form | string | No | |
| Nickname | form | string | No | |
| PostalCode | form | string | No | |
| TimeZone | form | string | No | |
| Salt | form | string | No | |
| PasswordHash | form | string | No | |
| DigestHa1Hash | form | string | No | |
| Roles | form | List<string> | No | |
| Permissions | form | List<string> | No | |
| CreatedDate | form | DateTime | No | |
| ModifiedDate | form | DateTime | No | |
| InvalidLoginAttempts | form | int | No | |
| LastLoginAttempt | form | DateTime? | No | |
| LockedDate | form | DateTime? | No | |
| RecoveryToken | form | string | No | |
| RefId | form | int? | No | |
| RefIdStr | form | string | No | |
| Meta | form | Dictionary<string, string> | No |
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: api.sfgtec.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
}
}