Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
41 changes: 41 additions & 0 deletions docs/auth/ChallengeName.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@


# ChallengeName

## Enum


* `SMS_MFA` (value: `"SMS_MFA"`)

* `EMAIL_OTP` (value: `"EMAIL_OTP"`)

* `SOFTWARE_TOKEN_MFA` (value: `"SOFTWARE_TOKEN_MFA"`)

* `SELECT_MFA_TYPE` (value: `"SELECT_MFA_TYPE"`)

* `MFA_SETUP` (value: `"MFA_SETUP"`)

* `PASSWORD_VERIFIER` (value: `"PASSWORD_VERIFIER"`)

* `CUSTOM_CHALLENGE` (value: `"CUSTOM_CHALLENGE"`)

* `SELECT_CHALLENGE` (value: `"SELECT_CHALLENGE"`)

* `DEVICE_SRP_AUTH` (value: `"DEVICE_SRP_AUTH"`)

* `DEVICE_PASSWORD_VERIFIER` (value: `"DEVICE_PASSWORD_VERIFIER"`)

* `ADMIN_NO_SRP_AUTH` (value: `"ADMIN_NO_SRP_AUTH"`)

* `NEW_PASSWORD_REQUIRED` (value: `"NEW_PASSWORD_REQUIRED"`)

* `SMS_OTP` (value: `"SMS_OTP"`)

* `PASSWORD` (value: `"PASSWORD"`)

* `WEB_AUTHN` (value: `"WEB_AUTHN"`)

* `PASSWORD_SRP` (value: `"PASSWORD_SRP"`)



2 changes: 1 addition & 1 deletion docs/auth/CreateSaasUserParam.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@
| Name | Type | Description | Notes |
|------------ | ------------- | ------------- | -------------|
|**email** | **String** | E-mail | |
|**password** | **String** | Password | |
|**password** | **String** | Password | [optional] |



2 changes: 1 addition & 1 deletion docs/auth/PlanReservation.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@
| Name | Type | Description | Notes |
|------------ | ------------- | ------------- | -------------|
|**nextPlanId** | **String** | | [optional] |
|**usingNextPlanFrom** | **Integer** | Next billing plan start time (When using stripe, you can create a subscription that starts at the beginning of the current month by specifying 00:00 (UTC) at the beginning of the current month. Ex. 1672531200 for January 2023.) | [optional] |
|**usingNextPlanFrom** | **Integer** | This parameter is set when reserving a pricing plan change for a future date and time. It is not required for immediate application. When specifying the next pricing plan start date and time, please specify a date and time at least 5 minutes after the current time. Note for Stripe integration: By specifying the beginning of the current month (00:00 UTC) as the start date and time, you can create a subscription that starts from the first day of that month. (Example: To specify January 1, 2023 00:00 UTC → 1672531200) | [optional] |
|**nextPlanTaxRateId** | **String** | | [optional] |
|**prorationBehavior** | **ProrationBehavior** | | [optional] |
|**deleteUsage** | **Boolean** | If you have a stripe linkage, you can set whether to delete pay-as-you-go items when changing plans. When you change plan, you can remove all pay-as-you-go items included in your current subscription to stop being billed based on pay-as-you-go items. The recorded usage is cleared immediately. Since it cannot be restored, please note that plan change reservations with delete_usage set to true cannot be canceled. | [optional] |
Expand Down
16 changes: 16 additions & 0 deletions docs/auth/RespondToSignInChallengeParam.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@


# RespondToSignInChallengeParam

Parameters required to respond to a sign-in challenge

## Properties

| Name | Type | Description | Notes |
|------------ | ------------- | ------------- | -------------|
|**challengeName** | **ChallengeName** | | |
|**challengeResponses** | **Map<String, String>** | Responses to the challenge. The required responses vary depending on the challenge_name. | [optional] |
|**session** | **String** | Session identifier for the challenge. | [optional] |



17 changes: 17 additions & 0 deletions docs/auth/RespondToSignInChallengeResult.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@


# RespondToSignInChallengeResult

Result returned after responding to a sign-in challenge

## Properties

