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"`)



6 changes: 4 additions & 2 deletions docs/auth/CreateSaasUserParam.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,13 +2,15 @@

# CreateSaasUserParam

Either email or sign_in_id must be specified, but not both. - If email is specified: Email authentication user will be created. When password is not specified, a temporary password will be sent by email. - If sign_in_id is specified: Sign-in ID authentication user will be created. When password is not specified, it will be auto-generated and returned in the response.

## Properties

| Name | Type | Description | Notes |
|------------ | ------------- | ------------- | -------------|
|**email** | **String** | E-mail | |
|**password** | **String** | Password | |
|**email** | **String** | E-mail | [optional] |
|**signInId** | **String** | Sign-in ID (alphanumeric and symbols -_ only, max 50 characters) | [optional] |
|**password** | **String** | Password. For email authentication, if not specified, a temporary password will be sent by email. For sign-in ID authentication, if not specified, password will be auto-generated and returned. | [optional] |



4 changes: 3 additions & 1 deletion docs/auth/CreateTenantUserParam.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,12 +2,14 @@

# CreateTenantUserParam

Either email or sign_in_id must be specified, but not both.

## Properties

| Name | Type | Description | Notes |
|------------ | ------------- | ------------- | -------------|
|**email** | **String** | E-mail | |
|**email** | **String** | E-mail | [optional] |
|**signInId** | **String** | Sign-in ID (alphanumeric and symbols -_ only, max 50 characters) | [optional] |
|**attributes** | **Map<String, Object>** | Attribute information (Get information set by defining user attributes in the SaaS development console) | |


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


# CreatedSaasUser


## Properties

| Name | Type | Description | Notes |
|------------ | ------------- | ------------- | -------------|
|**id** | **String** | | |
|**email** | **String** | E-mail. For sign-in ID authentication users, this field is not set. | |
|**signInId** | **String** | Sign-in ID. For email authentication users, this field is not set. | |
|**attributes** | **Map<String, Object>** | Attribute information | |
|**password** | **String** | Auto-generated password (only when sign_in_id authentication and password not specified) | [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] |



72 changes: 72 additions & 0 deletions docs/auth/RoleApi.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@ All URIs are relative to *https://api.saasus.io/v1/auth*
| [**createRole**](RoleApi.md#createRole) | **POST** /roles | Create Role |
| [**deleteRole**](RoleApi.md#deleteRole) | **DELETE** /roles/{role_name} | Delete Role |
| [**getRoles**](RoleApi.md#getRoles) | **GET** /roles | Get Roles |
| [**updateRole**](RoleApi.md#updateRole) | **PATCH** /roles/{role_name} | Update Role |


<a id="createRole"></a>
Expand Down Expand Up @@ -210,3 +211,74 @@ This endpoint does not need any parameter.
| **200** | OK | - |
| **500** | Internal Server Error | - |

<a id="updateRole"></a>
# **updateRole**
> updateRole(roleName, updateRoleParam)

Update Role

Update role display name.

### 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.RoleApi;

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");

RoleApi apiInstance = new RoleApi(defaultClient);
String roleName = "admin"; // String | Role name
UpdateRoleParam updateRoleParam = new UpdateRoleParam(); // UpdateRoleParam |
try {
apiInstance.updateRole(roleName, updateRoleParam);
} catch (ApiException e) {
System.err.println("Exception when calling RoleApi#updateRole");
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 |
|------------- | ------------- | ------------- | -------------|
| **roleName** | **String**| Role name | |
| **updateRoleParam** | [**UpdateRoleParam**](UpdateRoleParam.md)| | [optional] |

### Return type

null (empty response body)

### 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 | - |
| **400** | Bad Request | - |
| **404** | Not Found | - |
| **500** | Internal Server Error | - |

3 changes: 2 additions & 1 deletion docs/auth/SaasUser.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,8 @@
| Name | Type | Description | Notes |
|------------ | ------------- | ------------- | -------------|
|**id** | **String** | | |
|**email** | **String** | E-mail | |
|**email** | **String** | E-mail. For sign-in ID authentication users, this field is not set. | |
|**signInId** | **String** | Sign-in ID. For email authentication users, this field is not set. | |
|**attributes** | **Map&lt;String, Object&gt;** | Attribute information | |


Expand Down
Loading