Protocol Documentation

Required. Organization's email

Required. Organization's description or company name

Optional. User can decide to let the system generates the password.

To be used for onboarding profile

Optional. Customer Id from AWS marketplace

Optional. User locale. Default value is en if not supplied.

Optional. Auth0 user id for users registering using social login.

Required. The descriptive name of the API client to create.

The email address of the user being created.

The password of the user being created. A value will be generated if not is provided for this field

The ID of the group to which the user will be added. This must either be a billing group ID or an access group ID.

The type of group which is represented by the group ID. Valid values include "billing_group" or "access_group".

This value determines whether the password should be auto-generated or if the plaintext value received with the request should be used. A value of "Auto" will result in an auto-generated password whereas a value of "Custom" will result in the password included with the request being used.

The plan associated with the root-user account. Valid values include "trial", "limited3" and "limited4".

Whether or not a notification should be sent to the provided email after the user has been created.

A collection of feature flags and whether or not they should be enabled. For a full list of such flags, see https://labs.alphaus.cloud/docs/blueapi/apis/iam/.

Required. The IdP name.

Required. Value is `saml`.

Required. The contents of the metadata file from your IdP.

Required. The IP input to filter, either blacklist or whitelist. Should be in CIDR format (i.e. `1.2.3.4/32`).

Optional. Can be `whitelist` or `blacklist`. Defaults to `blacklist` if empty.

Optional. If `rootUser` is valid and `subUser` is empty, filter is for this rootuser. If both `rootUser` and `subUser` inputs are empty, filter is at global scope.

Optional. If `subuser` is valid, filter is for this subuser; `rootUser` value is discarded. If both `rootUser` and `subUser` inputs are empty, filter is at global scope.

Required. Partner id or audience for the token.

Required. The name of the role to create. 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 `^[A-Za-z0-9][A-Za-z0-9_-]*[A-Za-z0-9]$`.

Required. The namespace where this role will belong.

Required. The list of permissions to attach to this role.

Required. Min: 4, max: 18, allowed characters: letters, numbers, `_` (underscore), `.` (period) and `-` (hyphen) characters.

Required. Minimum of 8 characters.

Optional. Email address of the subuser.

Optional. Nickname or description. It is set to 'name' if empty.

Optional. The subuser to map the roles. Defaults to caller if not set.

Required. The roles to map to the user. Limited to 5 items.

Required. The client id to delete.

Required. The IdP id to delete.

The IP filter id to delete.

Required. The parent namespace.

Required. The role name to delete.

Required. The subuser name to delete.

Required. The parent ID

Optional. The sub-user ID

IP filter item id. Note that this name is transcient and is not fixed. However, you can use any of its permutations to endpoints that accept it, such as the `DELETE:/iam/v?/ipfilters/{id}` endpoint, without issues.

Can be `global`, `rootuser`, or `subuser`.

The target of the filter. If global scope, this is usually empty. Rootuser name for rootuser scope, and subuser name for subuser scope. For subuser targets, format is `rootuser/subuser`.

The type of IP filter. It could be `whitelist` or `blacklist`.

The IP filter value. Should be in CIDR format.

Optional. The subuser to query. If empty (default), query all available permissions. If set to a valid subuser, query that subuser's permissions, if allowed. You can also set this field to `me` to query your own permissions.

Optional. If not set, all roles will be returned.

Optional. The subuser to query. Defaults to caller if not set.

Optional. If non empty: list users by status. Otherwise will list all MFA users.

Required. Partner id or audience for the token.

Required. The previous (old) token to be refreshed.

Required. The new namespace.

Required. The role name to update.

Optional. If set, update the current name to this.

Required. The list of permissions to attach to this role.

Optional. The subuser to map the roles. Defaults to caller if not set.

Required. The roles to map to the user. Limited to 5 items. Setting `role` to empty will remove the mapping.

The queried target account.

The external id for this role.

The id of the CloudFormation stack deployed in the target account.

The region where the stack is deployed.

The latest template used to deploy the stack.

This can be `latest`, `outdated`, or some error information.

The last updated timestamp, RFC3339 UTC.

Required. The target AWS account to validate.

Required. The target AWS account to validate.

