Troubleshooting Web Component Fabric Services

You can troubleshoot and debug web component fabric services issues, allowing you to examine the response codes of fabric services associated with the following web components:

Onboarding Component

Name Operation Name Service Type Description Steps Response Body

ClientAuthIdentityWrapper

getClientBearerToken

Integration

 Integration Wrapper of ClientIdentity.

  1. Access the Fabric Console.

  2. Navigate to Environment.

  3. Select the appropriate environment.

  4. Click on App Service option.

  5. Choose Integration Services from the left-side navigation drawer.

  6. Locate and select ClientAuthIdentityWrapper and choose the operation getClientBearerToken.

  7. Click on the Get Response Button.
Copy 
"{  ""access_token"":""ViH8HAAAAYhnZGb42alIiKeForHJlUXk/c1HpTIp"",
    ""opstatus"":0,""expires_in"":""3600"",
    ""httpStatusCode"":200
}"
HIDApproveInitiation initiate Integration Sends an HID Approve Push notification to the user's registered device.

  1. Access the Fabric Console.

  2. Navigate to Environment.

  3. Select the appropriate environment.

  4. Click on App Service option.

  5. Choose Integration Services from the left-side navigation drawer.

  6. Search for HIDApproveInitiation and select the operation initiate.

  7. Provide the Username and Device Id, then click on the Get Response button.
Copy 
"{
    ""auth_req_id"":""f1686ebb-bf4e-4491-b69e-c173d6602329"",
    ""opstatus"":0,""interval"":0,""expires_in"":3600,""httpStatusCode"":200
}"
OTPServices sendOOB Integration Sends an OOB OTP to the user.

  1. Access the Fabric Console.

  2. Navigate to Environment.

  3. Select the appropriate environment.

  4. Click on App Service option.

  5. Choose Integration Services from the left-side navigation drawer.

  6. Search for OTPServices and select the operation sendOOB.

  7. Click on the Get Response button.
Copy 
"{
    ""active"":""true"",
    ""opstatus"":0,""id"":""312652.AT_OOBSMS"",
    ""httpStatusCode"":201
}"
ScimAPIs SearchUser Integration Searches for the user.

  1. Acces the Fabric Console.

  2. Navigate to Environment.

  3. Select the appropriate environment.

  4. Click on App Service option.

  5. Choose Integration Services from the left-side navigation drawer.

  6. Search for ScimAPIs and select the operation searchUser.

  7. Enter the filter = "externalId eq fabricTestUser" and click on the Get Response button.
Copy 
"{
    ""totalResults"":""1"",
    ""active"":""true"",
    ""opstatus"":0,""AddedFrom"":""accessed from Cache"",
    ""userId"":""317054"",
    ""httpStatusCode"":200
}"
ScimAPIs createNewDevice Integration Creates a new Device ID for the user.

  1. Acces the Fabric Console.

  2. Navigate to Environment.

  3. Select the appropriate environment.

  4. Click on App Service option.

  5. Choose Integration Services from the left-side navigation drawer.

  6. Search for ScimAPIs and select the operation createNewDevice.

  7. Enter the username and deviceType = DT_TDSV4B and click on the Get Response button
Copy 
"{
    ""deviceIdOrch"":""317055"",
    ""DeviceId"":""317055"",
    ""opstatus"":0,""AddedFrom"":""accessed from Cache"",
    ""httpStatusCode"":200
}"
ScimAPIs getPasswordPolicy Integration Provides the Password policy.

  1. Access the Fabric Console.

  2. Navigate to Environment.

  3. Select the appropriate environment.

  4. Click on App Service option.

  5. Choose Integration Services from the left-side navigation drawer.

  6. Search for ScimAPIs and select the operation getPasswordPolicy.

  7. Click on the Get Response button.
