UserLogin

POST - /user/login

Required Permissions:

scope:app
scope:app.userauth

Description

Logs a user into the Canary Speech Active Directory system. Used for user authentication in an application setting.

Headers

Header Key	Description	Example
Authorization	The Authorization header for this endpoint. The value must be the token from the /v3/auth/tokens/get endpoint and given using the Bearer pattern.	Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdW...

Body Parameters

Name	Type	Description
* username	string	The username of the user.
* password	string	The password of the user.

Successful Response

A successful response

Field Name	Type	Description
idToken	string	The active directory ID token of the user.
accessToken	string	The active directory access token for this login session.
refreshToken	string	The active directory refresh token for this login session.
expiresIn	int32	The length of time in seconds for which the tokens are valid.
databaseId	uuid	The database ID associated with the user.

Code Example

cURL

curl \
  -X POST "https://rest.eus.canaryspeech.com/v2/user/login" \
  -H "Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c" \
  -d "{ \"username\": \"abc123\", \"password\": \"abc123\" }"

JavaScript (Fetch)

function postV2UserLogin() {

  const url = 'https://rest.eus.canaryspeech.com/v2/user/login';
  
  const headers = {
    Authorization: 'Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c'
  };
  
  const body = { username: 'abc123', password: 'abc123' };
  
  fetch(url, {
    method: 'POST',
    headers: headers,
    body: JSON.stringify(body)
  }).then((response) => {
    if (!response.ok) throw new Error(response.status);
    return response.json()
  }).then((json) => {
    const { idToken, accessToken, refreshToken, expiresIn, databaseId } = json;
    // ...
  });
}

JavaScript (Node)

const https = require('https');

function postV2UserLogin() {

  
  const headers = {
    Authorization: 'Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c'
  };
  
  const body = { username: 'abc123', password: 'abc123' };
  
  const options = {
    hostname: 'rest.eus.canaryspeech.com',
    port: 443,
    path: '/v2/user/login',
    method: 'POST',
    headers: headers
  };
  
  const request = https.request(options, (response) => {
    if (response.statusCode !== 200) throw new Error(response.statusCode);
    
    response.on('data', (d) => {
      const { idToken, accessToken, refreshToken, expiresIn, databaseId } = JSON.parse(d);
      // ...
    });
  });
  
  request.on('error', (err) => {
    throw new Error(err);
  });
  
  request.write(JSON.stringify(body));
  request.end();
  
}

JavaScript (Axios)

const axios = require('axios').default;

async function postV2UserLogin() {

  const url = 'https://rest.eus.canaryspeech.com/v2/user/login';
  
  const headers = {
    Authorization: 'Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c'
  };
  
  const body = { username: 'abc123', password: 'abc123' };
  
  const response = await axios.post(url, body, { headers });
  
  if (response.status !== 200) throw new Error(response.status);
  
  const { idToken, accessToken, refreshToken, expiresIn, databaseId } = response.data;
  
  // ...
}

TypeScript (Node)

import * as https from 'https';

function postV2UserLogin(): void {

  
  const headers = {
    Authorization: 'Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c'
  };
  
  const body = { username: 'abc123', password: 'abc123' };
  
  const options = {
    hostname: 'rest.eus.canaryspeech.com',
    port: 443,
    path: '/v2/user/login',
    method: 'POST',
    headers: headers
  };
  
  const request = https.request(options, (response) => {
    if (response.statusCode !== 200) throw new Error(response.statusCode);
    
    response.on('data', (d) => {
      const { idToken, accessToken, refreshToken, expiresIn, databaseId } = JSON.parse(d) as Record<string, unknown>;
      // ...
    });
  });
  
  request.on('error', (err) => {
    throw new Error(err);
  });
  
  request.write(JSON.stringify(body));
  request.end();
}

TypeScript (Axios)

import axios from 'axios';

