POST api/2.0/authentication

Description

Authenticates the current user by SMS, authenticator app, or without two-factor authentication.

Parameters
Name Description Type Example
userName
sent in body
User name or email string some text
password
sent in body
Password string some text
provider
sent in body
Social media provider type string some text
accessToken
sent in body
Provider token string some text
codeOAuth
sent in body
Code for getting a token string some text
Example
POST api/2.0/authentication
Host: yourportal.onlyoffice.com
Content-Type: application/json
Accept: application/json

{
  "userName": "some text",
  "password": "some text",
  "provider": "some text",
  "accessToken": "some text",
  "codeOAuth": "some text"
}
Returns

Authentication token to use in the 'Authorization' header when calling API methods

Example Response

application/json

{
  "status": 0,
  "response": {
    "Token": "abcde12345",
    "Expires": "2020-11-24T05:36:20.4206897Z",
    "Sms": true,
    "PhoneNoise": "8(999)999-99-99",
    "Tfa": true,
    "TfaKey": "123dwa"
  }
}

text/xml

<result>
  <status>0</status>
  <response>
    <Token>abcde12345</Token>
    <Expires>2020-11-24T05:36:20.4206897Z</Expires>
    <Sms>True</Sms>
    <PhoneNoise>8(999)999-99-99</PhoneNoise>
    <Tfa>True</Tfa>
    <TfaKey>123dwa</TfaKey>
  </response>
</result>