Copy 
"{
    ""minDiffChars"":""5"",
    ""minLength"":""8"",
    ""notUserAttribute"":""true"",
    ""notEnglish"":""true"",
    ""opstatus"":0,""AddedFrom"":""accessed from Cache"",
    ""maxLength"":""100"",
    ""notSequence"":""true"",
    ""httpStatusCode"":200
}"
ScimAPIs fetchUserDetails Integration Fetch for the user details.

  1. Access the Fabric Console.

  2. Navigate to Environment.

  3. Select the appropriate environment.

  4. Click on App Service option.

  5. Choose Integration Services from the left-side navigation drawer.

  6. Search for ScimAPIs and select the operation fetchUserDetails.

  7. Enter the parameters and click on the Get Response button.
Copy 
"{
    ""schemas"":[""urn:ietf:params:scim:api:messages:2.0:ListResponse
    ""],""totalResults"":1,""resources"":[
    {
        ""schemas"":[""urn:ietf:params:scim:schemas:core:2.0:User"",
        ""urn:hid:scim:api:idp:2.0:UserDevice"",
        ""urn:hid:scim:api:idp:2.0:UserAttribute"",
        ""urn:hid:scim:api:idp:2.0:UserAuthenticator""],
        ""id"":""317054"",
        ""externalId"":""fabricTestUser"",
        ""meta"":
        {
            ""resourceType"":""User"",
            ""created"":""2023-05-29T00:00:00Z"",
            ""location"":""https://test.aaas.hidcloud.com
            /scim/td8357334g93845683786587/v2/Users/317054"",
            ""version"":""1""
        }
,""userName"":""fabricTestUser"",
        ""name"":
        {
            ""familyName"":""familyName"",
            ""givenName"":""firstName""
        }
,""displayName"":""firstName familyName"",
        ""active"":true,""emails"":[
        {
            ""value"":""testemail@gmail.com""
        }
],""phoneNumbers"":[
        {
            ""value"":""9347291086""
        }
],""groups"":[
        {
            ""type"":""Group"",
            ""display"":""ROOT"",
            ""value"":""UG_ROOT"",
            ""$ref"":""https://test.aaas.hidcloud.com
            /scim/td8357334g93845683786587/v2/Groups/UG_ROOT""
        }
],""roles"":[],""urn:hid:scim:api:idp:2.0:UserAttribute"":
        {
            ""attributes"":[
            {
                ""name"":""ATR_EMAIL"",
                ""type"":""string"",
                ""value"":""testemail@gmail.com"",
                ""readOnly"":false
            }
,
            {
                ""name"":""ATR_MOBILE"",
                ""type"":""string"",
                ""value"":""9347291086"",
                ""readOnly"":false
            }
,
            {
                ""name"":""FIRSTNAME"",
                ""type"":""string"",
                ""value"":""firstName"",
                ""readOnly"":false
            }
,
            {
                ""name"":""IS_ACTIVE"",
                ""type"":""string"",
                ""value"":""true"",
                ""readOnly"":false
            }
,
            {
                ""name"":""LASTNAME"",
                ""type"":""string"",
                ""value"":""familyName"",
                ""readOnly"":false
            }
]
        }
,""urn:hid:scim:api:idp:2.0:UserAuthenticator"":
        {
            ""authenticators"":[]
        }
,""urn:hid:scim:api:idp:2.0:UserDevice"":
        {
            ""devices"":[]
        }

    }
],""itemsPerPage"":1
}"
ScimAPIs searchDevice Integration Search for the device.

  1. Access the Fabric Console.

  2. Navigate to Environment.

  3. Select the appropriate environment.

  4. Click on App Service option.

  5. Choose Integration Services from the left-side navigation drawer.

  6. Search for ScimAPIs and select the operation searchDevice.

  7. Enter the parameters and click on the Get Response button.
