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 new endpoints.
Profile api new endpoints.
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>Token API</h2><p>Token API is a special API for requesting and getting one-time tokens for different operations regarding a user's profile.</p><h4>Unauthorized user</h4><p>Operations:</p><p><br /></p><ul><li><strong>Registration</strong><ul><li><span style="color: rgb(0,51,102);">api/v1/token/registration/{{processingId}} - </span>registration OTT (email or phone number, depending on which option has been chosen by the user) <br /><br />responseBody: {<br /> "<span style="color: rgb(0,0,0);">destination</span>": "email@gmail.com/+123456789", <br /> "expiration": "30min."<br /> }<br /><br /></li></ul></li></ul><ul style="list-style-type: square;"><li><strong>Login</strong> | <span style="color: rgb(0,0,255);">switchable depends on MFA</span><ul style="list-style-type: square;"><li>api/v1/token/login - get email/phone number OTT (MFA) <br /><br />requestBody: {<br /> "<span style="color: rgb(0,51,102);">destination</span>": "EMAIL/PHONE_NUMBER", <br /> "processingId": UUID<br /> }<br /><br />responseBody: {<br /> "<span style="color: rgb(0,51,102);">destination</span>": "email/phoneNumber",<br /> "expiration": "30min."<br /> }<br /><br /></li></ul></li><li><strong>Reset password</strong><ul style="list-style-type: square;"><li>api/v1/token/password/recovery - get OTT (email or phone number, depending on which option has been chosen by the user) <br /><br />requestBody: {<br /> "<span style="color: rgb(0,51,102);">destination</span>": "EMAIL/PHONE_NUMBER",<br /> "processingId": UUID<br /> }<br />responseBody: {<br /> "<span style="color: rgb(0,51,102);">destination</span>": "email/phoneNumber",<br /> "expiration": "30min."<br /> }<br /><br /></li></ul></li><li><strong>User key recovery </strong>| <span style="color: rgb(0,0,255);">switchable depends on MFA </span><br /><ul style="list-style-type: square;"><li>api/v1/token/userKeys/recovery/verification - get email/phone number OTT for verification + validate if recovered type not passed as OTT<br /><br />requestBody: {<br /> "processingId": UUID<br /> } <br /><br />responseBody: {<br /> "<span style="color: rgb(0,51,102);">destination</span>": "email/phoneNumber",<br /> "expiration" "30min.": <br /> }<br /><br /></li><li>api/v1/token/userKeys/recovery/new<span style="color: rgb(0,0,0);">Key - </span>get email/phone number OTT for changing user key<br /><br />requestBody: {<br /> "<span style="color: rgb(0,0,0);">destination</span>": "email@gmail.com/+123456789", <br /> "processingId": UUID<br /> } <br /><br />responseBody: {<br /> "expiration": "30min."<br /> }<br /><br /></li></ul></li></ul><h4>Authorized user</h4><p>Operations:</p><ul style="list-style-type: square;"><li><strong><span style="color: rgb(0,0,0);">Change password</span></strong><ul style="list-style-type: square;"><li>api/v1/token/password/changing - get OTT (email by default, if there is no email, then phone number) <br /><br />responseBody: {<br /> "<span style="color: rgb(0,0,0);">destination</span>": "email@gmail.com/+123456789",<br /> "expiration": "30min"<br /> }<br /><br /></li></ul></li></ul><ul style="list-style-type: square;"><li><strong><span style="color: rgb(0,0,0);">User key management</span></strong><br /><ul style="list-style-type: square;"><li>api/v1/token/userKeys/adding/email?newEmail=email@email.com - get OTT to add new email</li></ul><br /> responseBody: {<br /> "expiration": "30min."<br /> }<br /><br /><ul><li>api/v1/token/userKeys/adding/phoneNumber?newPhoneNumber=+123456789 - get OTT to add new phone_number</li></ul><br /> responseBody: {<br /> "expiration": "30min."<br /> }<br /><br /><ul style="list-style-type: square;"><li>api/v1/token/userKeys/changing?keyType=EMAIL/PHONE_NUMBER - get OTT to change existing email/phone_number + check if MFA for a chosen key is disabled, if not then firstly user has to disable mfa<br /><br />responseBody: {<br /> "expiration": "30min."<br /> }<br /><br /></li><li>api/v1/token/userKeys/changing/newKey - get OTT for a new email/phone_number to complete the user key changing flow</li></ul><br /> requestBody: {<br /> "oneTimeToken": "previous step ott",<br /> "<span style="color: rgb(0,0,0);">newUserKey</span>": "email@gmail.com/+123456789"<br /> }<br /><br /><ul style="list-style-type: square;"><li>api/v1/token/userKeys/removing?keyType=EMAIL/PHONE_NUMBER - get OTT to remove user email/phone_number + check if MFA for a chosen key is disabled, if not then firstly user has to disable mfa <br /><br />responseBody: {<br /> "expiration": "30min."<br /> }<br /><br /><br /></li></ul></li><li><strong>Anti-phishing code</strong> | <span style="color: rgb(0,0,255);">switchable depends on anti-phishing</span><ul style="list-style-type: square;"><li><span style="color: rgb(0,0,255);"><span style="color: rgb(0,0,0);">"api/v1/token/antiPhishing/changing" - get OTT to change anti-phishing code (works only through email)</span></span><br /><span style="color: rgb(0,0,255);"><span style="color: rgb(0,0,0);"><br />responseBody: {<br /> "expiration": "30min."<br /> }</span></span></li><li><span style="color: rgb(0,0,255);"><span style="color: rgb(0,0,0);"><span style="color: rgb(0,0,255);"><span style="color: rgb(0,0,0);">"api/v1/token/antiPhishing/adding" - get OTT to add anti-phishing code (works only through email)</span></span><br /><span style="color: rgb(0,0,255);"><span style="color: rgb(0,0,0);"><br />responseBody: {<br /> "expiration": "30min."<br /> }</span></span><br /></span><br /></span></li></ul></li><li><strong>Disable MFA</strong> | <span style="color: rgb(0,0,255);">switchable, depends on MFA</span><ul style="list-style-type: square;"><li>api/v1/token/mfa/disabling - get email/phone number OTT + reject if destination MFA is disabled<br /><br />requestBody: {<br /> "<span style="color: rgb(0,0,0);">destination</span>": "EMAIL/PHONE_NUMBER", <br /> }<br /><br />responseBody: {<br /> "<span style="color: rgb(0,51,102);">destination</span>": "email/phoneNumber",<br /> "expiration": "30min."<br /> }</li></ul></li></ul><p><br /></p><p><br /></p><p><br /></p><p><br /></p><p><br /></p><p><br /></p><p><br /></p><p><br /></p>
Edit
Preview
Save
Close
{"serverDuration": 48, "requestCorrelationId": "94c3c00fff4be82e"}