NoPass™ API Integration

Portal Authentication APIs

These are a set of APIs that need to be integrated into the backend of your website.  With the help of these APIs, your website will be registered on the NoPass™ server, and you will be able to check that the rightful website has been registered. Then a connection will be established between the NoPass™ authentication server and your website for future steps.

1. CONFIRM PORTAL PREREGISTRATION

Description

This method is called during the portal registration to validate the Admin Login (AdminId) which was set during the portal registration in the server installation. So once upon registration, the admin code has to be entered and sent to the NoPass™ authentication server for validation.

This method is initiated from the NoPass™ Admin Console.

Relative URL

/api/PortalCommunication/ConfirmPreRegistration

‎Request

• HTTP request method   

POST

• Content Type

/application/json-patch+json

• Body

{
 "adminId": "string",
 "r": "int"
 }

Response

• Response code

Response code 200 means that the request was processed without any errors. Anything other than 200 means something was wrong with the parameters during validation

• Response format

Text/Plain

Response body

{
 "errors":[
    {
   "code":"string",
   "message":"string"
    }
],
 "result":{
  "adminId": "string",
  "sCode": "string",
  "r": 0
    }
}

• Example

https://MyWebSite/api/PortalCommunication/ConfirmPreRegistration

2. CONFIRM PORTAL REGISTRATION

Server

https://console.nopass.us/

Description

This method is called after the pre-registration step described above. This method is required to validate the unique identification number of your website (portalId) which was assigned to your website by the NoPass™ server during the portal registration in the server installation, along with this portalId setting of your website that is also sent from the NoPass™ authentication server after validation.

Relative URL

/api/PortalCommunication/ConfirmRegistration

Request

• HTTP request method   

POST

• Content Type

/application/json-patch+json

• Body

{
  "settings": "string",
  "portalId": "string",
  "authToken": "string"
}

Response

• Response code

Response code 200 means that the request was processed without any errors.  Anything other than 200 means something was wrong with the parameters during validation

• Response format

Text/Plain

Response body

{
 "errors":[
    {
     "code": "string"
     "message": "string"
    }
 ]
"result": {
"sCode": "string"
          }
  }

• Example

https://MyWebSite/api/PortalCommunication/ConfirmRegistration

3. Update Picture/Code

Server

https://console.nopass.us/

Description

This API is called after the expiration of the time of the image and code received from the NoPass™ server during an authentication attempt. The image and code should be shown on your website’s login page so that the user can compare the image and code with the image and code that is generated on their NoPass™ mobile app on the mobile device.

Relative URL

/api/PortalCommunication/UpdatePicture

Request

• HTTP request method   

POST

• Content Type

/application/json-patch+json

• Body

{
  "authId": "string",
  "image": "string",
  "nextChange": "int",
  "UserId": "string"
}

Response

• Response code

Response code 200 means that the request was processed without any errors. Anything other than 200 means something was wrong with the parameters during validation

• Content Type

application/json

Response body

{

 "errors":[

  {

   "code":"string",

   "message":"string"

  }

],

"result":"string"

}

• Example

https://MyWebSite/api/PortalCommunication/UpdatePicture

4. VALIDATE USER REGISTRATION

Description

This method is called when the NoPass™ authentication server is attempting to check whether the user can be created on the portal side (your side). This means that if the registration is initiated from the NoPass™ server, such a user is allowed to be registered on your website (portal), concerning both cases when the registration is initiated by the portal or by the NoPass™ server sides.

Relative URL

/api/PortalCommunication/ValidateUserRegistration

Request

• HTTP request method   

POST

• Content Type

/application/json-patch+json

• Body

{

}

Response

• Response code

Response code 200 means that the request was processed without any errors. Anything other than 200 means something was wrong with the parameters during validation

• Content Type

/application/json

Response body

{
 "errors":[
  {
   "code":"string",
   "message":"string"
  }
 ],
 "result":bool
}

• Example

https://MyWebSite/api/PortalCommunication/ValidateUserRegistration

5. CONFIRM USER REGISTRATION

Description

When a user has registered to use NoPass™ passwordless authentication this method is called.

The user can then click the link or scan the QR code via the NoPass™ mobile app so that their new account will be added to NoPass™.

Relative URL

/api/PortalCommunication/ConfirmUserRegistration 

Request

• HTTP request method   

POST

• Content Type

/application/json

• Body

{

}

Response

• Response code

