{"_id":"5a0b0d9b04d0d600269f1385","category":{"_id":"5a0b0d9b04d0d600269f1376","version":"5a0b0d9b04d0d600269f1373","project":"573c7e3b9eef3a0e00b51c58","__v":0,"sync":{"url":"","isSync":false},"reference":false,"createdAt":"2016-09-13T19:58:29.432Z","from_sync":false,"order":2,"slug":"itegration-guide","title":"Integration Guide"},"project":"573c7e3b9eef3a0e00b51c58","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,"parentDoc":null,"updates":[],"next":{"pages":[],"description":""},"createdAt":"2016-09-13T20:04:55.015Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[]},"settings":"","auth":"required","params":[],"url":""},"isReference":false,"order":1,"body":"Before a Relying Party application can use Privakey’s authentication system for user login, it must register with Privakey and obtain Open ID Connect credentials, set one or more Callback URIs (see Develop Interfaces and Controls for more information), and (optionally) customize the branding information that its users see on the Privakey-presented user-authentication screen. \n\nThe process is straight forward and can be accessed from the Privakey User Portal.  \n\n1.  Download and Register the Privakey Application for iOS, Android or Windows\n[block:html]\n{\n  \"html\": \"<div style=\\\"text-align: center;\\\">\\n\\n<a title=\\\"Get Privakey in the Apple App Store\\\" href=\\\"https://itunes.apple.com/us/app/privakey/id968897948?mt=8\\\" target=\\\"_blank\\\"><img class=\\\"wp-image-3799 alignnone\\\" src=\\\"https://privakey.com/wp-content/uploads/2015/08/app_store-300x89.png\\\" alt=\\\"Get Privakey in the Apple App Store\\\" width=\\\"200\\\" height=\\\"59\\\" /></a>\\n\\n<a title=\\\"Get Privakey on Google Play\\\" href=\\\"https://play.google.com/store/apps/details?id=com.probaris.mid&amp;utm_source=global_co&amp;utm_medium=prtnr&amp;utm_content=Mar2515&amp;utm_campaign=PartBadge&amp;pcampaignid=MKT-AC-global-none-all-co-pr-py-PartBadges-Oct1515-1\\\" target=\\\"_blank\\\"><img style=\\\"border: #B7B7B7 solid 1px; border-radius: 7px; width: 198px; height: 57px;\\\" src=\\\"https://play.google.com/intl/en_us/badges/images/apps/en-play-badge.png\\\" alt=\\\"Get Privakey on Google Play\\\" /></a>\\n\\n<a title=\\\"Get Privakey in the Windows Store\\\" href=\\\"https://www.microsoft.com/en-us/store/p/privakey/9nblggh4nc64\\\" target=\\\"_blank\\\"><img style=\\\"height: 57px; width: 187px; background: white; border-radius: 7px; border: 1px solid #B7B7B7;\\\" src=\\\"https://s3.amazonaws.com/privakey-prod-wordpress/wp-content/uploads/2016/12/21170047/windows-store-badge.png\\\" alt=\\\"Get Privakey in the Windows Store\\\" /></a>\\n\\n</div>\\n\"\n}\n[/block]\n2.  Log In to Privakey, https://www.privakey.com\n[block:image]\n{\n  \"images\": [\n    {\n      \"image\": [\n        \"https://files.readme.io/95aa651-Picture1.png\",\n        \"Picture1.png\",\n        424,\n        308,\n        \"#60514e\"\n      ],\n      \"caption\": \"www.privakey.com\"\n    }\n  ]\n}\n[/block]\n\n[block:image]\n{\n  \"images\": [\n    {\n      \"image\": [\n        \"https://files.readme.io/014e3f4-Picture2.png\",\n        \"Picture2.png\",\n        407,\n        309,\n        \"#f2f2f2\"\n      ]\n    }\n  ]\n}\n[/block]\n3. Select  ‘Learn More’ from the section “Become a Relying Party”\n[block:image]\n{\n  \"images\": [\n    {\n      \"image\": [\n        \"https://files.readme.io/b5b10d9-Picture3.png\",\n        \"Picture3.png\",\n        424,\n        367,\n        \"#f36255\"\n      ],\n      \"caption\": \"Privakey Account Management\"\n    }\n  ]\n}\n[/block]\n\n[block:callout]\n{\n  \"type\": \"warning\",\n  \"title\": \"Generate a Recovery Key!\",\n  \"body\": \"If you haven't generated a recovery key we strongly advice you do so.  \\n\\nPrivakey's strong authentication requires you have a device configured with Privakey.  A recovery key is a last resort in case you mislaid, replaced or damaged  your Privakey devices.  \\n\\nWe also recomend you configure Privakey on more than one account.  To learn more visit http://support.privakey.com\"\n}\n[/block]\n\n[block:image]\n{\n  \"images\": [\n    {\n      \"image\": [\n        \"https://files.readme.io/d35272c-Picture4.png\",\n        \"Picture4.png\",\n        424,\n        369,\n        \"#f66c45\"\n      ],\n      \"caption\": \"Becoming a Relying Party\"\n    }\n  ]\n}\n[/block]\n4. Fill out additional information and review and accept our terms of service to establish a relying party account.\n\n5. At this point the Relying Party Administration Screen is available.  On this screen, one adds and manages Relying Parties and Callback URIs (URIs to which a user returns, with references to their Token, after a successful Authentication on Privakey - see Develop Interface and Controls for more information).  \n[block:image]\n{\n  \"images\": [\n    {\n      \"image\": [\n        \"https://files.readme.io/46772b3-Picture5.png\",\n        \"Picture5.png\",\n        386,\n        332,\n        \"#f46255\"\n      ]\n    }\n  ]\n}\n[/block]\n6. Click, ‘Add a New Relying Party’ to configure your Relying Party. This will bring up the following page, on which one enters information about the Service:\n[block:image]\n{\n  \"images\": [\n    {\n      \"image\": [\n        \"https://files.readme.io/e912e53-Picture6.png\",\n        \"Picture6.png\",\n        608,\n        547,\n        \"#ece9e8\"\n      ]\n    }\n  ]\n}\n[/block]\nThe sections required to configure a Relying Party include: \n\n**Friendly Name:**  This is how the service will present on the end-user’s pending authentication page and Privakey Apps. \n\n**Logo:**  Optionally, one can upload a logo that will appear on the pending authentication page presented to users during authentications.\n\n**Call Back URI:**  URI’s to which a user returns, with references to their Token, after a successful Authentication on Privakey (See Develop Interface and Controls for more information).  A Service may have more than one callback URI.\n\n**Require PIN?:**  Privakey Authentications can be configured to require or not require the use of a PIN during authentications.  For secure Authentications, the use of a PIN is recommended.  However, there may be certain instances where a service may want a more convenient method of user authentication.  This is configured for each Callback URI, so a service can leverage both methods; for example, requiring a PIN to log in to the account but not requiring a PIN to process a transaction once logged in.\n\n**Implicit Flow:**  Privakey supports two OpenID Connect Protocols: Code Flow and Implicit Flow.  More information about these different protocols can be found on OpenID.org.  Privakey recommends Code Flow, as it is a more secure protocol.  This configuration, once enabled, allows only Implicit Flow and not Code Flow.\n\nA Relying Party can be edited and augmented after configuration.","excerpt":"","slug":"register-to-become-a-privakey-relying-party","type":"basic","title":"Register to become a Privakey Relying Party"}