async function postV2UserLogin(): Promise<void> {

  const url = 'https://rest.eus.canaryspeech.com/v2/user/login';
  
  const headers = {
    Authorization: 'Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c'
  };
  
  const body = { username: 'abc123', password: 'abc123' };
  
  const response = await axios.post(url, body, { headers });
  
  if (response.status !== 200) throw new Error(response.status);
  
  const { idToken, accessToken, refreshToken, expiresIn, databaseId } = response.data;
  // ...
}

Python (Requests)

import requests

def post_v2_user_login():
    url = 'https://rest.eus.canaryspeech.com/v2/user/login'
    
    headers = {
        'Authorization': 'Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c'
    }
    
    body = {
        'username': 'abc123',
        'password': 'abc123'
    }
    
    response = requests.post(
        url,
        headers=headers,
        data=body,
    )
    
    if response.status_code !== 200:
        raise Exception(response.status_code)
    
    response_obj = response.json()
    id_token = response_obj['idToken']
    access_token = response_obj['accessToken']
    refresh_token = response_obj['refreshToken']
    expires_in = response_obj['expiresIn']
    database_id = response_obj['databaseId']
    
    # ...

Java

import org.json.simple.JSONObject;
import org.json.simple.JSONArray;
import org.json.simple.JSONParser;
import org.json.simple.JSONValue;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpRequest.BodyPublishers;
import java.net.http.HttpResponse;
import java.net.http.HttpResponse.BodyHandlers;
import java.nio.charset.StandardCharsets;
import java.util.List;
import java.util.Map;

public class CanarySpeechApi {

  public void postV2UserLogin() {
    URI uri = new URI("https://rest.eus.canaryspeech.com/v2/user/login");
    
    JSONObject body = new JSONObject();
    body.put("username", "abc123");
    body.put("password", "abc123");
    
    byte[] bodyBytes = JSONValue.toJSONString(body).getBytes(StandardCharsets.UTF_8);
    
    HttpRequest request = HttpRequest.newBuilder()
      .uri(uri)
      .version(HttpClient.Version.HTTP_2)
      .header("Authorization", "Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c")
      .POST(BodyPublishers.ofByteArray(bodyBytes))
      .build();
    
    HttpClient client = HttpClient.newBuilder()
      .version(HttpClient.Version.HTTP_1_1)
      .build();
    
    HttpResponse<String> response = client.send(request, BodyHandlers.ofString());
    
    if (client.status != 200) {
      throw new Exception(client.status.toString());
    }
    
    JSONParser parser = new JSONParser();
    JSONObject responseBody = (JSONObject) parser.parse(client.body());
    String idToken = (String) responseBody.get("idToken");
    String accessToken = (String) responseBody.get("accessToken");
    String refreshToken = (String) responseBody.get("refreshToken");
    Integer expiresIn = (Integer) responseBody.get("expiresIn");
    String databaseId = (String) responseBody.get("databaseId");
    
    // ...
  }

}

Kotlin

import org.json.JSONObject
import java.lang.StringBuilder
import java.net.URL
import javax.net.ssl.HttpsURLConnection

suspend fun postV2UserLogin() = runCatching {
    val url = URL.create("https://rest.eus.canaryspeech.com/v2/user/login")
    with(url.openConnection() as HttpsURLConnection) {
        requestMethod = "POST"
        instanceFollowRedirects = true
        
        setRequestProperty("Authorization", "Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c")
        
        doInput = true
        setChunkedStreamingMode(0)
        
        val body = JSONObject()
        body.put("username", String("abc123"))
        body.put("password", String("abc123"))
        
        outputStream.bufferedWriter(Charsets.UTF_8).use {
            it.write(body.toString())
            it.flush()
        }
        
        doOutput = true
        
        if (responseCode != 200) throw Error(responseMessage)
        
        val buffer = StringBuilder()
        var line: String?
        inputStream.bufferedReader(Charsets.UTF-8).use {
            do {
                line = it.readLine()
                if (line != null) buffer.appendLine(line)
            } while (line != null)
        }
        
        val responseBody = JSONObject(buffer.toString())
        val idToken = responseBody.get("idToken") as String
        val accessToken = responseBody.get("accessToken") as String
        val refreshToken = responseBody.get("refreshToken") as String
        val expiresIn = responseBody.get("expiresIn") as Int
        val databaseId = responseBody.get("databaseId") as String
        
        // ...
    }
}

