認証クライアント関連

Register an application

post
Body
namestringRequiredExample: example
logoURLstring | nullableOptionalExample: https://example.com/logo.png
allowedCallerOriginsstring[]RequiredExample: ["https://example.com"]
allowedCallbackURLsstring[]RequiredExample: ["https://example.com/callback"]
Responses
200Success
application/json
post
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
200Success
application/json
get
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
200Success
application/json
get
GET /getApplicationStats?clientID=CXqlJpKYiXLzVuq3mU49UY5UFn2N3URVt&startAt=1231006505&endAt=1231006505 HTTP/1.1
Host: 
Accept: */*
{
  "activeUserCount": 1
}

Get all applications

get
Responses
200Success
application/json
get
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
clientIDstringRequiredExample: CXqlJpKYiXLzVuq3mU49UY5UFn2N3URVt
namestringOptionalExample: example
logoURLstring | nullableOptionalExample: https://example.com/logo.png
allowedCallerOriginsstring[]OptionalExample: ["https://example.com"]
allowedCallbackURLsstring[]OptionalExample: ["https://example.com/callback"]
Responses
200Success
application/json
post
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
clientIDstringRequiredExample: CXqlJpKYiXLzVuq3mU49UY5UFn2N3URVt
Responses
204
no content
post
POST /deleteApplication HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 48

{
  "clientID": "CXqlJpKYiXLzVuq3mU49UY5UFn2N3URVt"
}

No content

Last updated