Required. Name of the notification channel.

Required. Valid values: `email`, `slack`, `msteams`.

Required if type = `email`.

Required if type = `slack`.

Required if type = `msteams`.

Optional. For Octo use only: `octo`.

Required Valid values: `InvoiceCalculationStarted`, `InvoiceCalculationFinished`, `CurUpdatedAfterInvoice`. `AccountBudgetAlert`.

Required

Required

Optional. only available Wave(Pro).

Required.

Required.

Required.

Optional. Default value: `alphaus-proforma-cur-export`

Optional. Default value: `pre`

Optional. Default value: `us-east-1`

The queried target account.

The role ARN that provides the cross-account access permissions.

The external id for this role.

The id of the CloudFormation stack deployed in the target account.

The region where the stack is deployed.

The latest template used to deploy the stack.

This can be `latest`, `outdated`, or some error information.

The last updated timestamp, RFC3339 UTC.

Required. The target AWS account to delete.

Required. ID of the notification channel to delete.

Required

Required Valid values: `InvoiceCalculationStarted`, `InvoiceCalculationFinished`, `CurUpdatedAfterInvoice`. `AccountBudgetAlert`.

Required. At the moment, `CSV`,`JSON` is supported.

Required. The UTC date to start data from. If not set, the first day of the current year will be used. Format: `yyyymmdd`.

Required. The UTC date to end data from. If not set, the first day of the current year will be used. Format: `yyyymmdd`.

The CloudFormation launch url. Open it in your browser.

The latest CloudFormation template. The version is included in the filename.

The default stack name used. Can be modified.

The external id for this role. Do not change.

Required. The target AWS account to query.

Optional. Valid values are `default`, `s3only`, and `apionly`. Defaults to `default` if empty. `default` - Template for setting up both CUR export and read-only access to cost information. If selected, you need to deploy this template to `us-east-1` region as CloudFormation only supports the `AWS::CUR::ReportDefinition` in that region at the moment. The target S3 bucket will also be created in that region. If you prefer your S3 bucket to be located in a different region, you can use the template from this API by setting the type to `s3only`. After your S3 bucket is ready, call this API again (type is `default`) and set the `CurS3BucketOption` parameter to `USE_EXISTING`, then set your bucket name and region accordingly. This is the default for Ripple, unless specified otherwise. `apionly` - Template for setting up ready-only access to cost information. Handy if you already have exported your CUR to Alphaus through other means (i.e. manual setup). This template is the same as the `default` type but without the CUR export definitions. Although not required, we recommend you to deploy this template to allow us to query your cost-related information such as Reserved Instances, Saving Plans, etc. through the AWS API. At the moment, we only rely on CUR data which is a best-effort basis and sometimes not accurate. This is the default for Wave(Pro), unless specified otherwise. `s3only` - A helper template for creating an S3 bucket to be used for CUR export. `default-2.0`- For default cur 2.0 templates. `s3only-2.0` - For s3only cur 2.0 templates. All templates are publicly available from the reponse link (`templateUrl`) if you want to audit the included permissions.

The CloudFormation launch url. Open it in your browser.

The latest CloudFormation template. The version is included in the filename.

The default stack name used. Can be modified.

The AWS account that will receive the access. Do not change.

The external id for this role. Do not change.

Optional.

Required

Required Valid values: `InvoiceCalculationStarted`, `InvoiceCalculationFinished`, `CurUpdatedAfterInvoice`. `AccountBudgetAlert`.

Required.

Required.

Required. Enable or disable notifications globally.

Optional. If non-empty, set this notification channel id as the default channel.

Required. The target AWS account to update.

Required. ID of the notification channel to update.

Required. Name of the notification channel.

Required. Valid values: `email`, `slack`, `msteams`.

Required if type = `email`.

Required if type = `slack`.

Required if type = `msteams`.

Optional. For Octo use only: `octo`.

Required

Required

Required

Required Valid values: `InvoiceCalculationStarted`, `InvoiceCalculationFinished`, `CurUpdatedAfterInvoice`. `AccountBudgetAlert`.

Optional. only available Wave(Pro).

Budget alert Id.

Vnedor. At the moment, only `aws` is supported.

Lsit of accountId.

