API documentation for AD sync through AuthX
- Get group and model for mapping
- Get list of users for the requested group
- Get the list of users using External Id
- Ondemand sync
Get group and model for mapping
Properties | Values |
---|---|
Request URL | https://admin.authx.com/ep/api/getCustomMappingAttributesXT |
Request method | Post |
Request Headers | XTApplicationKey: 45217533-76a8-c3ce-0c61-8e4fa8b21d86XTSecretKey: 62e65386-178b-55c3-b533-5c45bdb03ac4XTHostName: 7mx8p4wf |
Request Body | None |
Response: If successful, this method returns a response_code 1 and collection of groups objects and model on AuthX side in the response body.
The following is an example of the response which includes only the requested properties.
{
"response_code": 1,
"response_subcode": 0,
"response_text": null,
"response_data": {
"MappingAttribute": null,
"GroupId": null,
"GroupName": null,
"Model": {
"azureGroupId": "",
"azureGroupName": "",
"displayName": "",
"mail": "",
"objectId": "",
"objectType": "",
"telephoneNumber": "",
"mobile": "",
"onPremisesDistinguishedName": "",
"signInNames": "",
"userState": "",
"sAMAccountName": "",
"RFIDCode": ""
},
"AdditionalAttributesModel": null,
"GroupNameList": [
{
"GroupId": "6861cb4a-490d-4379-8c84-393c5480c6ab",
"GroupName": "EPCS Enroller",
"LastId": 0,
"externalId": null
},
{
"GroupId": "702a0bb0-a8be-428d-a7ed-d27f8013d786",
"GroupName": "Test Group",
"LastId": 0,
"externalId": null
}
],
"UsersList": null,
"UserNameList": null,
"CompanyName": "8 parche",
"AdditionalAttribute": null
}
}
Get list of users for the requested group
Properties | Values |
---|---|
Request URL | https://admin.authx.com/ep/api/XTgetUserListbyGroupName |
Request method | Post |
Request Headers | XTApplicationKey: 45217533-76a8-c3ce-0c61-8e4fa8b21d86XTSecretKey: 62e65386-178b-55c3-b533-5c45bdb03ac4XTHostName: 7mx8p4wf |
Request Body | { "GroupNameList": [ { "GroupName": "EPCS Enroller", "GroupId": "6861cb4a-490d-4379-8c84-393c5480c6ab", "LastId": 0 } ] } |
Response: If successful, this method returns a response_code 1 and collection of Users objects under UserNameList on AuthX side in the response body.
The following is an example of the response which includes only the requested properties.
{
"response_code": 1,
"response_subcode": 0,
"response_text": null,
"response_data": {
"MappingAttribute": null,
"GroupId": null,
"GroupName": null,
"Model": null,
"AdditionalAttributesModel": null,
"GroupNameList": null,
"UsersList": null,
"UserNameList": [
"[{\"InternalID\":5516,\"azureGroupId\":\"6861cb4a-490d-4379-8c84-393c5480c6ab\",\"azureGroupName\":\"EPCS Enroller\",\"displayName\":\"Jacob Saji\",\"mail\":\"saji@rabbittrak.com\",\"id\":\"978eb0e9-3c20-4059-9120-4392e60e998f\",\"mobilePhone\":\"+1123123\",\"CustomField\":null,\"RFIDCode\":\"\",\"ManagerName\":null,\"userPrincipalName\":null},{\"InternalID\":5517,\"azureGroupId\":\"6861cb4a-490d-4379-8c84-393c5480c6ab\",\"azureGroupName\":\"EPCS Enroller\",\"displayName\":\"Shreyas\",\"mail\":\"shreyas@rabbittrak.com\",\"id\":\"e11503ba-520d-462c-a366-a5bb11b2e2dd\",\"mobilePhone\":\"+1123123\",\"CustomField\":null,\"RFIDCode\":\"\",\"ManagerName\":null,\"userPrincipalName\":null}]"
],
"CompanyName": null,
"AdditionalAttribute": null
}
}
Get the list of users using ExternalId
This particular API will be used whenever any user we Add,Delete and Update on AD side and same will be got added on the Certify.me side when schedule job will run on Authx side.
Properties | Values |
---|---|
Request URL | https://admin.authx.com/ep/api/XTgetUserListbyGroupName |
Request method | Post |
Request Headers | XTApplicationKey: 45217533-76a8-c3ce-0c61-8e4fa8b21d86XTSecretKey: 62e65386-178b-55c3-b533-5c45bdb03ac4XTHostName: 7mx8p4wf |
Request Body | { "GroupNameList": [ { "GroupId": "6114dc08-1025-4406-a723-02d7b87e0fce", "GroupName": "EPCS Enroller", "LastId": 0, "externalId":["79747dcd-48ec-41f8-bb96-86396d608ae5"] } ] } |
Response: If successful, this method returns a response_code 1 and collection of Users objects under UserNameList on AuthX side in the response body.
The following is an example of the response which includes only the requested properties.
{
"response_code": 1,
"response_subcode": 0,
"response_text": null,
"response_data": {
"MappingAttribute": null,
"GroupId": null,
"GroupName": null,
"Model": null,
"AdditionalAttributesModel": null,
"GroupNameList": null,
"UsersList": null,
"UserNameList": [
"[{\"InternalID\":0,\"azureGroupId\":\"702a0bb0-a8be-428d-a7ed-d27f8013d786\",\"azureGroupName\":\"Test Group\",\"mail\":\"amit.singh@certifyglobal.com\",\"id\":\"79747dcd-48ec-41f8-bb96-86396d608ae5\",\"CustomField\":null,\"RFIDCode\":\"\",\"ManagerName\":null,\"userPrincipalName\":null,\"displayName\":\"Amit Kumar\",\"mobilePhone\":\"+1123123\"}]"
],
"CompanyName": null,
"AdditionalAttribute": null
}
}
Ondemand sync
This API wiil be used when we Add,Delete and Update any user on the AD side and we want that data quickly in the Authx side
Properties | Values |
---|---|
Request URL | https://api.authx.com/ProcessAzureGroups |
Request method | Post |
Request Headers | XTApplicationKey: 45217533-76a8-c3ce-0c61-8e4fa8b21d86XTSecretKey: 62e65386-178b-55c3-b533-5c45bdb03ac4XTHostName: 7mx8p4wf |
Request Body | { "AzureDirectory": [ { "DirectoryName": "EPCS Physician", "Identifier": "9ecab175-c7b2-4dda-bdfb-355e12f701a1" } ] } |
Response: If successful, this method returns a Code 1 in the response body.
The following is an example of the response which includes only the requested properties.
{
"Message": null,
"Code": 1,
"SharedKey": null,
"Totp": null,
"IsValidOTP": false,
"BioIndex": 0,
"UserDetails": null,
"Token": null,
"SourceApplication": null,
"CodeId": null,
"DocumentSign": null,
"BioFace": null,
"LicenseFile": null,
"ApplicationKey": null,
"SecretKey": null,
"BioSettings": null,
"ServerIV": null,
"UserDetailsList": null,
"TPUserModels": null,
"UserId": 0,
"CompanyId": 0,
"RsaEncryptValue": null,
"FaceMatch": false,
"StatusMessage": null,
"FaceTemplate1": null,
"FaceQuality": 0.0,
"SettingsValue": null,
"RegisteredTemplateResponse": null,
"PhoneNumber": null,
"RequestId": null,
"FaceBio": null,
"SessionId": null
}