Syntch Gateway API

<back to all web services

GetGatewayUserRequest

User Management
Requires Authentication
Required role:Merchant
The following routes are available for this service:
GET/users/{userIdOrUserName}Get the gateway user with provided user id.
GetGatewayUserRequest Parameters:
NameParameterData TypeRequiredDescription
UserIdOrUserNamepathstringYesA string that will be interpreted as a User ID if it is an integer, or a username if it is a string
GatewayUser Parameters:
NameParameterData TypeRequiredDescription
UserNameformstringNo
PhoneNumberformstringNo
IdformintNo
DeleterUserIdformlong?No
CreatorUserIdformlongNo
LastModifierUserIdformlong?No
IsLockoutEnabledformboolNo
RolesformICollection<GatewayUserRole<Int64>>No
ClaimsformICollection<UserClaim>No
LoginsformICollection<GatewayUserLogin<Int64>>No
IsPhoneNumberConfirmedformboolNo
SecurityStampformstringNo
IsTwoFactorEnabledformboolNo
IsDeletedformboolNo
IsEmailConfirmedformboolNo
AccessFailedCountformintNo
LockoutEndDateUtcformDateTime?No
CreationTimeformDateTimeNo
LastModificationTimeformDateTime?No
DeletionTimeformDateTime?No
FirstNameformstringNo
EmailConfirmationCodeformstringNo
PasswordformstringNo
LastNameformstringNo
IsActiveformboolNo
EmailAddressformstringNo
TenantIdformint?No
AuthenticationSourceformstringNo
PasswordResetCodeformstringNo
LastLoginTimeformDateTime?No
Address1formstringNo
Address2formstringNo
CityformstringNo
StateformstringNo
ZipformstringNo
CountryformstringNo
TimezoneformstringNo
ShouldChangePasswordOnNextLoginformboolNo
UserClaim Parameters:
NameParameterData TypeRequiredDescription
ClaimTypeformstringNo
ClaimValueformstringNo
CreatorIdformintNo
TenantIdformintNo
CreateTimeformDateTimeNo

To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv

HTTP + CSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

GET /users/{userIdOrUserName} HTTP/1.1 
Host: syntch.simpay.net 
Accept: text/csv
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"UserName":"String","PhoneNumber":"String","Id":0,"DeleterUserId":0,"CreatorUserId":0,"LastModifierUserId":0,"IsLockoutEnabled":false,"Roles":[],"Logins":[],"IsPhoneNumberConfirmed":false,"SecurityStamp":"String","IsTwoFactorEnabled":false,"IsDeleted":false,"IsEmailConfirmed":false,"AccessFailedCount":0,"LockoutEndDateUtc":"0001-01-01T00:00:00.0000000","CreationTime":"0001-01-01T00:00:00.0000000","LastModificationTime":"0001-01-01T00:00:00.0000000","DeletionTime":"0001-01-01T00:00:00.0000000","FirstName":"String","EmailConfirmationCode":"String","Password":"String","LastName":"String","IsActive":false,"EmailAddress":"String","TenantId":0,"AuthenticationSource":"String","PasswordResetCode":"String","LastLoginTime":"0001-01-01T00:00:00.0000000","Address1":"String","Address2":"String","City":"String","State":"String","Zip":"String","Country":"String","Timezone":"String","ShouldChangePasswordOnNextLogin":false}