Response code 200 means that the request was processed without any errors. Anything other than 200 means something was wrong with the parameters during validation

• Content Type

application/json

Response body

  {

   "errors": [

    {

     "code":"string",

           "message":"string"

    }

  ]

  "result":"string"

  } 

• Example

https://MyWebSite/api/PortalCommunication/ConfirmUserRegistration

6. AUTHORIZED USER

Description

This method is called when the user’s authorization process is completed.

Relative URL

/api/PortalCommunication/AuthorizedUser 
      

Request

• HTTP request method   

POST

• Content Type

/application/json-patch+json

• Body

{
  "authId": "string",
  "isAuthorized": "bool",
  "reason": "string"
} 

Response

• Response code

Response code 200 means that the request was processed without any errors. Anything other than 200 means something was wrong with the parameters during validation

• Content Type

application/json

Response body

 {

  "errors":[

   {  

     "code":"string",

     "message":"string"

    }  

 ],

 "result":bool

 }

• Example

https://MyWebSite/api/PortalCommunication/AuthorizedUser

7. UPDATE USER

Description

This method is called to check if there is a possibility to update the user’s information.

Relative URL

/api/PortalCommunication/UpdateUser

Request

• HTTP request method   

POST

• Content Type

/application/json-patch+json

• Body

{

} 
      

Response

• Response code

Response code 200 means that the request was processed without any errors. Anything other than 200 means something was wrong with the parameters during validation

• Content Type

application/json

Response body

{

  "errors":[

    {

      "code":"string",

       "message":"string"

      }

   ]

   "result":"string"

 }

• Example

https://MyWebSite/api/PortalCommunication/UpdateUser

8. DELETE USER

Description

This method indicates that a user account in NoPass™ has been deleted.

Relative URL

/api/PortalCommunication/DeleteUser

Request

• HTTP request method   

  POST

   

• Content Type

/application/json-patch+json

• Body

{
  "userId": "string",
  "portalId": "string"
}

Response

• Response code

Response code 200 means that the request was processed without any errors. Anything other than 200 means something was wrong with the parameters during validation

• Content Type

application/json

Response body

{

  "errors":[

    {

      "code":"string",

       "message":"string"

      }

   ]

   "result":"string"

 }

• Example

https://MyWebSite/api/PortalCommunication/DeleteUser
‎
‎

9. add  USERs 

Description

This method is called when the NoPass™ authentication server is attempting to  add users. 

Relative URL

/api/PortalCommunication/AddUsers

Request

• HTTP request method   

  POST

   

• Content Type

/application/json-patch+json

• Body

model:{
      users:[
            user:{
   

    }

Response

• Response code

Response code 200 means that the request was processed without any errors. Anything other than 200 means something was wrong with the parameters during validation

• Content Type

/application/json

Response body

model:{
  "errors":[
  {
   "code":"string",
   "message":"string"
  }
 ],
 "result":bool
}

• Example

https://MyWebSite/api/PortalCommunication/AddUsers

10. close session

Description

When the user chooses to close the session in the NoPass™ system, the portal should do the following:

Procedure

1. The portal must receive a POST request from the NoPass™ server to close the session.

URL

/api/PortalCommunication/CloseSession

Request

• Content Type

application/json-patch+json

• Body 

 {

 "userId": "string",

  "portalId": "string",

  "authId": "string"

}

Response

• Response code

Response code 200 means that the request was processed without any errors. Anything other than 200 means something was wrong with the parameters during validation

• Response format

Text/Plain

• Response body

{

"errors": [

    {

      "code": "string",

      "message": "string"

    }

  ],

  "result": true

}

• Example

https://MyWebSite/api/PortalCommunication/CloseSession
‎

11. Disable service

Description

This method is called during portal deletion to mark that the portal can no longer use the NoPass™ API. This method is initiated from the NoPass™ Admin Console.

Relative URL

/api/PortalCommunication/DisableService

Request

• HTTP request method

        POST

• Content Type

application/json-patch+json

• Body 

  {

"portalId": "string"

   }

Response

• Response code

Response code 200 means that the request was processed without any errors. Anything other than 200 means something was wrong with the parameters during validation

• Response format

application/json

• Response body

 {

"true/false"

}

Example

https://MyWebSite/api/PortalCommunication/DisableService
‎

‎next topic: Additional APIs for PaaS

previous topic: NoPass™ UI Configuration

‎

‎