認証アプリケーション関連

Register an application

post

Body

application/json

namestringRequiredExample: example

logoURLstring | nullableOptionalExample: https://example.com/logo.png

allowedCallerOriginsstring[]RequiredExample: ["https://example.com"]

allowedCallbackURLsstring[]RequiredExample: ["https://example.com/callback"]

Responses

200

OK

application/json

400

Bad Request

application/json

401

Unauthorized

application/json

post

/registerApplication

HTTPcURLJavaScriptPython

POST /registerApplication HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 161

{
  "name": "example",
  "logoURL": "https://example.com/logo.png",
  "allowedCallerOrigins": [
    "https://example.com"
  ],
  "allowedCallbackURLs": [
    "https://example.com/callback"
  ]
}

{
  "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

Query parameters

clientIDstringRequiredExample: CXqlJpKYiXLzVuq3mU49UY5UFn2N3URVt

Responses

200

OK

application/json

400

Bad Request

application/json

401

Unauthorized

application/json

404

Not Found

application/json

get

/getApplication

HTTPcURLJavaScriptPython

GET /getApplication?clientID=CXqlJpKYiXLzVuq3mU49UY5UFn2N3URVt HTTP/1.1
Host: 
Accept: */*

{
  "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

Query parameters

clientIDstringRequiredExample: CXqlJpKYiXLzVuq3mU49UY5UFn2N3URVt

startAtintegerRequiredExample: 1231006505

endAtintegerRequiredExample: 1231006505

Responses

200

OK

application/json

400

Bad Request

application/json

401

Unauthorized

application/json

404

Not Found

application/json

get

/getApplicationStats

HTTPcURLJavaScriptPython

GET /getApplicationStats?clientID=CXqlJpKYiXLzVuq3mU49UY5UFn2N3URVt&startAt=1231006505&endAt=1231006505 HTTP/1.1
Host: 
Accept: */*

{
  "activeUserCount": 1
}

Get all applications

get

Responses

200

OK

application/json

400

Bad Request

application/json

401

Unauthorized

application/json

get

/getApplications

HTTPcURLJavaScriptPython

GET /getApplications HTTP/1.1
Host: 
Accept: */*

[
  {
    "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

Body

application/json

clientIDstringRequiredExample: CXqlJpKYiXLzVuq3mU49UY5UFn2N3URVt

namestringOptionalExample: example

logoURLstring | nullableOptionalExample: https://example.com/logo.png

allowedCallerOriginsstring[]OptionalExample: ["https://example.com"]

allowedCallbackURLsstring[]OptionalExample: ["https://example.com/callback"]

Responses

200

OK

application/json

400

Bad Request

application/json

401

Unauthorized

application/json

404

Not Found

application/json

post

/updateApplication

HTTPcURLJavaScriptPython

POST /updateApplication HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 208

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

{
  "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

Body

application/json

clientIDstringRequiredExample: CXqlJpKYiXLzVuq3mU49UY5UFn2N3URVt

Responses

204

No Content

No content

400

Bad Request

application/json

401

Unauthorized

application/json

404

Not Found

application/json

post

/deleteApplication

HTTPcURLJavaScriptPython

POST /deleteApplication HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 48

{
  "clientID": "CXqlJpKYiXLzVuq3mU49UY5UFn2N3URVt"
}

No content