認証クライアント関連

Register an application

POST/registerApplication

Body

application/json

name*string

Example: "example"

logoURLnullable string

Example: "https://example.com/logo.png"

allowedCallerOrigins*array of string

allowedCallbackURLs*array of string

Response

200400401

Body

application/json

idstring

Example: "QXBwbGljYXRpb246Mg=="

clientIDstring

Example: "CXqlJpKYiXLzVuq3mU49UY5UFn2N3URVt"

namestring

Example: "example"

logoURLnullable string

Example: "https://example.com/logo.png"

allowedCallerOriginsarray of string

allowedCallbackURLsarray of string

registeredAtinteger

Example: 1231006505

Request

JavaScriptCurlPython

const response = await fetch('/registerApplication', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "name": "example",
      "allowedCallerOrigins": [
        "https://example.com"
      ],
      "allowedCallbackURLs": [
        "https://example.com/callback"
      ]
    }),
});
const data = await response.json();

Response

200400401

{
  "id": "QXBwbGljYXRpb246Mg==",
  "clientID": "CXqlJpKYiXLzVuq3mU49UY5UFn2N3URVt",
  "name": "example",
  "logoURL": "https://example.com/logo.png",
  "allowedCallerOrigins": [
    "https://example.com"
  ],
  "allowedCallbackURLs": [
    "https://example.com/callback"
  ],
  "registeredAt": 1231006505
}

Get an application by client ID

GET/getApplication

Query parameters

Response

200400401404

Body

application/json

idstring

Example: "QXBwbGljYXRpb246Mg=="

clientIDstring

Example: "CXqlJpKYiXLzVuq3mU49UY5UFn2N3URVt"

namestring

Example: "example"

logoURLnullable string

Example: "https://example.com/logo.png"

allowedCallerOriginsarray of string

allowedCallbackURLsarray of string

registeredAtinteger

Example: 1231006505

Request

JavaScriptCurlPython

const response = await fetch('/getApplication?clientID=CXqlJpKYiXLzVuq3mU49UY5UFn2N3URVt', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200400401404

{
  "id": "QXBwbGljYXRpb246Mg==",
  "clientID": "CXqlJpKYiXLzVuq3mU49UY5UFn2N3URVt",
  "name": "example",
  "logoURL": "https://example.com/logo.png",
  "allowedCallerOrigins": [
    "https://example.com"
  ],
  "allowedCallbackURLs": [
    "https://example.com/callback"
  ],
  "registeredAt": 1231006505
}

Get application stats by client ID

GET/getApplicationStats

Query parameters

Response

200400401404

Body

application/json

activeUserCountinteger

Example: 1

Request

JavaScriptCurlPython

const response = await fetch('/getApplicationStats?clientID=CXqlJpKYiXLzVuq3mU49UY5UFn2N3URVt&startAt=1231006505&endAt=1231006505', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200400401404

{
  "activeUserCount": 1
}

Get all applications

GET/getApplications

Response

200400401

Body

application/json

idstring

Example: "QXBwbGljYXRpb246Mg=="

clientIDstring

Example: "CXqlJpKYiXLzVuq3mU49UY5UFn2N3URVt"

namestring

Example: "example"

logoURLnullable string

Example: "https://example.com/logo.png"

allowedCallerOriginsarray of string

allowedCallbackURLsarray of string

registeredAtinteger

Example: 1231006505

Request

JavaScriptCurlPython

const response = await fetch('/getApplications', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200400401

[
  {
    "id": "QXBwbGljYXRpb246Mg==",
    "clientID": "CXqlJpKYiXLzVuq3mU49UY5UFn2N3URVt",
    "name": "example",
    "logoURL": "https://example.com/logo.png",
    "allowedCallerOrigins": [
      "https://example.com"
    ],
    "allowedCallbackURLs": [
      "https://example.com/callback"
    ],
    "registeredAt": 1231006505
  }
]

Update an application by client ID

POST/updateApplication

Body

application/json

clientID*string

Example: "CXqlJpKYiXLzVuq3mU49UY5UFn2N3URVt"

namestring

Example: "example"

logoURLnullable string

Example: "https://example.com/logo.png"

allowedCallerOriginsarray of string

allowedCallbackURLsarray of string

Response

200400401404

Body

application/json

idstring

Example: "QXBwbGljYXRpb246Mg=="

clientIDstring

Example: "CXqlJpKYiXLzVuq3mU49UY5UFn2N3URVt"

namestring

Example: "example"

logoURLnullable string

Example: "https://example.com/logo.png"

allowedCallerOriginsarray of string

allowedCallbackURLsarray of string

registeredAtinteger

Example: 1231006505

Request

JavaScriptCurlPython

const response = await fetch('/updateApplication', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "clientID": "CXqlJpKYiXLzVuq3mU49UY5UFn2N3URVt"
    }),
});
const data = await response.json();

Response

200400401404

{
  "id": "QXBwbGljYXRpb246Mg==",
  "clientID": "CXqlJpKYiXLzVuq3mU49UY5UFn2N3URVt",
  "name": "example",
  "logoURL": "https://example.com/logo.png",
  "allowedCallerOrigins": [
    "https://example.com"
  ],
  "allowedCallbackURLs": [
    "https://example.com/callback"
  ],
  "registeredAt": 1231006505
}

Delete an application by client ID

POST/deleteApplication

Body

application/json

clientID*string

Example: "CXqlJpKYiXLzVuq3mU49UY5UFn2N3URVt"

Response

204400401404

no content

Request

JavaScriptCurlPython

const response = await fetch('/deleteApplication', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "clientID": "CXqlJpKYiXLzVuq3mU49UY5UFn2N3URVt"
    }),
});
const data = await response.json();

Response

400401404

{
  "message": "something went wrong"
}