Passing authentication

The user needs to perform several easy steps to pass authentication:

  1. Send POST request, containing the userName and password parameters to the api/2.0/authentication address:

    Authentication Request:

    POST /api/2.0/authentication.json HTTP/1.1
    Host: yourportal.onlyoffice.com
    Content-Type: application/json
    Accept: application/json
    
    {
        "userName": "yourusername",
        "password": "yourpassword"
    }
    

    Please note, that you have to enter your own portal address to the Host: yourportal.onlyoffice.com line instead of yourportal.onlyoffice.com address.

    Response:

    HTTP/1.1 201 Created
    Cache-Control: private
    Content-Type: application/json; charset=utf-8
    {
        "count": 1,
        "response": {
            "expires": "2010-07-07T17:06:03.5845502+03:00",
            "token": "sdjhfskjdhkqy739459234"
        },
        "status": 0,
        "statusCode": 201
    }
    
  2. In case authentication is successful, a token which will look like sdjhfskjdhkqy739459234 will be received.

  3. Use this token every time you call API methods inserting it to the Authorization HTTP header:

    Sample API Request:

    GET /api/2.0/people/@self.json HTTP/1.1
    Host: yourportal.onlyoffice.com
    Accept: application/json
    Authorization: sdjhfskjdhkqy739459234
    

    Please note, that you have to enter your own portal address to the Host: yourportal.onlyoffice.com line instead of yourportal.onlyoffice.com address.

Authentication request examples

C# authentication request example

var request = System.Net.WebRequest.Create("https://yourportal.onlyoffice.com/api/2.0/authentication.json");
request.Method = "POST";
request.ContentType = "application/json";

var body = "{\"userName\":\"yourusername\",\"password\":\"yourpassword\"}";
var data = System.Text.Encoding.UTF8.GetBytes(body);

request.ContentLength = data.Length;
using (var stream = request.GetRequestStream())
{
    stream.Write(data, 0, data.Length);
}

var response = (System.Net.HttpWebResponse)request.GetResponse();
var responseString = new StreamReader(response.GetResponseStream()).ReadToEnd();

Please note, that you have to enter your own portal address instead of yourportal.onlyoffice.com address.

cURL authentication request example

curl --request POST --header "Content-Type: application/json" --data "{\"username\":\"yourusername\",\"password\":\"yourpassword\"}" "https://yourportal.onlyoffice.com/api/2.0/authentication.json"

Please note, that you have to enter your own portal address instead of yourportal.onlyoffice.com address.

Get Help

  • If you have any questions about ONLYOFFICE Workspace, try the FAQ section first.
  • You can request a feature or report a bug by posting an issue on GitHub.
  • You can also ask our developers on ONLYOFFICE forum (registration required).