Copy 
"{
    ""totalResults"":""1"",
    ""opstatus"":0,""resources"":[
    {
        ""deviceType"":""DT_TDSV4B"",
        ""externalId"":""fabricTestUser"",
        ""id"":""317055"",
        ""status"":
        {
            ""active"":false,""status"":""PENDING""
        }

    }
],""AddedFrom"":""accessed from Cache"",
    ""httpStatusCode"":200
}"
ScimAPIs updateDeviceStatus Integration Updates the device status.

  1. Access the Fabric Console.

  2. Navigate to Environment.

  3. Select the appropriate environment.

  4. Click on App Service option.

  5. Choose Integration Services from the left-side navigation drawer.

  6. Search for ScimAPIs and select the operation updateDeviceStatus.

  7. Enter the Device ID and Status and click on the Get Response button.
Copy 
"{
    ""active"":""true"",
    ""opstatus"":0,""type"":""DT_TDSV4B"",
    ""httpStatusCode"":200
}"
ScimAPIsOrg addOOBAuthenticator Integration Adds the OOB Authenticator.

  1. Access the Fabric Console.

  2. Navigate to Environment.

  3. Select the appropriate environment.

  4. Click on App Service option.

  5. Choose Integration Services from the left-side navigation drawer.

  6. Search for ScimAPIsOrg and select the operation addOOBAuthenticator.

  7. Enter the parameters and click on the Get Response button.
Copy 
"{
    ""active"":""true"",
    ""opstatus"":0,""AddedFrom"":""accessed from Cache"",
    ""id"":""312652.AT_OOBSMS"",
    ""httpStatusCode"":201
}"
OnboardingValidation validateUser Orchestration Adds a Password Authenticator.

  1. Access the Fabric Console.

  2. Navigate to Environment.

  3. Select the appropriate environment.

  4. Click on App Service option.

  5. Choose Orchestration Services from the left-side navigation drawer.

  6. Search for OnboardingValidation and select the operation validateUser.

  7. Enter the parameters and click on the Get Response button.
Copy 
"{
    ""activationAuthStatus"":""true"",
    ""consecutiveSuccess"":0,""opstatus_getActivationCodeAuthenticator
    "":0,""opstatus_login"":0,""authenticators"":[
    {
        ""display"":""AT_OOBSMS""
    }
,
    {
        ""display"":""AT_SMK""
    }
,
    {
        ""display"":""AT_PASAIDP""
    }
,
    {
        ""display"":""AT_TDS""
    }
,
    {
        ""display"":""AT_PASA""
    }
,
    {
        ""display"":""AT_EMPOTP""
    }
,
    {
        ""display"":""AT_EMPOTPI""
    }
,
    {
        ""display"":""AT_ACTPWD""
    }
],""id_token"":"""",
    ""active"":""true"",
    ""AddedFrom"":""accessed from Cache"",
    ""token_type"":""Bearer"",
    ""userId"":""312652"",
    ""expiryDate"":""2042-05-15T18:15:21Z"",
    ""consecutiveFailed"":0,""access_token"":
    ""hoZDAgAAAYhn4y2dz/HuLGetUwvg+x0LqfJPJNDQ"",
    ""totalResults"":""1"",
    ""opstatus"":0,""opstatus_SearchUser"":0,""expires_in"":""3600"",
    ""validationStatus"":""success"",
    ""httpStatusCode"":200
}"
PushDeviceRegistrationOrch getInviteCode Orchestration Provisioning Push Device.

  1. Access the Fabric Console.

  2. Navigate to Environment.

  3. Select the appropriate environment.

  4. Click on App Service option.

  5. Choose Orchestration Services from the left-side navigation drawer.

  6. Search for PushDeviceRegistrationOrch and select the operation getInviteCode.

  7. Enter the parameters and click on the Get Response button.
Copy 
"{
    ""deviceIdOrch"":""317096"",
    ""DeviceId"":""317096"",
    ""opstatus_updateDevice"":0,""opstatus"":0,""
    opstatus_createNewDevice"":0,""AddedFrom"":""
    accessed from Cache"",
    ""provisionMsg"":""
    {
        ""ver"":""v8"",
        ""url"":""test.aaas.hidcloud.com/td7f7131a5289307306696"",
        ""uid"":""testuser"",
        ""did"":""317096"",
        ""dty"":""DT_TDSV4B"",
        ""dir"":""78060"",
        ""pch"":""CH_TDSPROV"",
        ""pth"":""AT_TDSOOB"",
        ""sec"":"""",
        ""pss"":""M01CVlhVTVFBMA==""
    }
