Alphaus | Documentation
Website
Repo
Tech blog (JP)
Tech blog (EN)
Search…
API Reference
Overview
Endpoint limits
Authentication
Users
API clients
Authorization (RBAC)
Ripple
Wave
Status
Ocean
ALM (v3)
Powered By
GitBook
API clients
New API available on
https://alphauslabs.github.io/blueapidocs/#/Iam
.
The following endpoint is the base url for the APIs below.
1
https://service.mobingi.com/m/u/users/
Copied!
Create API client
Create a new API client under a specific user.
Request
1
POST /client/:user HTTP1.1
2
Authorization
:
Bearer {token}
3
Content-Type
:
application/json
4
5
{
6
"name"
:
"test-apiclient-name"
,
7
}
Copied!
:user
is either root user or subuser.
Details for the POST
{body}
.
Key
Value
name
Required. The name of the API client.
Response
1
HTTP
/
1.1
200
OK
2
3
{
4
"client_id"
:
"ripple-abcdef123456"
,
5
"client_secret"
:
"critical"
,
6
"grant_type"
:
"client_credentials"
,
7
"create_time"
:
"2020-06-27T11:26:46.257375295Z"
,
8
"user_id"
:
"id0001"
,
9
"username"
:
"someusername"
,
10
"name"
:
"test-apiclient-name"
11
}
Copied!
List API clients
List all API clients under a specific user.
Request
1
GET /clients/:user HTTP1.1
2
Authorization
:
Bearer {token}
Copied!
:user
is either root user or subuser.
Response
1
HTTP
/
1.1
200
OK
2
3
[
4
{
5
"client_id"
:
"ripple-abcdef123456"
,
6
"client_secret"
:
""
,
7
"grant_type"
:
"client_credentials"
,
8
"create_time"
:
"2020-06-15T05:07:50.258779172Z"
,
9
"user_id"
:
"id001"
,
10
"name"
:
"test-apiclient-name"
11
},
12
...
13
]
Copied!
Delete API client
Delete an existing API client under a specific user.
Request
1
DELETE /client/:user/:clientid HTTP1.1
2
Authorization
:
Bearer {token}
Copied!
:user
is either root user or subuser.
:clientid
is the client id to delete.
Response
1
HTTP
/
1.1
200
OK
2
3
{
4
"status"
:
"success"
5
}
Copied!
Previous
Users
Next
Authorization (RBAC)
Last modified
1yr ago
Copy link
Contents
Create API client
List API clients
Delete API client