{"_id":"5a0b0d9b04d0d600269f137a","category":{"_id":"5a0b0d9b04d0d600269f1375","version":"5a0b0d9b04d0d600269f1373","project":"573c7e3b9eef3a0e00b51c58","__v":0,"sync":{"url":"","isSync":false},"reference":false,"createdAt":"2016-07-19T14:41:36.843Z","from_sync":false,"order":1,"slug":"integration-guide","title":"Integration Overview"},"project":"573c7e3b9eef3a0e00b51c58","parentDoc":null,"user":"573c7e0afe58321900f1b97d","version":{"_id":"5a0b0d9b04d0d600269f1373","project":"573c7e3b9eef3a0e00b51c58","__v":1,"createdAt":"2017-11-14T15:36:59.500Z","releaseDate":"2017-11-14T15:36:59.500Z","categories":["5a0b0d9b04d0d600269f1374","5a0b0d9b04d0d600269f1375","5a0b0d9b04d0d600269f1376","5a0b0d9b04d0d600269f1377","5a0b0d9b04d0d600269f1378"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":true,"codename":"","version_clean":"2.0.0","version":"2.0"},"githubsync":"","__v":0,"updates":[],"next":{"pages":[],"description":""},"createdAt":"2016-09-13T19:49:38.257Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[]},"settings":"","auth":"required","params":[],"url":""},"isReference":false,"order":0,"body":"Privakey was developed on top of OpenID Connect to help ensure that integrating Privakey with an online system is both straight forward and supported by a broad array of existing open source and commercial authentication systems. At the highest level, integrating Privakey with a Relying Party Service involves:\n\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Steps\"\n}\n[/block]\n1.\tRegistering on Privakey.com to be a Relying Party\n2.\tEnabling the open source OpenID Connect Protocol on your service\n3.\tDeveloping interfaces and controls for Registration, Login, and possibly Account Recovery and Administration\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Resource Requirements\"\n}\n[/block]\nIn order to implement Privakey one needs the following access and resources:\n\n1.\t**The ability to update the codebase that manages authentications to the service.**\nPrivakey either replaces or augments existing authentication methods and therefore needs to be implemented within the services authentication framework.  If a third party service is leveraged to manage the authentication code-base then the service will need their assistance in implementing Privakey.\n\n2.\t**Resources to implement OpenID Connect Protocols (in the programing language / framework of the existing service).**\nPrivakey currently leverages OpenID Connect (OIDC) to broker authentications.  In order to accept Privakey Authentications, services need to implement OpenID Connect protocols.  Minimally, a software developer familiar with and who has access to the codebase that manages authentications to the service.\n\n3.\t**Resources to adapt the User Experience to include Privakey Authentication**\nDepending on the architecture of the system and composition of the development team these resources may be the same as the resource(s) that implement the OpenID Connect Protocols.","excerpt":"","slug":"privakey-integration-overview-and-approach","type":"basic","title":"Privakey Integration Overview and Approach"}

Privakey Integration Overview and Approach


Privakey was developed on top of OpenID Connect to help ensure that integrating Privakey with an online system is both straight forward and supported by a broad array of existing open source and commercial authentication systems. At the highest level, integrating Privakey with a Relying Party Service involves: [block:api-header] { "type": "basic", "title": "Steps" } [/block] 1. Registering on Privakey.com to be a Relying Party 2. Enabling the open source OpenID Connect Protocol on your service 3. Developing interfaces and controls for Registration, Login, and possibly Account Recovery and Administration [block:api-header] { "type": "basic", "title": "Resource Requirements" } [/block] In order to implement Privakey one needs the following access and resources: 1. **The ability to update the codebase that manages authentications to the service.** Privakey either replaces or augments existing authentication methods and therefore needs to be implemented within the services authentication framework. If a third party service is leveraged to manage the authentication code-base then the service will need their assistance in implementing Privakey. 2. **Resources to implement OpenID Connect Protocols (in the programing language / framework of the existing service).** Privakey currently leverages OpenID Connect (OIDC) to broker authentications. In order to accept Privakey Authentications, services need to implement OpenID Connect protocols. Minimally, a software developer familiar with and who has access to the codebase that manages authentications to the service. 3. **Resources to adapt the User Experience to include Privakey Authentication** Depending on the architecture of the system and composition of the development team these resources may be the same as the resource(s) that implement the OpenID Connect Protocols.