"",
    ""opstatus_getProvisonMsg"":0,""httpStatusCode"":200
}"

User Authentication Component

Name Operation Name Service Type Description Steps Response

ClientAuthIdentityWrapper

getClientBearerToken

Integration

 Integration Wrapper of ClientIdentity.

  1. Access the Fabric Console.

  2. Navigate to Environment.

  3. Select the appropriate environment.

  4. Click on App Service option.

  5. Select Integration Services from the left-side navigation drawer.

  6. Search for ClientAuthIdentityWrapper and select the operation getClientBearerToken.

  7. Click on the Get Response button.
Copy 
"{
    ""access_token"":""ViH8HAAAAYhn9hLk/FgQ21H/YQC3UuCLMGWHsY38"",
    ""opstatus"":0,""expires_in"":""3600"",
    ""httpStatusCode"":200
}"
HIDApproveInitiation initiate Integration Sends an HID Approve Push notification to the user's registered device.

  1. Access the Fabric Console.

  2. Navigate to Environment.

  3. Select the appropriate environment.

  4. Click on App Service option.

  5. Select Integration Services from the left-side navigation drawer.

  6. Search for HIDApproveInitiation and select the operation initiate.

  7. Enter the Username and Device Id and click on the Get Response button.
Copy 
"{
    ""auth_req_id"":""f1686ebb-bf4e-4491-b69e-c173d6602329"",
    ""opstatus"":0,""interval"":0,""expires_in"":3600,
    ""httpStatusCode"":200
}"
SearchPushDevicesOrch getDevices Orchestration Orchestration to fetch the user id and then gets the list of devices associated with the user.

  1. Access the Fabric Console.

  2. Navigate to Environment.

  3. Select the appropriate environment.

  4. Click on App Service option.

  5. Choose Orchestration Services from the left-side navigation drawer.

  6. Search for SearchPushDevicesOrch and select the operation getDevices.

  7. Enter the Username and Device Id and click on the Get Response button.
Copy 
"{
    ""totalResults"":""1"",
    ""opstatus_SearchUserAuth"":0,""errmsg_SearchDeviceAuth"":
    ""Malformed JSON Response. Path must not end with a '.' 
    or '..'"",
    ""externalId"":""testuser"",
    ""opstatus"":1582,""errmsg"":""One or more of the services
    failed in composite service."",
    ""id"":""312652"",
    ""opstatus_SearchDeviceAuth"":6002,""httpStatusCode"":200
}"

User Management Component

Name Operation Name Service Type Description Steps Response

UserManagementService

SearchUser

Integration

 Performs a user search.

  1. Access the Fabric Console.

  2. Navigate to Environment.

  3. Select the appropriate environment.

  4. Click on App Service option.

  5. Choose Integration Services from the left-side navigation drawer.

  6. Search for UserManagementService and select the operation SearchUser.

  7. Enter the parameters and click on the Get Response button.