Swift (URLSession)

import UIKit

func postV2UserLogin() -> void {
    
    let url = URL("https://rest.eus.canaryspeech.com/v2/user/login")
    
    let headers: [String: String] = [
        "Authorization": "Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c"
    ]
    
    let body: [String: Any] = [ "username": "abc123", "password": "abc123" ]
    
    var request = URLRequest(url: url)
    request.httpMethod = "POST"
    request.allHTTPHeaderFields = headers
    request.httpBody = JSONEncoder().encode(body)
    
    let task = URLSession.shared.dataTask(with: request) { data, response, error in
        guard
            let data = data,
            let response = response as? HTTPURLResponse,
            error == nil
        else {
            print("error", error ?? URLError(.badServerResponse)
            return
        }
        
        guard (200 ... 299) ~= response.statusCode else {
            print("statusCode = \(response.statusCode)")
            print("response = \(response)")
            return
        }
        
        do {
            let responseObj = try JSONDecoder().decode(PostV2UserLoginResponse.self, data)
            // ...
        } catch {
            print(error)
        }
    }
    }
}

struct PostV2UserLoginResponse: Decodable {
    let idToken: String
    let accessToken: String
    let refreshToken: String
    let expiresIn: Int32
    let databaseId: String
}

using System.Collections.Generic;
using System.Net.Http;
using System.Text.Encoding;
using System.Text.Json;
using System.Text.Json.Serialization;

public static class CanarySpeechAPI
{
    public static readonly HttpClient client = new HttpClient();
    
    public static async Task postV2UserLogin()
    {
        var url = "https://rest.eus.canaryspeech.com/v2/user/login\"";
        
        var body = new Dictionary<string, dynamic> {
            { "username": "abc123" },
            { "password": "abc123"
        };
        var bodyString = JsonConvert.Serialize(body);
        
        var request = new HttpRequestMessage(HttpMethod.Post, url);
        request.Headers.Add("Authorization", "Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c");
        request.Content = new ByteArrayContent(Encoding.UTF8.GetBytes(bodyString));
        
        var response = await client.SendAsync(request);
        response.EnsureSuccessStatusCode();
        
        var responseBody = await response.Content.ReadAsStringAsync();
        var responseJson = JsonConvert.DeserializeObject<Dictionary<string, dynamic>>(responseBody);
        var idToken = (String)responseJson["idToken"];
        var accessToken = (String)responseJson["accessToken"];
        var refreshToken = (String)responseJson["refreshToken"];
        var expiresIn = (int)responseJson["expiresIn"];
        var databaseId = (String)responseJson["databaseId"];
        // ...
    }
}

Dart/Flutter

import 'dart:convert';

import 'package:http/http.dart' as http;

Future<void> function postV2UserLogin() async {
  final uri = Uri.https('rest.eus.canaryspeech.com', 'v2/user/login', queryParams);
  
  final headers = {
    'Authorization': 'Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c'
  };
  
  final body =  { 'username': 'abc123', 'password': 'abc123' };
  
  final request = http.Request('POST', uri);
  request.headers.addAll(headers)
  request.body = json.encode(body);
  
  final client = http.Client();
  try {
    final responseStream = await client.send(request);
    final statusCode = responseStream.statusCode;
    
    if (statusCode < 200 || statusCode >= 300) {
      throw Error(statusCode.toString());
    }
    
    final responseBytes = await responseStream.stream.toBytes();
    final responseString = utf8.decode(responseBytes);
    final response = json.decode(responseString);
    
    final idToken = response['idToken'] as String;
    final accessToken = response['accessToken'] as String;
    final refreshToken = response['refreshToken'] as String;
    final expiresIn = response['expiresIn'] as int;
    final databaseId = response['databaseId'] as String;
    
    // ...
  } catch (e) {
    print(e);
  }
}