認証クライアント関連 | unWallet Enterprise v2

🏙️

unWallet Enterprise v2

Register an application

post

/registerApplication

Body

namestringrequired

Example: example

logoURLstring | nullable

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

allowedCallerOriginsstring[]required

Example: ["https://example.com"]

allowedCallbackURLsstring[]required

Example: ["https://example.com/callback"]

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url '/registerApplication' \
  --header 'Content-Type: application/json' \
  --data '{
    "name": "example",
    "logoURL": "https://example.com/logo.png",
    "allowedCallerOrigins": [
      "https://example.com"
    ],
    "allowedCallbackURLs": [
      "https://example.com/callback"
    ]
  }'

200

400

401

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

clientIDstringrequired

Example: CXqlJpKYiXLzVuq3mU49UY5UFn2N3URVt

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url '/getApplication?clientID=CXqlJpKYiXLzVuq3mU49UY5UFn2N3URVt'

200

400

401

404

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

clientIDstringrequired

Example: CXqlJpKYiXLzVuq3mU49UY5UFn2N3URVt

startAtintegerrequired

Example: 1231006505

endAtintegerrequired

Example: 1231006505

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url '/getApplicationStats?clientID=CXqlJpKYiXLzVuq3mU49UY5UFn2N3URVt&startAt=1231006505&endAt=1231006505'

200

400

401

404

{
  "activeUserCount": 1
}

Get all applications

get

/getApplications

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url '/getApplications'

200

400

401

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

clientIDstringrequired

Example: CXqlJpKYiXLzVuq3mU49UY5UFn2N3URVt

namestring

Example: example

logoURLstring | nullable

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

allowedCallerOriginsstring[]

Example: ["https://example.com"]

allowedCallbackURLsstring[]

Example: ["https://example.com/callback"]

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url '/updateApplication' \
  --header 'Content-Type: application/json' \
  --data '{
    "clientID": "CXqlJpKYiXLzVuq3mU49UY5UFn2N3URVt",
    "name": "example",
    "logoURL": "https://example.com/logo.png",
    "allowedCallerOrigins": [
      "https://example.com"
    ],
    "allowedCallbackURLs": [
      "https://example.com/callback"
    ]
  }'

200

400

401

404

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

clientIDstringrequired

Example: CXqlJpKYiXLzVuq3mU49UY5UFn2N3URVt

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url '/deleteApplication' \
  --header 'Content-Type: application/json' \
  --data '{
    "clientID": "CXqlJpKYiXLzVuq3mU49UY5UFn2N3URVt"
  }'

204

400

401

404

No body

no content