Copy 
"{
    ""totalResults"":""1"",
    ""UserId"":""312652"",
    ""authenticators"":[
    {
        ""display"":""AT_TDSOOB""
    }
,
    {
        ""display"":""AT_OOBSMS""
    }
,
    {
        ""display"":""AT_SMK""
    }
,
    {
        ""display"":""AT_PASAIDP""
    }
,
    {
        ""display"":""AT_TDS""
    }
,
    {
        ""display"":""AT_PASA""
    }
,
    {
        ""display"":""AT_EMPOTP""
    }
,
    {
        ""display"":""AT_EMPOTPI""
    }
,
    {
        ""display"":""AT_ACTPWD""
    }
],""active"":""true"",
    ""opstatus"":0,""httpStatusCode"":200
}"
ChangePassword changeUserPassword Orchestration Changes the user's password.

  1. Access the Fabric Console.

  2. Navigate to Environment.

  3. Select the appropriate environment.

  4. Click on App Service option.

  5. Select Orchestration Services from the left-side navigation drawer.

  6. Search for ChangePassword and select the operation changeUserPassword.

  7. Enter the parameters and click on the Get Response button.
Copy 
"{
    ""opstatus_changePassword"":-1,""authenticators"":[
    {
        ""display"":""AT_TDSOOB""
    }
,
    {
        ""display"":""AT_OOBSMS""
    }
,
    {
        ""display"":""AT_SMK""
    }
,
    {
        ""display"":""AT_PASAIDP""
    }
,
    {
        ""display"":""AT_TDS""
    }
,
    {
        ""display"":""AT_PASA""
    }
,
    {
        ""display"":""AT_EMPOTP""
    }
,
    {
        ""display"":""AT_EMPOTPI""
    }
,
    {
        ""display"":""AT_ACTPWD""
    }
],""active"":""true"",
    ""errmsg"":""One or more of the services failed in composite 
    service."",
    ""AddedFrom"":""accessed from Cache"",
    ""totalResults"":""1"",
    ""ChangePasswordError"":""Static password Authenticator does 
    not exist"",
    ""UserId"":""312652"",
    ""opstatus"":-1,""errmsg_changePassword"":""Static password 
    Authenticator does not exist"",
    ""opstatus_SearchUser"":0,""httpStatusCode"":200,""status"":
    ""false""
}"
SearchDervices SearchDevices Orchestration Searches for the device.

  1. Access the Fabric Console.

  2. Navigate to Environment.

  3. Select the appropriate environment.

  4. Click on App Service option.

  5. Select Orchestration Services from the left-side navigation drawer.

  6. Search for SearchDevices and select the operation searchDevices.

  7. Enter the parameters and click on the Get Response button.
Copy 
"{
    ""totalResults"":""1"",
    ""opstatus_SearchUserAuth"":0,""errmsg_SearchDeviceAuth"":
    ""Malformed JSON Response. Path must not end with a '.' or 
    '..'"",
    ""externalId"":""testuser"",
    ""opstatus"":1582,""errmsg"":""One or more of the services 
    failed in composite service."",
    ""id"":""312652"",
    ""opstatus_SearchDeviceAuth"":6002,""httpStatusCode"":200
}"
ScimAPIs createNewDevice Integration Creates a new DeviceId.

  1. Access the Fabric Console.

  2. Navigate to Environment.

  3. Select the appropriate environment.

  4. Click on App Service option.

  5. Select Integration Services from the left-side navigation drawer.

  6. Search for ScimAPIs and select the operation createNewDevice.

  7. Enter the parameters and click on the Get Response button.
Copy 
"{
    ""deviceIdOrch"":""317334"",
    ""DeviceId"":""317334"",
    ""opstatus"":0,""AddedFrom"":""accessed from Cache"",
    ""httpStatusCode"":200
}"
ScimAPIs updateDeviceStatus Integration Updates the device status.

  1. Access the Fabric Console.

  2. Navigate to Environment.

  3. Select the appropriate environment.

  4. Click on App Service option.

  5. Select Integration Services from the left-side navigation drawer.

  6. Search for ScimAPIs and select the operation updateDeviceStatus.

  7. Enter the parameters and click on the Get Response button.
Copy 
"{
    ""active"":""true"",
    ""opstatus"":0,""type"":""DT_TDSV4B"",
    ""httpStatusCode"":200
}"