Log in
Skip to sidebar
Skip to main content
Linked Applications
Loading…
Confluence
Spaces
Create
Create
Hit enter to search
Help
Online Help
Keyboard Shortcuts
Feed Builder
What’s new
Available Gadgets
About Confluence
Log in
Profile-API documentation
Pages
Profile-API documentation Home
Profile api configuration
Registration Flow with different configurations
Registration Flow with different configurations
search
attachments
weblink
advanced
image-effects
image-attributes
Paragraph
Paragraph
Heading 1
Heading 2
Heading 3
Heading 4
Heading 5
Heading 6
Preformatted
Quote
Bold
Italic
Underline
Colour picker
More colours
Formatting
Strikethrough
Subscript
Superscript
Monospace
Clear formatting
Bullet list
Numbered list
Task list
Outdent
Indent
Align left
Align center
Align right
Page layout
Link
Table
Insert
Insert content
Files and images
Link
Markup
Horizontal rule
Task list
Date
Emoticon
Symbol
Insert macro
User mention
Jira Issue/Filter
Info
Status
Gallery
Table of Contents
Other macros
Page layout
No layout
Two column (simple)
Two column (simple, left sidebar)
Two column (simple, right sidebar)
Three column (simple)
Two column
Two column (left sidebar)
Two column (right sidebar)
Three column
Three column (left and right sidebars)
Undo
Redo
Find/Replace
Keyboard shortcuts help
You are not logged in. Any changes you make will be marked as
anonymous
. You may want to
Log In
if you already have an account.
This page is also being edited by
. Your changes will be merged with theirs when you save.
<h2><span style="color: rgb(0,51,102);"><span>systemBehaviorConfigurations</span>:</span></h2><pre><span style="color: rgb(0,51,102);">referralSystemEnabled: boolean(true/false) -> Referral system in ProfileApi that awards bonuses to users if someone used their referral code during registration.</span><br /><span style="color: rgb(0,51,102);">referralProperty:</span><br /><span style="color: rgb(0,51,102);"> referralCodeLength: int </span><br /><span style="color: rgb(0,51,102);"> referralStartBonus: int </span><br /><span style="color: rgb(0,51,102);"> registrationBonus: int</span><br /><span style="color: rgb(0,51,102);">multifactorAuthentication:</span><br /><span style="color: rgb(0,51,102);"> multifactorAuthSystemEnabled: boolean(true/false) -> Multi factor authentication during login flow</span></pre><pre><span style="color: rgb(0,51,102);">registration:</span><br /><span style="color: rgb(0,51,102);"> emailRegistrationEnabled: boolean(true/false) -> Registration via email</span><br /><span style="color: rgb(0,51,102);"> phoneRegistrationEnabled: boolean(true/false) -> Registration via phone number</span><br /><span style="color: rgb(0,51,102);"> registrationViaInviteLinkEnabled: boolean(true/false) -> Registration Via Invite link FLOW </span><br /><span style="color: rgb(0,51,102);"> registrationWithVerificationEnabled: boolean(true/false) -> Default Registration FLOW</span><br /><span style="color: rgb(0,51,102);">oauth2:</span><br /><span style="color: rgb(0,51,102);"> facebook: true -> Login via Facebook. If a user logs in for the first time, we automatically register him.</span><br /><span style="color: rgb(0,51,102);"> google: true -> Login via Google. If a user logs in for the first time, we automatically register him.</span></pre><p><br /></p><h2><br />Registration FLOW</h2><p><strong><span style="color: rgb(255,0,0);"><span style="color: rgb(0,0,0);">registrationWithVerificationEnabled</span>: true</span></strong></p><p><br /></p><h2>First step → start registration operation</h2><p><strong>endpoint → <span style="color: rgb(255,0,0);">/api/v1/registration</span></strong></p><h5>Request body:</h5><p><br /></p><hr /><p>{</p><pre>"userKey": "a.kinashchuk@gmail.com" or "+123456789" -> email or phone number</pre><pre>"referralCode": null -> <strong>OPTIONAL</strong></pre><pre>}</pre><ul><li><span style="color: rgb(0,51,102);">emailRegistrationEnabled: true</span></li><li><span style="color: rgb(0,51,102);">phoneRegistrationEnabled: true</span></li><li><span style="color: rgb(0,51,102);">referralSystemEnabled: true</span><span style="color: rgb(0,0,255);"><br /></span></li></ul><hr /><p><br /></p><p><br /></p><p><br /></p><hr /><p>{</p><pre>"userKey": "+12345678" -> <strong>ONLY PHONE NUMBER!</strong></pre><pre>"referralCode": null -> <strong>OPTIONAL</strong></pre><pre>}</pre><ul><li><span style="color: rgb(0,51,102);">emailRegistrationEnabled: <span style="color: rgb(255,0,0);"><strong>false</strong></span></span></li><li><span style="color: rgb(0,51,102);">phoneRegistrationEnabled: true</span></li><li><span style="color: rgb(0,51,102);">referralSystemEnabled: true</span></li></ul><hr /><p><br /></p><p><br /></p><p><br /></p><hr /><p>{</p><pre>"userKey": "a.kinashchuk@gmail.com" -> <strong>ONLY EMAIL!</strong></pre><pre>"referralCode": null -> <strong>OPTIONAL</strong></pre><pre>}</pre><ul><li><span style="color: rgb(0,0,0);">emailRegistrationEnabled: true</span></li><li><span style="color: rgb(0,0,0);">phoneRegistrationEnabled: <span style="color: rgb(255,0,0);"><strong>false</strong></span></span></li><li><span style="color: rgb(0,0,0);">referralSystemEnabled: true</span></li></ul><p><br /></p><hr /><p><span style="color: rgb(0,0,255);"><br /></span></p><p><span style="color: rgb(0,0,255);"><br /></span></p><p><span style="color: rgb(0,0,255);"><br /></span></p><p><br /></p><hr /><p>{</p><pre>"userKey": "a.kinashchuk@gmail.com" or "+123456789" -> email or phone number</pre><pre>}<br />Referral System is not present in Profile-API</pre><ul><li><span style="color: rgb(0,0,0);">emailRegistrationEnabled: false</span></li><li><span style="color: rgb(0,0,0);">phoneRegistrationEnabled: true</span></li><li><span style="color: rgb(0,0,0);">referralSystemEnabled: <span style="color: rgb(255,0,0);"><strong>false</strong></span></span></li></ul><pre><br /></pre><hr /><h5><span style="color: rgb(255,0,0);">Response</span></h5><h5><span style="color: rgb(152,118,170);">"<span style="color: rgb(128,0,128);">processingId</span>"</span><span style="color: rgb(204,120,50);">: </span><span style="color: rgb(204,120,50);"><span style="color: rgb(106,135,89);">"</span></span>8bfd90a9-949b-42e6-aae4-1690ce339721" -> <span style="color: rgb(0,0,0);"><strong>UUID format</strong></span></h5><pre><br /></pre><p><br /></p><h2>Second step → send registration one time token</h2><p><strong>endpoint: → <span style="color: rgb(255,0,0);">/api/v1/token/registration/verification/{processingId}</span></strong></p><p><em><strong>processingId -> Processing after first step.</strong></em></p><h5><span style="color: rgb(255,0,0);"><strong>Response</strong></span> <br /><span style="color: rgb(128,0,128);">Http.OK(200)</span></h5><p><br /></p><p><br /></p><h2>Third step → verify registration one time token</h2><p><strong>endpoint → <span style="color: rgb(255,0,0);">/api/v1/registration/verification</span></strong></p><p>Request body:</p><p><br /></p><hr /><p>{</p><pre>"processingId": "processingId", -> Processing after first step.</pre><pre>"oneTimeToken": "123456", -> Token that came to you on your userKey. (Valid token -> 6 digits)</pre><pre>"isMfaEnabled": true -> OPTIONAL!!!</pre><pre>}</pre><ul><li><span style="color: rgb(0,0,0);">multifactorAuthSystemEnabled: true </span></li></ul><pre><br /></pre><pre><strong>if user sets the isMFAEnabled attribute to true, then MfaStep is enabled for the userKey under which he registers (mail or phone). And when logging in, he will need to request a token for verification.</strong></pre><hr /><p>{</p><pre>"processingId": "processingId", -> Processing after first step.</pre><pre>"oneTimeToken": "{{123456}", -> Token that came to you on your userKey. (Valid token -> 6 digits)</pre><pre>}</pre><ul><li><span style="color: rgb(0,0,0);">multifactorAuthSystemEnabled: </span><span style="color: rgb(255,0,0);"><strong>false → <span style="color: rgb(0,0,0);">In this case, mfa is disabled in our system. And the user will not need to request tokens for verification when logging in.</span></strong></span><span style="color: rgb(255,0,0);"><strong><br /></strong></span></li></ul><hr /><p><br /></p><h5><span style="color: rgb(255,0,0);">Response</span> </h5><h5><span style="color: rgb(153,51,102);">Http.OK(200)</span></h5><pre><br /></pre><h2>Final Step -> provide password and confirm registration</h2><p><strong>endpoint → <span style="color: rgb(255,0,0);">/api/v1/registration/confirmation</span></strong></p><p>Request body:</p><pre>{<br />"processingId": "processingId", -> Processing after first step.</pre><pre><br />"password": "Qwerty123-" -> Valid password</pre><pre>}</pre><p><br /></p><h5><span style="color: rgb(255,0,0);">Response</span>:</h5><p><strong><span style="color: rgb(153,51,102);">Http.OK(200)</span></strong></p><h2><span style="color: rgb(255,0,0);"><em>The user has been successfully registered.</em></span></h2><p><br /></p><p><br /></p><p><br /></p><p><br /></p><p><br /></p><p><br /></p><p><br /></p><p><br /></p><p><br /></p><p><br /></p><p><br /></p><h2>Invite Registration FLOW</h2><pre><strong>registrationViaInviteLinkEnabled: <span style="color: rgb(255,0,0);">true</span></strong></pre><h2>FIRST STEP</h2><p><strong>endpoint → <span style="color: rgb(106,135,89);">/api/v1/account/invite → </span>private endpoint. This means this operation is only available to authorized users.</strong></p><p><br /></p><p>Request Body: </p><pre>{</pre><pre>"email" : "new-user-by-invitation@gmail.com"</pre><pre>} </pre><p><br /></p><p><strong><span style="color: rgb(255,0,0);">Response</span></strong></p><p><strong><span style="color: rgb(255,0,0);"><span style="color: rgb(153,51,102);">Http.OK(200)</span> <span style="color: rgb(0,0,0);">-></span> <span style="color: rgb(0,0,0);">A invite link will be sent to the email address you provided in your request.</span></span></strong></p><pre><br /></pre><h2>Second Step → open invite link with encrypted token</h2><p><strong>endpoint → <span style="color: rgb(255,0,0);">/api/v1/registration/link?</span></strong><span style="color: rgb(255,0,0);">token=</span></p><p>token = <strong>T</strong><strong>his is an encrypted token that stores information about who the invitation was sent to and the expiration time of this invitation.</strong></p><h5><span style="color: rgb(255,0,0);">Response</span></h5><h5><span style="color: rgb(152,118,170);">"<span style="color: rgb(128,0,128);">processingId</span>"</span><span style="color: rgb(204,120,50);">: </span><span style="color: rgb(204,120,50);"><span style="color: rgb(106,135,89);">"</span></span>8bfd90a9-949b-42e6-aae4-1690ce339721" -> <span style="color: rgb(0,0,0);"><strong>UUID format</strong></span></h5><pre><br /></pre><h5><span style="color: rgb(23,43,77);">Third step → send registration one time token</span></h5><p><strong>endpoint: → <span style="color: rgb(255,0,0);">/api/v1/token/registration/verification/{processingId}</span></strong></p><p><em><strong>processingId -> Processing after first step.</strong></em></p><h5><span style="color: rgb(255,0,0);">Response Http.OK(200)</span></h5><p><br /></p><h2><span style="color: rgb(68,68,68);">Fourth</span> step → verify registration one time token</h2><p><strong>endpoint → <span style="color: rgb(255,0,0);">/api/v1/registration/verification</span></strong></p><p>Request body:</p><p><br /></p><hr /><p>{</p><pre>"processingId": "processingId", -> Processing after first step.</pre><pre>"oneTimeToken": "123456", -> Token that came to you on your userKey. (Valid token -> 6 digits)</pre><pre>"isMfaEnabled": true -> OPTIONAL!!!</pre><pre>}</pre><ul><li><span style="color: rgb(0,0,0);">multifactorAuthSystemEnabled: true </span></li></ul><pre><br /></pre><pre><strong>if user sets the isMFAEnabled attribute to true, then MfaStep is enabled for the userKey under which he registers (mail or phone). And when logging in, he will need to request a token for verification.</strong></pre><hr /><p>{</p><pre>"processingId": "processingId", -> Processing after first step.</pre><pre>"oneTimeToken": "{{123456}", -> Token that came to you on your userKey. (Valid token -> 6 digits)</pre><pre>}</pre><ul><li><span style="color: rgb(0,0,0);">multifactorAuthSystemEnabled: </span><span style="color: rgb(255,0,0);"><strong>false → <span style="color: rgb(0,0,0);">In this case, mfa is disabled in our system. And the user will not need to request tokens for verification when logging in.</span></strong></span><span style="color: rgb(255,0,0);"><strong><br /></strong></span></li></ul><hr /><p><br /></p><h5><span style="color: rgb(255,0,0);">Response</span> </h5><h5><span style="color: rgb(153,51,102);">Http.OK(200)</span></h5><h2>Final Step -> provide password and confirm registration</h2><p><strong>endpoint → <span style="color: rgb(255,0,0);">/api/v1/registration/confirmation</span></strong></p><p>Request body:</p><pre>{<br />"processingId": "processingId", -> Processing after first step.</pre><pre>"password": "Qwerty123-" -> Valid password</pre><pre>}</pre><h5><span style="color: rgb(255,0,0);">Response</span>:</h5><p><strong><span style="color: rgb(153,51,102);">Http.OK(200)</span></strong></p><h2><span style="color: rgb(255,0,0);"><em>The user has been successfully registered.</em></span></h2><h5><span style="color: rgb(106,135,89);"><br /></span></h5><p><br /></p><p><br />Validation Patterns → <a href="https://docs.google.com/document/d/1uNrAO3Adzzkfxad9Hl0qZxTjUnYPmIa0Xr-lKP8Ej0E/edit?pli=1#heading=h.6yz86caf2j1r">https://docs.google.com/document/d/1uNrAO3Adzzkfxad9Hl0qZxTjUnYPmIa0Xr-lKP8Ej0E/edit?pli=1#heading=h.6yz86caf2j1r</a></p><p><br /></p>
Edit
Preview
Save
Close
{"serverDuration": 74, "requestCorrelationId": "eed95c1e75f5fa07"}