The following endpoint is the base url for the APIs below.
+ +Create a new API client under a specific user.
+Request
+POST /client/:user HTTP1.1
+Authorization: Bearer {token}
+Content-Type: application/json
+
+{
+ "name": "test-apiclient-name",
+}
+:user is either root user or subuser.
Details for the POST {body}.
| Key | +Value | +
|---|---|
name |
+Required. The name of the API client. | +
Response
+HTTP/1.1 200 OK
+
+{
+ "client_id": "ripple-abcdef123456",
+ "client_secret": "critical",
+ "grant_type": "client_credentials",
+ "create_time": "2020-06-27T11:26:46.257375295Z",
+ "user_id": "id0001",
+ "username": "someusername",
+ "name": "test-apiclient-name"
+}
+List all API clients under a specific user.
+Request
+ +:user is either root user or subuser.
Response
+HTTP/1.1 200 OK
+
+[
+ {
+ "client_id": "ripple-abcdef123456",
+ "client_secret": "",
+ "grant_type": "client_credentials",
+ "create_time": "2020-06-15T05:07:50.258779172Z",
+ "user_id": "id001",
+ "name": "test-apiclient-name"
+ },
+ ...
+]
+Delete an existing API client under a specific user.
+Request
+ +:user is either root user or subuser. :clientid is the client id to delete.
Response
+ +Info
+Authentication for Wave (OpenAPI) is separated at the moment. We will be unifying all logins for all our APIs going forward. An announcement will be made once it's done.
+Before you can access Alphaus API services, you need to get an access token first. You will then use this token in your succeeding calls to the API using the Authorization: Bearer {token} HTTP header. Alphaus API tokens are JSON Web Tokens (JWT).
Use the following endpoints to acquire product-specific access tokens. Tokens are not compatible between the two. Ripple access tokens can only be used for Ripple endpoints; Wave access tokens are only valid on Wave endpoints.
+# Ripple
+https://login.alphaus.cloud/ripple/access_token
+
+# Wave
+https://login.alphaus.cloud/access_token
+Request
+To obtain an access token, send a POST message to the access token endpoint using the format described below.
+ +The following table describes the formdata you need to supply as your POST body.
+| Name | +Value | +
|---|---|
grant_type |
+Valid values: password, client_credentials |
+
client_id |
+The client id you received from Alphaus or from API. | +
client_secret |
+The client secret you received from Alphaus or from API. | +
username |
+You account username. Required if grant_type is set to password. |
+
password |
+You account password. Required if grant_type is set to password. |
+
scope |
+Valid values: openid |
+
Response
+HTTP/1.1 200 OK
+
+{
+ "id_token": "eyJ0eXAiOiJKV1Q...",
+ "token_type": "Bearer",
+ "expires_in": 86400,
+ "access_token": "eyJ0eXAiOiJKV1Q...",
+ "refresh_token": "def50200..."
+}
+Using bluectl
+You can also use our bluectl CLI tool to generate access tokens. It is designed to work with the client_credentials grant type, although it supports the password grant type as well. To set the required environment variables for authentication, check out this document.
# Simple version:
+$ bluectl access-token
+
+# You can also access our beta (next) environment:
+$ bluectl access-token --beta
+
+# Use with other commands (example):
+$ curl -H "Authorization: Bearer $(bluectl access-token)" \
+ https://some-ripple-endpoint/...
+For general information about RBAC, check out this link.
+The following endpoint is the base url for the APIs below.
+ +List all permissions supported by RBAC in all namespaces. For reference, supported permissions can be found here.
+Request
+ +Response
+HTTP/1.1 200 OK
+
+[
+ {
+ "namespace":"wave",
+ "permissions":[
+ "Admin",
+ "ModifySettings",
+ "..."
+ ]
+ },
+ {
+ "namespace":"ripple",
+ "permissions":[
+ "Admin"
+ ]
+ }
+]
+During role creation, if your permissions list contains an Admin entry, all other entries will be discarded except Admin.
Roles are root user-level. That means all roles created by the root user, or any subuser that has permissions to create roles, are available to all subusers.
+Request
+POST /roles HTTP1.1
+authorization: Bearer {token}
+content-type: application/json
+
+{
+ "name":"testrole",
+ "namespace":"wave",
+ "permissions":[
+ "ModifySettings",
+ "ViewSettings",
+ ...
+ ]
+}
+Role names should have at least 6 characters in length and 32 characters maximum. It should also be alphanumeric. Hyphens and underscores are allowed in between. The regular expression used for validation is below:
+ +Response
+HTTP/1.1 200 OK
+
+{
+ "name":"testrole",
+ "namespace":"wave",
+ "permissions":[
+ "ModifySettings",
+ "ViewSettings",
+ ...
+ ]
+}
+Request
+ +The {namespace} parameter is optional. If not provided, all roles will be returned.
Response
+HTTP/1.1 200 OK
+
+[
+ {
+ "name": "testrole",
+ "namespace": "wave",
+ "permissions": [
+ "ModifySettings",
+ "ViewSettings",
+ "ModifyAccountSettings"
+ ]
+ },
+ {
+ "name": "waveAdmin",
+ "namespace": "wave",
+ "permissions": [
+ "Admin"
+ ]
+ },
+ ...
+]
+Update role. If role name is different, rename mapped role name.
+Request
+PATCH /roles/{namespace}/{rolename} HTTP1.1
+authorization: Bearer {token}
+content-type: application/json
+
+{
+ "namespace":"wave",
+ "permissions":[
+ "ModifySettings",
+ "ViewSettings",
+ ...
+ ]
+}
+Response
+HTTP/1.1 200 OK
+
+{
+ "name": "testrole",
+ "namespace":"wave",
+ "permissions":[
+ "ModifySettings",
+ "ViewSettings",
+ ...
+ ]
+}
+Delete role. Deleting a role will also remove all mappings.
+Request
+ +You can only map (or attach) up to 5 roles to a user per namespace. There is no limit for filtering rules per user.
+Valid values for type for filtering rules:
| Namespace | +Value | +
|---|---|
wave |
+linkAcct, group, tags |
+
ripple |
+billingGroup |
+
Request
+POST /userroles HTTP1.1
+authorization: Bearer {token}
+content-type: application/json
+
+{
+ "user_id":"subuser1",
+ "roles":[
+ {
+ "namespace":"wave",
+ "role": "somerole",
+ },
+ ...
+ ]
+}
+Response
+ +Request
+For this endpoint, the returned role mappings are those attached to the caller.
+ +For listing role mappings of other subusers, use this endpoint.
+ +{subuser} is the subuser name.
Response
+HTTP/1.1 200 OK
+
+[
+ {
+ "root_user":"58c2297d25645",
+ "sub_user":"subuser01",
+ "namespace":"wave",
+ "role":"testrole1"
+ },
+ {
+ "root_user":"58c2297d25645",
+ "sub_user":"subuser02",
+ "namespace":"wave",
+ "filter":"billingGroup:2222"
+ },
+ ...
+]
+Retrieve all permissions to all roles attached to the {subuser}.
Request
+ +Response
+HTTP/1.1 200 OK
+
+[
+ {
+ "namespace":"wave",
+ "permissions":[
+ "Admin",
+ "ModifySettings",
+ "..."
+ ]
+ },
+ {
+ "namespace":"ripple",
+ "permissions":[
+ "Admin"
+ ]
+ }
+]
+You can only update map (or attach) up to 5 roles to a user per namespace. There is no limit for filtering rules per user.
+Valid values for type for filtering rules:
| Namespace | +Value | +
|---|---|
wave |
+linkAcct, group, tags |
+
ripple |
+billingGroup |
+
This method replaces subuser's all roles to information in the request body.
+Request
+PATCH /userroles HTTP1.1
+authorization: Bearer {token}
+content-type: application/json
+
+{
+ "roles":[
+ {
+ "namespace":"wave",
+ "role": "somerole",
+ },
+ ...
+ ]
+}
+PATCH /{subuser}/userroles HTTP1.1
+authorization: Bearer {token}
+content-type: application/json
+
+{
+ "roles":[
+ {
+ "namespace":"wave",
+ "role": "somerole",
+ },
+ ...
+ ]
+}
+{subuser} is the subuser id.
Response
+ +All Alphaus API endpoints are globally rate limited by default to 100 calls per second per user. To request for limit increase, please contact us through our various contact channels.
+Info
+This reference is about our old APIs. For the new version, please check out Blue API.
+Alphaus provides an API for interacting with its services. The API is a RESTful API that can be accessed by an HTTP client such as curl, wget, or any HTTP library which is part of most modern programming languages.
The following endpoint is the base url for the APIs below.
+ +Get the current status of the invoice calculations.
+Request
+ +Details for params.
| Key | +Value | +
|---|---|
vendor |
+Optional. Supported vendor is only aws at the moment. |
+
from |
+Optional. If not provided, default value is 2 months before current month. Format: yyyymm. |
+
to |
+Optional. If not provided, default value is current month. Format: yyyymm. |
+
Response
+HTTP/1.1 200 OK
+
+[
+ {
+ "billing_month": "2020-04",
+ "end_time": "",
+ "finished": 3090,
+ "id": "MSP-123456",
+ "invoice_type": "account",
+ "msp": "MSP-123456",
+ "name": "Alphaus, Inc.",
+ "run_id": "MSP-123456/76f20b9a-b7fa-4599-bc38-0691dbbd4ea3",
+ "start_time": "2020-05-22T04:01:38Z",
+ "status": "checking",
+ "status_message": "checking",
+ "total": 3090,
+ "type": "msp",
+ "vendor": "aws"
+ },
+ ...
+]
+Examples:
+ + + + + + + + + + + + + + +The following endpoint is the base url for the APIs below.
+ +Create new subuser.
+Request
+POST /users HTTP1.1
+authorization: Bearer {token}
+content-type: application/json
+
+{
+ "username": "newsubuser",
+ "password": "mysecretpassword",
+ "email": "dev@mobingi.com",
+ "notification": {
+ "email": "false"
+ }
+}
+Details for the POST {body}.
| Key | +Value | +
|---|---|
username |
+Required. Min: 4, max: 18, allowed characters: letters, numbers, _ (underscore), . (period) and - (hyphen). | +
password |
+Required. Min: 8, max: 18. | +
notification.email |
+Required. Enable or disable notifications. Valid values: "true", "false". |
+
email |
+Optional email address. | +
Response
+HTTP/1.1 200 OK
+
+[
+ {
+ "username":"mysubuser",
+ "msp_user":"MSP-123456",
+ "mobingi_user": "abcdef",
+ "email":"mysubuser@domain.com",
+ "nickname":"",
+ ...
+ }
+]
+List all subusers.
+Request
+ +Response
+HTTP/1.1 200 OK
+
+[
+ {
+ "username":"mysubuser",
+ "msp_user":"MSP-123456",
+ "mobingi_user": "abcdef",
+ "email":"mysubuser@domain.com",
+ "nickname":"",
+ ...
+ }
+]
+