Notification setting for budget alert.

Daily setting for budget alert.

Daily rate increase setting for budget alert.

Monthly setting for budget alert.

Required. At the moment, only `aws` is supported.

Optional. A comma-separated list of billing internal ids. If empty, calculate for all billing groups. At the moment, for AWS, this is only valid for account type billing groups, not tag billing groups. If a tag billing group is provided, it is discarded and the calculation is done for the whole organization.

Optional. The UTC month to calculate. If empty, it defaults to the previous month. Format is `yyyymm`. For example, June 2021 will be `202106`.

Optional. Valid only for the `aws` vendor. AWS-specific options.

Optional. If set to true, discard existing calculation operation(s), if any, and make this as the active/latest one. By default, if there is an ongoing operation during the call, the request will fail.

Optional. If set to true, only calculate for account-type billing groups. If both `accountsOnly` and `tagsOnly` are set to true, `accountsOnly` will prevail.

Optional. If set to true, only calculate for tags-type billing groups. Discarded when the organization doesn't have any tag-based billing groups configured. If both `accountsOnly` and `tagsOnly` are set to true, `accountsOnly` will prevail.

The schedule id.

The desired schedule in UTC, using the [cron](https://man7.org/linux/man-pages/man5/crontab.5.html) format.

The macro that augments `schedule`.

The target month for the calculation. Empty means previous month (default).

The schedule for the next run in UTC.

The channel id to use for notifications.

If set to true, force calculations to proceed regardless of run status.

If set to true, skips the actual calculations.

The current state of this schedule. Normally set to "OK", or empty if no issues. Otherwise, will contain an error string.

Optional. The account to which the modifier is applied. A comma-separated list of accounts is also valid.

Optional. The group to which the modifier is applied. Accepts billing internal ids. A comma-separated list of billing internal ids is also valid.

Optional. The payer id to which the modifier is applied. A comma-separated list of payer ids is also valid.

Optional. Conditional qualifiers to further filter the modifier targets. Multiple qualifiers use the logical `or` operator; `qualifiers[0] || qualifiers[1] || qualifiers[n]`.

Optional. Specifies the modifier id in which this modifier will be applied after. For example, if you have another modifier `mod1` and you create a new modifier with `after` set to `mod1`, the calculator will apply `mod1` first, then this modifier. If `after` is not set, the application sequence for multiple overlapping modifiers will be by update timestamp, newest to oldest.

Optional. Default to false. If set to true, the modifier will create a new row in the table with similar data that satisfies the qualifier the only differences is it contains the amount to be subtracted or to be added. If set to false, the modifier will update the cost directly.

Required. Our modifier formula. The final result should be a number. Integers are converted to floating points. Supported operators are `*`, `/`, `+`, `-`, and `%`. You can use parenthesis `()` to control precedence. Additional supported operators include `==`, `!=`, `!`, `>`, `<`, `>=`, `<=`, and the ternary operator `? :`, or `cond ? expr1 : expr2`. Examples: `1 + 2 * 3` = 7 `(1 + 2) * 3` = 9 `7.8 % 5` = 2.8 `true ? 1.1 : 2.2` = 1.1 `1 > 2 ? 1.1 : 2.2` = 2.2 You can use the `cost` variable to reference the original lineitem cost. For example, if you want to add $10 to the cost, you can use the formula: `cost + 10`. For trueunblended-type billing groups, `cost` refers to the calculated trueunblended cost. The `usage` variable refers to the usage amount of a lineitem. For example, if you want to use a different rate of $1.5, you can use the formula: `usage * 1.5`. The `unblendedcost` variable refers to the lineitem's unblended cost as indicated in the CUR. Note that the `unblendedcost` variable is different than the `cost` variable, although there are cases where the two are equal. The `ondemandrate` variable refers to the lineitem's public ondemand rate as indicated in the CUR. You can check out this [guide](https://alphauslabs.github.io/docs/guides/aws-cost-mods/) for more examples.

Optional. A simple description modifier.

Optional. Add a prefix to the description.

Optional. Add a suffix to the description.

Optional. Replace the description with the input.

Optional. Replace matching occurences with the input. The key part is the regular expression matcher based on https://github.com/google/re2, while the value is the replacement. The order of replacement is not guaranteed. You can use the `{{ondemandrate}}` variable in the replacement value part to reference the public ondemand rate indicated in the CUR.

Optional. The group to which the modifier is applied. Accepts billing internal ids. A comma-separated list of billing internal ids is also valid.

Optional. The payer id (a.k.a Azure billing id) to which the modifier is applied. A comma-separated list of payer ids is also valid.

Optional. The Azure customer id to which the modifier is applied. A comma-separated list of customers is also valid.

Optional. The Azure subscription id to which the modifier is applied. A comma-separated list of subscriptions is also valid.

Optional. The Azure entitlement id to which the modifier is applied. A comma-separated list of entitlements is also valid.

Optional. Conditional qualifiers to further filter the modifier targets. Multiple qualifiers use the logical `or` operator; `qualifiers[0] || qualifiers[1] || qualifiers[n]`.

Optional. Specifies the modifier id in which this modifier will be applied after. For example, if you have another modifier `mod1` and you create a new modifier with `after` set to `mod1`, the calculator will apply `mod1` first, then this modifier. If `after` is not set, the application sequence for multiple overlapping modifiers will be by update timestamp, newest to oldest.

Required. Our modifier formula. The final result should be a number. Integers are converted to floating points. Supported operators are `*`, `/`, `+`, `-`, and `%`. You can use parenthesis `()` to control precedence. Additional supported operators include `==`, `!=`, `!`, `>`, `<`, `>=`, `<=`, and the ternary operator `? :`, or `cond ? expr1 : expr2`. Examples: `1 + 2 * 3` = 7 `(1 + 2) * 3` = 9 `7.8 % 5` = 2.8 `true ? 1.1 : 2.2` = 1.1 `1 > 2 ? 1.1 : 2.2` = 2.2 You can use the `cost` variable to reference the original lineitem cost. For example, if you want to add $10 to the cost, you can use the formula: `cost + 10`. For trueunblended-type billing groups, `cost` refers to the calculated trueunblended cost. The `quantity` variable refers to the billable quantity amount of a lineitem. For example, if you want to use a different rate of $1.5, you can use the formula: `quantity * 1.5`. The `unitPrice` variable refers to the lineitem's effective unit price as indicated in the Azure invoice. You can check out this [guide](https://alphauslabs.github.io/docs/guides/aws-cost-mods/) for more examples.

Optional. A simple description modifier.

Optional. Add a prefix to the description.

Optional. Add a suffix to the description.

Optional. Replace the description with the input.

Required. At the moment, only `aws` is supported.

Required. A comma-separated list of account ids. For example, you set to ["accountId1","accountId2","accountId3"].

Map of accountIds to boolean values indicating if the account exists.

Required. At the moment, only `aws` is supported.

Required. Account Id

Required. Budget alert setting.

Required. At the moment, only `aws` is supported.

Required. 'account' or 'acctgroup'

Required. Account or AccountGroup Id

Budget Id

Required. At the moment, only `aws` is supported.

Required. The account id to register.

Optional. If empty, set to the value of `id`.

Optional. The parent `billingInternalId` of the billing group to which this account will belong to.

Required for the `aws` vendor. AWS-specific options.

Required for the `gcp` vendor. GCP-specific options.

Optional. The management account id (formerly known as master, or payer) to which an account belongs to, initially. If the account is moved to another management account, the system is able to detect it and set this value accordingly.

Optional.

Optional.

Required. At the moment, only `aws` is supported.

Required. Lsit of accountId. For example, you set to ["accountId1","accountId2","accountId3"].

Required.

Optional.

Optional.

Optional.

Required. At the moment, only `aws` is supported.

Required. The desired schedule in UTC, using the unix-cron string format `* * * * *` which is a set of five fields in a line using the order: `minute hour day-of-the-month month day-of-the-week`. * `minute` values can be `0-59` * `hour` values can be `0-23` * `day-of-the-month` values can be `1-31` * `month` values can be `1-12`, or `JAN-DEC` * `day-of-the-week` values can be `0-6`, or `SUN-SAT`, or `7` for Sunday Special characters: * A field can contain an asterisk (*), which always stands for "first-last". * Ranges are two numbers separated with a hyphen (-) and the specified range is inclusive. * Following a range with `/NUMBER` specifies skips of the number's value through the range. For example, both `0-23/2` and `*/2` can be used in the `hour` field to specify execution every two hours. * A list is a set of numbers (or ranges) separated by commas (,). For example, `1,2,5,6` in the `month` field specifies an execution on the first, second, fifth, and sixth days of the month.

Optional. Non-standard macro(s) that augment(s) `schedule`'s behavior. The only supported value for now is `@endofmonth`. `@endofmonth` - If set, the backend scheduler will only use the `minute` and `hour` part of `schedule`'s value and set the days to 28th, 29th, 30th, and 31st but the runner will do the filtering for the actual end of the trigger month. Note that this is different than setting `schedule` to, say, `0 0 28-31 * *`.

Optional. The desired month to calculate. If not set, defaults to previous month. The only supported value for now is `@current`. `@current` - If set, calculate for the month the schedule is triggered (or current month).

Optional. The channel id to use for notifications. At the moment, only email-type notification channels are supported. If not set, your default channel will be used. And if non-existent, an email-type notification channel will be created using your primary email address.

Optional. Not used at the moment.

Optional. If set to true, skips the actual calculations. Useful as test, or reminder.

Required. At the moment, only `aws` is supported.

Required if `{vendor}` is `aws`. AWS-specific options.

Required if `{vendor}` is `azure`. Azure-specific options.

Required. At the moment, only `aws` is supported.

Required. Filter Name. Specify characters between 1 ~ 100

Required. If set, reads the usage-based cost details of this group. Only valid for Ripple users. Implied as the parent billing group for Wave(Pro) users. For AWS Ripple, only billing internal ids are supported at the moment. Overriden when `accountId` is set to anything other than `*`. Set this and `accountId` to `*` to read the usage-based cost details of the whole organization. Optional for AWS Wave(Pro).

Required. You can set it to a single account or a comma-separated list of accounts. For AWS, setting this will override `groupId`. Set this and `groupId` to `*` to read the usage-based cost details of the whole organization.

Required. Valid only for the `aws` vendor. AWS-specific options.

Required. Filter Id.

Required. At the moment, only `aws` is supported.

Required for the `aws` vendor. AWS-specific options.

Required. The id of the management account.

Optional. The name, or description of the management account. This is set to `id` when not specified.

Required. S3 Bucket name.

Optional. Prefix.

Required. Report name.

Required. Role ARN for Alphaus to assume for access.

Required. At the moment, only `aws` is supported.

Required. Account Id

Required. At the moment, only `aws` is supported.

Required. Budget Id

Required. At the moment, only `aws` is supported.

Required. The account id to delete.

Required. budget alert id

Required. At the moment, only `aws` is supported.

Required. The id to delete. Can be set to either `-` or `*`, which means all.

Required. At the moment, only `aws` and `azure` are supported.

Required. The id of the modifier to delete.

Required. At the moment, only `aws` is supported.

Required. Filter Id to delete.

Required. At the moment, only `aws` is supported.

Required. The id of the account.

Required. At the moment, only `aws` is supported.

Required. Filter Id.

Optional. The UTC date to start streaming data from. If not set, the first day of the current month will be used. Format: `yyyymmdd`. The oldest supported date is `20200101`.

Optional. The UTC date to end the streaming data. If not set, current date will be used. Format: `yyyymmd`.

Optional. If set to true, return data grouped by month within the date range. If you want data that is grouped per account per month, set this to `true`, then set `groupByColumns` to `none`.

Optional. A comma-separated list of columns to aggregate the data into. Valid values are `productCode`, `serviceCode`, `region`, `zone`, `usageType`, `instanceType`, `operation`, `invoiceId`, `description`, and `resourceId`. A special value of `none` is also supported, which means query by date or month per account only. For example, if you only want the services and region data, you can set this field to `productCode,region`. Your input sequence doesn't matter (although the sequence above is recommended) as the actual sequence is already fixed in the return data (see the definition in https://github.com/alphauslabs/blueapi/blob/main/api/aws/cost.proto), which is generic to specific, top to bottom. Invalid values are discarded. Excluded columns will be empty.

Optional. If set to true, stream will include resource tags.

Required. URL of exported file.

Required. At the moment, only `aws` is supported.

Required. Account Id

Required. At the moment, only `aws` is supported.

Required. 'account' or 'acctgroup'

Required. Account or AccountGroup Id

Optional. Default is current year. Format: `yyyy`.

Required. At the moment, `aws` and `gcp` is supported.

Required. The account id to retrieve.

Optional.

Required. At the moment, only `aws` is supported.

Required. Organization Id.

Required. For AWS, "ri" or "sp".

Required. RI/SP Arn.

Required. budget alert id

Required. At the moment, only `aws` is supported.

Required. At the moment, only `aws` is supported.

Required. Format: `yyyy-mm`.

Optional. If set, reads the cost attributes of this group. Only valid for Ripple users. Implied as the parent billing group for Wave(Pro) users.

Optional. You can set it to a single account or a comma-separated list of accounts. If set, overrides `groupId`

Optional. A comma-separated list of dimensions to query. Valid values are `productCode`, `serviceCode`, `region`, `zone`, `usageType`, `instanceType`, `operation`, `invoiceId`, `description`, `resourceId` and `tags`. Sequence doesn't matter. An empty value implies all attributes will be returned.

The cost attributes.

Required. At the moment, only `aws` is supported.

Required. Organization Id.

Required. Valid values: 'all', 'reservation', 'savingsplan'

Optional. If set to "true", details of the RI or SP list is returned. Default: false.

Optional. The start date of the displayed data. If not set, the first day of the current month will be used. Format: yyyy-mm-dd.

Optional. The end date of the displayed data. If not set, current date will be used. Format: yyyy-mm-dd.

Optional. Payer Id.

Optional. Billing group Id.

Optional. Account group Id.

Optional. Cost Group Id used in octo.

Optional. List of Account Ids.

Optional. List of services.

Required. At the moment, only `aws` is supported.

Required. Organization Id.

Required. Available values: day, hour

Optional. The start date of the displayed data. If not set, the first day of the current month will be used. Format: yyyy-mm-dd.

Optional. The end date of the displayed data. If not set, current date will be used. Format: yyyy-mm-dd.

Optional. Payer Id.

Optional. Billing group Id.

Optional. Account group Id.

Optional. Cost Group Id, currently used in octo

Optional. List of Account Ids.

Optional. List of services.

Required. At the moment, only `aws` is supported.

Required. Organization Id.

Required. Available values: day, hour.

Optional. The start date of the displayed data. If not set, the first day of the current month will be used. Format: yyyy-mm-dd.

Optional. The end date of the displayed data. If not set, current date will be used. Format: yyyy-mm-dd.

Optional. Payer Id.

Optional. Billing group Id.

Optional. Account group Id.

Optional. Cost Group Id

Optional. List of Account Ids.

Optional. List of services.

Optional. If not set, default value is `USD`.

Required. At the moment, only `aws` is supported.

Optional. Company Id of Billing Group to retrieve. Default value is user's Company Id

Optional. Forecast frequency. Valid values are `daily` and `monthly`. Default value is `daily`.

Optional. Forecast granularity. Valid values are `account`, `category` and `product`. Default value is `account`.

Optional. Start date to get cost forecast. If from_date is less than current date, historical costs are included. If from_date is greater than current date, only forecasted costs are returned. Format: `yyyy-mm-dd`.

Optional. End date to get cost forecast. Currently, we only support 90 days forecasting from the first day of current month. Format: `yyyy-mm-dd`.

Required. At the moment, only `aws` is supported.

Required. 'account' or 'acctgroup'

Required. Account or AccountGroup Id

Optional. Default is current month. Format: `yyyymm`.

Required. At the moment, only `aws` is supported.

Required. 'account' or 'acctgroup'

Required. Account or AccountGroup Id

Optional. Default is current month. Format: `yyyymm`.

Required. At the moment, only `aws` is supported.

Required. 'account' or 'acctgroup'

Required. Account or AccountGroup Id

Optional. Start month to get cost forecast. Format: `yyyymm`.

Optional. Last month to get cost forecast. Format: `yyyymm`.