ApexERPHost

<back to all web services

GetErpSecurityIdentities

Requires Authentication
The following routes are available for this service:
GET/Core/Security/Identities/{IdentityType}
GetErpSecurityIdentities Parameters:
NameParameterData TypeRequiredDescription
IdentityTypepathstringNo
GetErpSecurityIdentitiesResponse Parameters:
NameParameterData TypeRequiredDescription
ResponseStatusformResponseStatusNo
ResultformList<ErpAuthorizationIdentity>No
ErpAuthorizationIdentity Parameters:
NameParameterData TypeRequiredDescription
IdformintNo
NameformstringNo
DescriptionformstringNo
IsRoleformbool?No
IsGrantedformbool?No
UserInfoformERPUserInfoNo
ERPUserInfo Parameters:
NameParameterData TypeRequiredDescription
UserIdformintNo
UserNameformstringNo
EmailformstringNo
NameformstringNo
LastNameformstringNo
LastLoginAttemptformDateTime?No
InvalidLoginAttemptsformintNo
BlockedformboolNo
CreatedDateformDateTimeNo
ModifiedDateformDateTimeNo
LockedDateformDateTime?No
PhoneNumberformstringNo
BirthDateformDateTime?No
LanguageformstringNo
EmailConfirmedformboolNo
IsSysAdminformboolNo
UserDataformstringNo
DisplayNameformstringNo
MaxSessionCountformintNo

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

HTTP + JSV

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

GET /Core/Security/Identities/{IdentityType} HTTP/1.1 
Host: apex.nikoratrade.ge 
Accept: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	ResponseStatus: 
	{
		ErrorCode: String,
		Message: String,
		StackTrace: String,
		Errors: 
		[
			{
				ErrorCode: String,
				FieldName: String,
				Message: String,
				Meta: 
				{
					String: String
				}
			}
		],
		Meta: 
		{
			String: String
		}
	},
	Result: 
	[
		{
			Id: 0,
			Name: String,
			Description: String,
			IsRole: False,
			IsGranted: False,
			UserInfo: 
			{
				UserId: 0,
				UserName: String,
				Email: String,
				Name: String,
				LastName: String,
				LastLoginAttempt: 0001-01-01,
				InvalidLoginAttempts: 0,
				Blocked: False,
				CreatedDate: 0001-01-01,
				ModifiedDate: 0001-01-01,
				LockedDate: 0001-01-01,
				PhoneNumber: String,
				BirthDate: 0001-01-01,
				Language: String,
				EmailConfirmed: False,
				IsSysAdmin: False,
				UserData: String,
				DisplayName: String,
				MaxSessionCount: 0
			}
		}
	]
}