| Name | Type | Description | Notes |
|------------ | ------------- | ------------- | -------------|
|**credentials** | [**Credentials**](Credentials.md) | | [optional] |
|**challengeName** | **ChallengeName** | | [optional] |
|**challengeParameters** | **Map<String, String>** | Parameters required for the next challenge. | [optional] |
|**session** | **String** | Session identifier for the challenge. This session should be passed to the next call to RespondToSignInChallenge if another challenge is required. | [optional] |



142 changes: 141 additions & 1 deletion docs/auth/SaasUserApi.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,8 @@ All URIs are relative to *https://api.saasus.io/v1/auth*
| [**requestEmailUpdate**](SaasUserApi.md#requestEmailUpdate) | **POST** /users/{user_id}/email/request | Request User Email Update |
| [**requestExternalUserLink**](SaasUserApi.md#requestExternalUserLink) | **POST** /external-users/request | Request External User Account Link |
| [**resendSignUpConfirmationEmail**](SaasUserApi.md#resendSignUpConfirmationEmail) | **POST** /sign-up/resend | Resend Sign Up Confirmation Email |
| [**respondToSignInChallenge**](SaasUserApi.md#respondToSignInChallenge) | **POST** /sign-in/challenge | Respond to Sign In Challenge |
| [**signIn**](SaasUserApi.md#signIn) | **POST** /sign-in | Sign In |
| [**signUp**](SaasUserApi.md#signUp) | **POST** /sign-up | Sign Up |
| [**signUpWithAwsMarketplace**](SaasUserApi.md#signUpWithAwsMarketplace) | **POST** /aws-marketplace/sign-up | Sign Up with AWS Marketplace |
| [**unlinkProvider**](SaasUserApi.md#unlinkProvider) | **DELETE** /users/{user_id}/providers/{provider_name} | Unlink external identity providers |
Expand Down Expand Up @@ -238,7 +240,7 @@ public class Example {

Create SaaS User

Create SaaS User.
Create SaaS User. If attributes is empty, a temporary password will be sent to the registered email.

### Example
```java
Expand Down Expand Up @@ -911,6 +913,144 @@ null (empty response body)
| **200** | OK | - |
| **500** | Internal Server Error | - |

<a id="respondToSignInChallenge"></a>
# **respondToSignInChallenge**
> RespondToSignInChallengeResult respondToSignInChallenge(respondToSignInChallengeParam)

Respond to Sign In Challenge

Respond to a sign-in challenge.

### Example
```java
// Import classes:
import saasus.sdk.auth.ApiClient;
import saasus.sdk.auth.ApiException;
import saasus.sdk.auth.Configuration;
import saasus.sdk.auth.auth.*;
import saasus.sdk.auth.models.*;
import saasus.sdk.auth.api.SaasUserApi;

public class Example {
public static void main(String[] args) {
ApiClient defaultClient = Configuration.getDefaultApiClient();
defaultClient.setBasePath("https://api.saasus.io/v1/auth");

// Configure HTTP bearer authorization: Bearer
HttpBearerAuth Bearer = (HttpBearerAuth) defaultClient.getAuthentication("Bearer");
Bearer.setBearerToken("BEARER TOKEN");

SaasUserApi apiInstance = new SaasUserApi(defaultClient);
RespondToSignInChallengeParam respondToSignInChallengeParam = new RespondToSignInChallengeParam(); // RespondToSignInChallengeParam |
try {
RespondToSignInChallengeResult result = apiInstance.respondToSignInChallenge(respondToSignInChallengeParam);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling SaasUserApi#respondToSignInChallenge");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}
```

### Parameters

| Name | Type | Description | Notes |
|------------- | ------------- | ------------- | -------------|
| **respondToSignInChallengeParam** | [**RespondToSignInChallengeParam**](RespondToSignInChallengeParam.md)| | [optional] |

### Return type

[**RespondToSignInChallengeResult**](RespondToSignInChallengeResult.md)

### Authorization

[Bearer](../README.md#Bearer)

### HTTP request headers

- **Content-Type**: application/json
- **Accept**: application/json

### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
| **200** | OK | - |
| **401** | Unauthorized | - |
| **500** | Internal Server Error | - |

<a id="signIn"></a>
# **signIn**
> SignInResult signIn(signInParam)

Sign In

A user attempts to sign in.

### Example
```java
// Import classes:
import saasus.sdk.auth.ApiClient;
import saasus.sdk.auth.ApiException;
import saasus.sdk.auth.Configuration;
import saasus.sdk.auth.auth.*;
import saasus.sdk.auth.models.*;
import saasus.sdk.auth.api.SaasUserApi;

public class Example {
public static void main(String[] args) {
ApiClient defaultClient = Configuration.getDefaultApiClient();
defaultClient.setBasePath("https://api.saasus.io/v1/auth");

// Configure HTTP bearer authorization: Bearer
HttpBearerAuth Bearer = (HttpBearerAuth) defaultClient.getAuthentication("Bearer");
Bearer.setBearerToken("BEARER TOKEN");

SaasUserApi apiInstance = new SaasUserApi(defaultClient);
SignInParam signInParam = new SignInParam(); // SignInParam |
try {
SignInResult result = apiInstance.signIn(signInParam);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling SaasUserApi#signIn");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}
```

### Parameters

| Name | Type | Description | Notes |
|------------- | ------------- | ------------- | -------------|
| **signInParam** | [**SignInParam**](SignInParam.md)| | [optional] |

### Return type

[**SignInResult**](SignInResult.md)

### Authorization

[Bearer](../README.md#Bearer)

### HTTP request headers

- **Content-Type**: application/json
- **Accept**: application/json

### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
| **200** | OK | - |
| **401** | Unauthorized | - |
| **500** | Internal Server Error | - |

<a id="signUp"></a>
# **signUp**
> SaasUser signUp(signUpParam)
Expand Down
23 changes: 23 additions & 0 deletions docs/auth/SignInParam.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@


# SignInParam

Parameters required for user sign-in The required parameters vary depending on the sign_in_flow.

## Properties

| Name | Type | Description | Notes |
|------------ | ------------- | ------------- | -------------|
|**signInFlow** | [**SignInFlowEnum**](#SignInFlowEnum) | The sign-in flow to use for authentication. Currently, only USER_SRP_AUTH is supported. | |
|**signInParameters** | **Map&lt;String, String&gt;** | The required parameters vary depending on the sign_in_flow. USER_SRP_AUTH: USERNAME: email address SRP_A: SRP A value | [optional] |



## Enum: SignInFlowEnum

| Name | Value |
|---- | -----|
| USER_SRP_AUTH | &quot;USER_SRP_AUTH&quot; |



16 changes: 16 additions & 0 deletions docs/auth/SignInResult.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@


# SignInResult

Result returned after a sign-in attempt

## Properties

| Name | Type | Description | Notes |
|------------ | ------------- | ------------- | -------------|
|**challengeName** | **ChallengeName** | | [optional] |
|**challengeParameters** | **Map&lt;String, String&gt;** | Parameters required to complete the challenge | [optional] |
|**session** | **String** | Session identifier for the challenge. This session should be passed to the next call to RespondToSignInChallenge if another challenge is required. | [optional] |



16 changes: 8 additions & 8 deletions docs/auth/SingleTenantApi.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,18 +4,18 @@ All URIs are relative to *https://api.saasus.io/v1/auth*

| Method | HTTP request | Description |
|------------- | ------------- | -------------|
| [**getCloudFormationLaunchStackLinkForSingleTenant**](SingleTenantApi.md#getCloudFormationLaunchStackLinkForSingleTenant) | **GET** /single-tenant/cloudformation-launch-stack-link | Get CloudFormation Stack Launch Link For Single Tenant |
| [**getSingleTenantSettings**](SingleTenantApi.md#getSingleTenantSettings) | **GET** /single-tenant/settings | Retrieve the settings of the single tenant. |
| [**updateSingleTenantSettings**](SingleTenantApi.md#updateSingleTenantSettings) | **PATCH** /single-tenant/settings | Update configuration information for single-tenant functionality |
| [**getCloudFormationLaunchStackLinkForSingleTenant**](SingleTenantApi.md#getCloudFormationLaunchStackLinkForSingleTenant) | **GET** /single-tenant/cloudformation-launch-stack-link | Get CloudFormation Stack Launch Link For SaaS Infrastructure Management |
| [**getSingleTenantSettings**](SingleTenantApi.md#getSingleTenantSettings) | **GET** /single-tenant/settings | Retrieve the settings of the SaaS Infrastructure Management. |
| [**updateSingleTenantSettings**](SingleTenantApi.md#updateSingleTenantSettings) | **PATCH** /single-tenant/settings | Update configuration information for SaaS Infrastructure Management |


<a id="getCloudFormationLaunchStackLinkForSingleTenant"></a>
# **getCloudFormationLaunchStackLinkForSingleTenant**
> CloudFormationLaunchStackLink getCloudFormationLaunchStackLinkForSingleTenant()

Get CloudFormation Stack Launch Link For Single Tenant
Get CloudFormation Stack Launch Link For SaaS Infrastructure Management

Get the CloudFormation stack activation link for Single Tenant.
Get the CloudFormation stack activation link for SaaS Infrastructure Management.

### Example
```java
Expand Down Expand Up @@ -77,7 +77,7 @@ This endpoint does not need any parameter.
# **getSingleTenantSettings**
> SingleTenantSettings getSingleTenantSettings()

Retrieve the settings of the single tenant.
Retrieve the settings of the SaaS Infrastructure Management.

### Example
```java
Expand Down Expand Up @@ -139,9 +139,9 @@ This endpoint does not need any parameter.
# **updateSingleTenantSettings**
> updateSingleTenantSettings(updateSingleTenantSettingsParam)

Update configuration information for single-tenant functionality
Update configuration information for SaaS Infrastructure Management

Updates configuration information for single-tenant functionality Returns error if single tenant feature cannot be enabled.
Updates configuration information for SaaS Infrastructure Management Returns error if SaaS Infrastructure Management feature cannot be enabled.

### Example
```java
Expand Down
2 changes: 1 addition & 1 deletion docs/auth/SingleTenantSettings.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@

| Name | Type | Description | Notes |
|------------ | ------------- | ------------- | -------------|
|**enabled** | **Boolean** | enable Single Tenant settings or not | |
|**enabled** | **Boolean** | enable SaaS Infrastructure Management settings or not | |
|**roleArn** | **String** | ARN of the role for SaaS Platform to AssumeRole | |
|**cloudformationTemplateUrl** | **String** | S3 URL where the CloudFormationTemplate to be executed in the SaaS environment is stored | |
|**ddlTemplateUrl** | **String** | S3 URL where the CloudFormationTemplate to be executed in the SaaS environment is stored | |
Expand Down
14 changes: 14 additions & 0 deletions docs/auth/StripeCustomer.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@


# StripeCustomer


## Properties

| Name | Type | Description | Notes |
|------------ | ------------- | ------------- | -------------|
|**customerId** | **String** | stripe Customer ID | |
|**subscriptionScheduleId** | **String** | stripe Subscription Schedule ID | |



2 changes: 1 addition & 1 deletion docs/auth/Tenant.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@
|**attributes** | **Map&lt;String, Object&gt;** | attribute info | |
|**backOfficeStaffEmail** | **String** | administrative staff email address | |
|**nextPlanId** | **String** | | [optional] |
|**usingNextPlanFrom** | **Integer** | Next billing plan start time (When using stripe, you can create a subscription that starts at the beginning of the current month by specifying 00:00 (UTC) at the beginning of the current month. Ex. 1672531200 for January 2023.) | [optional] |
|**usingNextPlanFrom** | **Integer** | This parameter is set when reserving a pricing plan change for a future date and time. It is not required for immediate application. When specifying the next pricing plan start date and time, please specify a date and time at least 5 minutes after the current time. Note for Stripe integration: By specifying the beginning of the current month (00:00 UTC) as the start date and time, you can create a subscription that starts from the first day of that month. (Example: To specify January 1, 2023 00:00 UTC → 1672531200) | [optional] |
|**nextPlanTaxRateId** | **String** | | [optional] |
|**prorationBehavior** | **ProrationBehavior** | | [optional] |
|**deleteUsage** | **Boolean** | If you have a stripe linkage, you can set whether to delete pay-as-you-go items when changing plans. When you change plan, you can remove all pay-as-you-go items included in your current subscription to stop being billed based on pay-as-you-go items. The recorded usage is cleared immediately. Since it cannot be restored, please note that plan change reservations with delete_usage set to true cannot be canceled. | [optional] |
Expand Down
Loading