Register to become a Privakey Relying Party


Before a Relying Party application can use Privakey’s authentication system for user login, it must register with Privakey and obtain Open ID Connect credentials, set one or more Callback URIs (see Develop Interfaces and Controls for more information), and (optionally) customize the branding information that its users see on the Privakey-presented user-authentication screen. The process is straight forward and can be accessed from the Privakey User Portal. 1. Download and Register the Privakey Application for iOS, Android or Windows [block:html] { "html": "<div style=\"text-align: center;\">\n\n<a title=\"Get Privakey in the Apple App Store\" href=\"https://itunes.apple.com/us/app/privakey/id968897948?mt=8\" target=\"_blank\"><img class=\"wp-image-3799 alignnone\" src=\"https://privakey.com/wp-content/uploads/2015/08/app_store-300x89.png\" alt=\"Get Privakey in the Apple App Store\" width=\"200\" height=\"59\" /></a>\n\n<a title=\"Get Privakey on Google Play\" href=\"https://play.google.com/store/apps/details?id=com.probaris.mid&amp;utm_source=global_co&amp;utm_medium=prtnr&amp;utm_content=Mar2515&amp;utm_campaign=PartBadge&amp;pcampaignid=MKT-AC-global-none-all-co-pr-py-PartBadges-Oct1515-1\" target=\"_blank\"><img style=\"border: #B7B7B7 solid 1px; border-radius: 7px; width: 198px; height: 57px;\" src=\"https://play.google.com/intl/en_us/badges/images/apps/en-play-badge.png\" alt=\"Get Privakey on Google Play\" /></a>\n\n<a title=\"Get Privakey in the Windows Store\" href=\"https://www.microsoft.com/en-us/store/p/privakey/9nblggh4nc64\" target=\"_blank\"><img style=\"height: 57px; width: 187px; background: white; border-radius: 7px; border: 1px solid #B7B7B7;\" src=\"https://s3.amazonaws.com/privakey-prod-wordpress/wp-content/uploads/2016/12/21170047/windows-store-badge.png\" alt=\"Get Privakey in the Windows Store\" /></a>\n\n</div>\n" } [/block] 2. Log In to Privakey, https://www.privakey.com [block:image] { "images": [ { "image": [ "https://files.readme.io/95aa651-Picture1.png", "Picture1.png", 424, 308, "#60514e" ], "caption": "www.privakey.com" } ] } [/block] [block:image] { "images": [ { "image": [ "https://files.readme.io/014e3f4-Picture2.png", "Picture2.png", 407, 309, "#f2f2f2" ] } ] } [/block] 3. Select ‘Learn More’ from the section “Become a Relying Party” [block:image] { "images": [ { "image": [ "https://files.readme.io/b5b10d9-Picture3.png", "Picture3.png", 424, 367, "#f36255" ], "caption": "Privakey Account Management" } ] } [/block] [block:callout] { "type": "warning", "title": "Generate a Recovery Key!", "body": "If you haven't generated a recovery key we strongly advice you do so. \n\nPrivakey's strong authentication requires you have a device configured with Privakey. A recovery key is a last resort in case you mislaid, replaced or damaged your Privakey devices. \n\nWe also recomend you configure Privakey on more than one account. To learn more visit http://support.privakey.com" } [/block] [block:image] { "images": [ { "image": [ "https://files.readme.io/d35272c-Picture4.png", "Picture4.png", 424, 369, "#f66c45" ], "caption": "Becoming a Relying Party" } ] } [/block] 4. Fill out additional information and review and accept our terms of service to establish a relying party account. 5. At this point the Relying Party Administration Screen is available. On this screen, one adds and manages Relying Parties and Callback URIs (URIs to which a user returns, with references to their Token, after a successful Authentication on Privakey - see Develop Interface and Controls for more information). [block:image] { "images": [ { "image": [ "https://files.readme.io/46772b3-Picture5.png", "Picture5.png", 386, 332, "#f46255" ] } ] } [/block] 6. Click, ‘Add a New Relying Party’ to configure your Relying Party. This will bring up the following page, on which one enters information about the Service: [block:image] { "images": [ { "image": [ "https://files.readme.io/e912e53-Picture6.png", "Picture6.png", 608, 547, "#ece9e8" ] } ] } [/block] The sections required to configure a Relying Party include: **Friendly Name:** This is how the service will present on the end-user’s pending authentication page and Privakey Apps. **Logo:** Optionally, one can upload a logo that will appear on the pending authentication page presented to users during authentications. **Call Back URI:** URI’s to which a user returns, with references to their Token, after a successful Authentication on Privakey (See Develop Interface and Controls for more information). A Service may have more than one callback URI. **Require PIN?:** Privakey Authentications can be configured to require or not require the use of a PIN during authentications. For secure Authentications, the use of a PIN is recommended. However, there may be certain instances where a service may want a more convenient method of user authentication. This is configured for each Callback URI, so a service can leverage both methods; for example, requiring a PIN to log in to the account but not requiring a PIN to process a transaction once logged in. **Implicit Flow:** Privakey supports two OpenID Connect Protocols: Code Flow and Implicit Flow. More information about these different protocols can be found on OpenID.org. Privakey recommends Code Flow, as it is a more secure protocol. This configuration, once enabled, allows only Implicit Flow and not Code Flow. A Relying Party can be edited and augmented after configuration.