Auth API

• basicInfo
  • get基本設定情報の取得
  • put基本設定情報の更新
  • get通知メールテンプレートを取得
  • put通知メールテンプレートを更新
  • get認証系画面設定情報取得
  • patch認証系画面設定情報設定
  • get認証認可基本情報取得
  • patch認証認可基本情報更新
• authInfo
  • get認証情報を取得
  • put認証情報を更新
  • getcognitoに設定している外部プロバイダ経由のサインイン情報取得
  • put外部IDプロバイダのサインイン情報更新
  • getパスワード要件を取得
  • putパスワード要件を更新
• saasUser
  • getユーザー一覧を取得
  • postSaaSにユーザーを作成
  • getユーザー情報を取得
  • delユーザー情報を削除
  • patchパスワードを変更
  • patchメールアドレスを変更
  • postユーザーのメールアドレス変更要求
  • postユーザーのメールアドレス変更確認
  • put認証アプリケーションを登録
  • post認証アプリケーション登録用のシークレットコードを作成
  • getユーザーのMFA設定を取得
  • patchユーザーのMFA設定を更新
  • del外部IDプロバイダの連携解除
  • post外部アカウントのユーザー連携要求
  • post外部アカウントのユーザーの連携確認
  • post新規登録
  • post新規登録時の確認メール再送信
  • postAWS Marketplaceによるユーザー新規登録
  • postAWS Marketplaceによるユーザー新規登録の確定
  • patchAWS Marketplaceと既存のテナントの連携
• tenantUser
  • getユーザー一覧を取得
  • getユーザー情報を取得
  • getテナントのユーザー一覧を取得
  • postテナントにユーザーを作成
  • getテナントのユーザー情報を取得
  • patchテナントのユーザー属性情報を更新
  • delテナントのユーザー情報を削除
  • postテナントのユーザー情報に役割(ロール)を作成
  • delテナントのユーザーから役割(ロール)を削除
• userAttribute
  • getユーザー属性の一覧を取得
  • postユーザー属性の作成
  • delユーザー属性の削除
• tenantAttribute
  • getテナント属性の一覧を取得
  • postテナント属性の作成
  • delテナント属性の削除
• role
  • get役割(ロール)一覧を取得
  • post役割(ロール)を作成
  • del役割(ロール)を削除
• tenant
  • getテナント一覧取得
  • postテナントを作成
  • getテナント情報を取得
  • patchテナント情報を更新
  • delテナント情報を削除
  • putテナントのプラン情報を更新
  • putテナントの請求先情報を更新
  • getテナント毎の外部IDプロバイダ取得
  • putテナント毎の外部IDプロバイダ更新
  • patchstripe初期設定
  • delstripe上の顧客情報・商品情報の削除
  • putプランに関わる情報を全削除
• saasusTenant
• env
  • get環境情報一覧を取得
  • post環境情報を作成
  • get環境情報を取得
  • patch環境情報を更新
  • del環境情報を削除
• credential
  • get認証・認可情報の取得
  • post認証・認可情報の保存
• invitation
  • getテナントの招待一覧を取得
  • postテナントへの招待を作成
  • getテナントの招待情報を取得
  • delテナントへの招待を削除
  • getテナントへの招待の有効性を取得
  • patchテナントへの招待を検証
• error
  • getステータスコード500でサーバーエラーを返却
• userInfo
  • getユーザー情報取得

API docs by Redocly

SaaSus Auth API Schema (1.0.0)

スキーマ

basicInfo

基本情報

基本設定情報の取得

SaaS ID を元に設定されているドメイン名と CNAME レコードを取得します。 取得した CNAME レコードを DNS に設定することで、ログイン画面を生成します。

Authorizations:

Bearer

Responses

Production API Server

https://api.saasus.io/v1/auth/basic-info

Response samples

• 200
• 500

Content type

application/json

{

• "domain_name": "dev.saasus.io",
• "is_dns_validated": false,
• "certificate_dns_record": {

  • "type": "CNAME",
  • "name": "_k90jaskdfawehro.domain-of-saasus-client.com.",
  • "value": "_cmojwc239j102mosd9.acm-validations.aws."

  },
• "cloud_front_dns_record": {

  • "type": "CNAME",
  • "name": "_k90jaskdfawehro.domain-of-saasus-client.com.",
  • "value": "_cmojwc239j102mosd9.acm-validations.aws."

  },
• "dkim_dns_records": [

  • {

    • "type": "CNAME",
    • "name": "_k90jaskdfawehro.domain-of-saasus-client.com.",
    • "value": "_cmojwc239j102mosd9.acm-validations.aws."

    }

  ],
• "default_domain_name": "d78bh0l3saarv.cloudfront.net",
• "from_email_address": "test@example.com",
• "reply_email_address": "test@example.com",
• "is_ses_sandbox_granted": false

}

基本設定情報の更新

SaaS ID を元にパラメータとして設定したドメイン名を設定更新します。 CNAME レコードが生成されますので、 DNS に設定して下さい。 既に稼働中の SaaS アプリケーションに設定している場合には、動作に影響があります。

Authorizations:

Bearer

Request Body schema: application/json

domain_name required	string ドメイン名
from_email_address required	string 認証メールの送信元メールアドレス
reply_email_address	string 認証メールの返信元メールアドレス

Responses

Production API Server

https://api.saasus.io/v1/auth/basic-info

Request samples

• Payload

Content type

application/json

{

• "domain_name": "dev.saasus.io",
• "from_email_address": "test@example.com",
• "reply_email_address": "test@example.com"

}

Response samples

• 500

Content type

application/json

{

• "type": "string",
• "message": "string",
• "data": {

  • "sign_in_page_url": "auth.dev.saasus.io"

  }

}

通知メールテンプレートを取得

各種通知メールテンプレートを取得します。

Authorizations:

Bearer

Responses

Production API Server

https://api.saasus.io/v1/auth/notification-messages

Response samples

• 200
• 500

Content type

application/json

{

• "sign_up": {

  • "subject": "Verify your new account",
  • "message": "The verification code to your new account is {####}"

  },
• "create_user": {

  • "subject": "Verify your new account",
  • "message": "The verification code to your new account is {####}"

  },
• "resend_code": {

  • "subject": "Verify your new account",
  • "message": "The verification code to your new account is {####}"

  },
• "forgot_password": {

  • "subject": "Verify your new account",
  • "message": "The verification code to your new account is {####}"

  },
• "update_user_attribute": {

  • "subject": "Verify your new account",
  • "message": "The verification code to your new account is {####}"

  },
• "verify_user_attribute": {

  • "subject": "Verify your new account",
  • "message": "The verification code to your new account is {####}"

  },
• "authentication_mfa": {

  • "subject": "Verify your new account",
  • "message": "The verification code to your new account is {####}"

  },
• "invite_tenant_user": {

  • "subject": "Verify your new account",
  • "message": "The verification code to your new account is {####}"

  },
• "verify_external_user": {

  • "subject": "Verify your new account",
  • "message": "The verification code to your new account is {####}"

  }

}

通知メールテンプレートを更新

各種通知メールテンプレート更新します。

Authorizations:

Bearer

Request Body schema: application/json

	object (MessageTemplate)
	object (MessageTemplate)
	object (MessageTemplate)
	object (MessageTemplate)
	object (MessageTemplate)
	object (MessageTemplate)
	object (MessageTemplate)
	object (MessageTemplate)
	object (MessageTemplate)

Responses

Production API Server

https://api.saasus.io/v1/auth/notification-messages

Request samples

• Payload

Content type

application/json

{

• "sign_up": {

  • "subject": "Verify your new account",
  • "message": "The verification code to your new account is {####}"

  },
• "create_user": {

  • "subject": "Verify your new account",
  • "message": "The verification code to your new account is {####}"

  },
• "resend_code": {

  • "subject": "Verify your new account",
  • "message": "The verification code to your new account is {####}"

  },
• "forgot_password": {

  • "subject": "Verify your new account",
  • "message": "The verification code to your new account is {####}"

  },
• "update_user_attribute": {

  • "subject": "Verify your new account",
  • "message": "The verification code to your new account is {####}"

  },
• "verify_user_attribute": {

  • "subject": "Verify your new account",
  • "message": "The verification code to your new account is {####}"

  },
• "authentication_mfa": {

  • "subject": "Verify your new account",
  • "message": "The verification code to your new account is {####}"

  },
• "invite_tenant_user": {

  • "subject": "Verify your new account",
  • "message": "The verification code to your new account is {####}"

  },
• "verify_external_user": {

  • "subject": "Verify your new account",
  • "message": "The verification code to your new account is {####}"

  }

}

Response samples

• 500

Content type

application/json

{

• "type": "string",
• "message": "string",
• "data": {

  • "sign_in_page_url": "auth.dev.saasus.io"

  }

}

認証系画面設定情報取得

認証系画面設定情報（新規登録・ログイン・パスワードリセット等）を取得します。

Authorizations:

Bearer

Responses

Production API Server

https://api.saasus.io/v1/auth/customize-pages

Response samples

• 200
• 500

Content type

application/json

{

• "sign_up_page": {

  • "html_contents": "<html><div>画面内容</div></html>",
  • "is_terms_of_service": true,
  • "is_privacy_policy": true

  },
• "sign_in_page": {

  • "html_contents": "<html><div>画面内容</div></html>",
  • "is_terms_of_service": true,
  • "is_privacy_policy": true

  },
• "password_reset_page": {

  • "html_contents": "<html><div>画面内容</div></html>",
  • "is_terms_of_service": true,
  • "is_privacy_policy": true

  }

}

認証系画面設定情報設定

認証系画面設定情報（新規登録・ログイン・パスワードリセット等）を更新します。

Authorizations:

Bearer

Request Body schema: application/json

	object (CustomizePageProps)
	object (CustomizePageProps)
	object (CustomizePageProps)

Responses

Production API Server

https://api.saasus.io/v1/auth/customize-pages

Request samples

• Payload

Content type

application/json

{

• "sign_up_page": {

  • "html_contents": "<html><div>画面内容</div></html>",
  • "is_terms_of_service": true,
  • "is_privacy_policy": true

  },
• "sign_in_page": {

  • "html_contents": "<html><div>画面内容</div></html>",
  • "is_terms_of_service": true,
  • "is_privacy_policy": true

  },
• "password_reset_page": {

  • "html_contents": "<html><div>画面内容</div></html>",
  • "is_terms_of_service": true,
  • "is_privacy_policy": true

  }

}

Response samples

• 500

Content type

application/json

{

• "type": "string",
• "message": "string",
• "data": {

  • "sign_in_page_url": "auth.dev.saasus.io"

  }

}

認証認可基本情報取得

認証認可基本情報を取得します。

Authorizations:

Bearer

Responses

Production API Server

https://api.saasus.io/v1/auth/customize-page-settings

Response samples

• 200
• 500

Content type

application/json

{

• "icon": "http://icon.example.com",
• "favicon": "http://icon.example.com",
• "title": "SaaSus",
• "terms_of_service_url": "http://dev.example.com/terms",
• "privacy_policy_url": "http://dev.example.com/privacy",
• "google_tag_manager_container_id": "GTM-XXXXXXX"

}

認証認可基本情報更新

認証認可基本情報を更新します。

Authorizations:

Bearer

Request Body schema: application/json

icon required	string <base64> サービスアイコン
favicon required	string <base64> ファビコン
title required	string サービス名
terms_of_service_url required	string 利用規約URL
privacy_policy_url required	string プライバシーポリシーURL
google_tag_manager_container_id required	string Google Tag Manager コンテナ ID

Responses

Production API Server

https://api.saasus.io/v1/auth/customize-page-settings

Request samples

• Payload

Content type

application/json

{

• "icon": "data:image/png;base64,ZDMiIHN0UmVmOmRvY3VtZW50SUQ9Inhtc==",
• "favicon": "data:image/png;base64,ZDMiIHN0UmVmOmRvY3VtZW50SUQ9Inhtc==",
• "title": "SaaSus",
• "terms_of_service_url": "http://dev.example.com/terms",
• "privacy_policy_url": "http://dev.example.com/privacy",
• "google_tag_manager_container_id": "GTM-XXXXXXX"

}

Response samples

• 500

Content type

application/json

{

• "type": "string",
• "message": "string",
• "data": {

  • "sign_in_page_url": "auth.dev.saasus.io"

  }

}

authInfo

認証情報

認証情報を取得

ログイン後に認証情報を渡す SaaS の URL を取得します。 ここで取得した URL へ認証情報を渡し、SaaSus SDK を利用してこの Callback の実装をすることが可能となります。

Authorizations:

Bearer

Responses

Production API Server

https://api.saasus.io/v1/auth/auth-info

Response samples

• 200
• 500

Content type

application/json

{

• "callback_url": "https://example.com/callback"

}

認証情報を更新

ログイン後に認証情報を渡す SaaS の URL を登録します。 ここで登録した URL に認証情報を渡し、SaaSus SDK を利用してこの Callback の実装をすることが可能となります。

Authorizations:

Bearer

Request Body schema: application/json

callback_url required

string 認証後遷移先

Responses

Production API Server

https://api.saasus.io/v1/auth/auth-info

Request samples

• Payload

Content type

application/json

{

• "callback_url": "https://example.com/callback"

}

Response samples

• 500

Content type

application/json

{

• "type": "string",
• "message": "string",
• "data": {

  • "sign_in_page_url": "auth.dev.saasus.io"

  }

}

cognitoに設定している外部プロバイダ経由のサインイン情報取得

cognitoに設定している外部プロバイダ経由のサインイン情報を取得します。

Authorizations:

Bearer

Responses

Production API Server

https://api.saasus.io/v1/auth/identity-providers

Response samples

• 200
• 500

Content type

application/json

{

• "google": {

  • "application_id": 1234567890123456,
  • "application_secret": "123456789b00def123456a12345678d1",
  • "approval_scope": "profile email openid",
  • "is_button_hidden": false

  }

}

外部IDプロバイダのサインイン情報更新

外部IDプロバイダのサインイン情報を更新します。

Authorizations:

Bearer

Request Body schema: application/json

provider required	string (ProviderName) Value: "Google"
	object (IdentityProviderProps)

Responses

Production API Server

https://api.saasus.io/v1/auth/identity-providers

Request samples

• Payload

Content type

application/json

{

• "provider": "Google",
• "identity_provider_props": {

  • "application_id": 1234567890123456,
  • "application_secret": "123456789b00def123456a12345678d1",
  • "approval_scope": "profile email openid",
  • "is_button_hidden": false

  }

}

Response samples

• 500

Content type

application/json

{

• "type": "string",
• "message": "string",
• "data": {

  • "sign_in_page_url": "auth.dev.saasus.io"

  }

}

パスワード要件を取得

ユーザーパスワードの要件設定を取得します。 アルファベット、数字、記号の組み合わせで、桁数を長くすれば解読されづらい安全なパスワードを設定することが可能となります。

Authorizations:

Bearer

Responses

Production API Server

https://api.saasus.io/v1/auth/sign-in-settings

Response samples

• 200
• 500

Content type

application/json

{

• "password_policy": {

  • "minimum_length": 10,
  • "is_require_lowercase": true,
  • "is_require_numbers": true,
  • "is_require_symbols": true,
  • "is_require_uppercase": true,
  • "temporary_password_validity_days": 10

  },
• "device_configuration": {

  • "device_remembering": "always"

  },
• "mfa_configuration": {

  • "mfa_configuration": "on"

  },
• "recaptcha_props": {

  • "site_key": "ede66c43-9b9d-4222-93ed-5f11c96e08e2",
  • "secret_key": "d5794b1b-5f92-4dc6-aa48-085dbb08b813"

  },
• "account_verification": {

  • "verification_method": "code",
  • "sending_to": "email"

  },
• "self_regist": {

  • "enable": true

  },
• "identity_provider_configuration": {

  • "domain": "string",
  • "redirect_url": "string",
  • "entity_id": "string",
  • "reply_url": "string"

  }

}

パスワード要件を更新

ユーザーパスワードの要件設定を更新します。 アルファベット、数字、記号の組み合わせで、桁数を長くすれば解読されづらい安全なパスワードを設定することが可能となります。

Authorizations:

Bearer

Request Body schema: application/json

	object (PasswordPolicy) パスワードポリシー
	object (DeviceConfiguration) 信頼済みデバイスの記憶の設定
	object (MfaConfiguration) MFAデバイス認証設定 ※ 未提供の機能のため、変更・保存はできません
	object (RecaptchaProps) reCAPTCHA認証設定 ※ 未提供の機能のため、変更・保存はできません。
	object (AccountVerification) アカウント認証設定 ※ 未提供の機能のため、変更・保存はできません。
	object (SelfRegist) セルフサインアップを許可設定

Responses

Production API Server

https://api.saasus.io/v1/auth/sign-in-settings

Request samples

• Payload

Content type

application/json

{

• "password_policy": {

  • "minimum_length": 10,
  • "is_require_lowercase": true,
  • "is_require_numbers": true,
  • "is_require_symbols": true,
  • "is_require_uppercase": true,
  • "temporary_password_validity_days": 10

  },
• "device_configuration": {

  • "device_remembering": "always"

  },
• "mfa_configuration": {

  • "mfa_configuration": "on"

  },
• "recaptcha_props": {

  • "site_key": "ede66c43-9b9d-4222-93ed-5f11c96e08e2",
  • "secret_key": "d5794b1b-5f92-4dc6-aa48-085dbb08b813"

  },
• "account_verification": {

  • "verification_method": "code",
  • "sending_to": "email"

  },
• "self_regist": {

  • "enable": true

  }

}

Response samples

• 500

Content type

application/json

{

• "type": "string",
• "message": "string",
• "data": {

  • "sign_in_page_url": "auth.dev.saasus.io"

  }

}

saasUser

SaaS単位のユーザー

ユーザー一覧を取得

SaaSのユーザー全件を取得します。

Authorizations:

Bearer

Responses

Production API Server

https://api.saasus.io/v1/auth/users

Response samples

• 200
• 500

Content type

application/json

{

• "users": [

  • {

    • "id": "69e732d6-8ecc-45c4-c2eb-8438f7ffe775",
    • "email": "hoge@example.com"

    }

  ]

}

SaaSにユーザーを作成

SaaSにユーザーを作成します。

Authorizations:

Bearer

Request Body schema: application/json

email required	string メールアドレス
password required	string パスワード

Responses

Production API Server

https://api.saasus.io/v1/auth/users

Request samples

• Payload

Content type

application/json

{

• "email": "hoge@example.com",
• "password": "@Pass#Word1"

}

Response samples

• 201
• 400
• 500

Content type

application/json

{

• "id": "69e732d6-8ecc-45c4-c2eb-8438f7ffe775",
• "email": "hoge@example.com"

}

ユーザー情報を取得

ユーザーIDからユーザー情報を取得します。

Authorizations:

Bearer

path Parameters

user_id required

string Example: f94bfffc-8be2-11ec-b41a-0242ac120004 ユーザーID

Responses

Production API Server

https://api.saasus.io/v1/auth/users/{user_id}

Response samples

• 200
• 404
• 500

Content type

application/json

{

• "id": "69e732d6-8ecc-45c4-c2eb-8438f7ffe775",
• "email": "hoge@example.com"

}

ユーザー情報を削除

ユーザーIDを元に一致するユーザーをテナントからすべて削除し、SaaSからも削除します。

Authorizations:

Bearer

path Parameters

user_id required

string Example: f94bfffc-8be2-11ec-b41a-0242ac120004 ユーザーID

Responses

Production API Server

https://api.saasus.io/v1/auth/users/{user_id}

Response samples

• 404
• 500

Content type

application/json

{

• "type": "string",
• "message": "string",
• "data": {

  • "sign_in_page_url": "auth.dev.saasus.io"

  }

}

パスワードを変更

ユーザーのログインパスワードを変更します。

Authorizations:

Bearer

path Parameters

user_id required

string Example: f94bfffc-8be2-11ec-b41a-0242ac120004 ユーザーID

Request Body schema: application/json

password required

string パスワード

Responses

Production API Server

https://api.saasus.io/v1/auth/users/{user_id}/password

Request samples

• Payload

Content type

application/json

{

• "password": "@Pass#Word1"

}

Response samples

• 500

Content type

application/json

{

• "type": "string",
• "message": "string",
• "data": {

  • "sign_in_page_url": "auth.dev.saasus.io"

  }

}

メールアドレスを変更

ユーザーのメールアドレスを変更します。

Authorizations:

Bearer

path Parameters

user_id required

string Example: f94bfffc-8be2-11ec-b41a-0242ac120004 ユーザーID

Request Body schema: application/json

email required

string メールアドレス

Responses

Production API Server

https://api.saasus.io/v1/auth/users/{user_id}/email

Request samples

• Payload

Content type

application/json

{

• "email": "hoge@example.com"

}

Response samples

• 500

Content type

application/json

{

• "type": "string",
• "message": "string",
• "data": {

  • "sign_in_page_url": "auth.dev.saasus.io"

  }

}

ユーザーのメールアドレス変更要求

ユーザーのメールアドレス変更を要求します。 要求されたメールアドレスに対して検証コードを送信します。 ユーザーのアクセストークンが必要です。 検証コードの有効期限は24時間です。

Authorizations:

Bearer

path Parameters

user_id required

string Example: f94bfffc-8be2-11ec-b41a-0242ac120004 ユーザーID

Request Body schema: application/json

email required	string メールアドレス
access_token required	string (アクセストークン)

Responses

Production API Server

https://api.saasus.io/v1/auth/users/{user_id}/email/request

Request samples

• Payload

Content type

application/json

{

• "email": "hoge@example.com",
• "access_token": "string"

}

Response samples

• 500

Content type

application/json

{

• "type": "string",
• "message": "string",
• "data": {

  • "sign_in_page_url": "auth.dev.saasus.io"

  }

}

ユーザーのメールアドレス変更確認

ユーザーのメールアドレス変更確認のためにコードを検証します。 ユーザーのアクセストークンが必要です。

Authorizations:

Bearer

path Parameters

user_id required

string Example: f94bfffc-8be2-11ec-b41a-0242ac120004 ユーザーID

Request Body schema: application/json

code required	string (検証コード)
access_token required	string (アクセストークン)

Responses

Production API Server

https://api.saasus.io/v1/auth/users/{user_id}/email/confirm

Request samples

• Payload

Content type

application/json

{

• "code": "123456",
• "access_token": "string"

}

Response samples

• 500

Content type

application/json

{

• "type": "string",
• "message": "string",
• "data": {

  • "sign_in_page_url": "auth.dev.saasus.io"

  }

}

認証アプリケーションを登録

認証アプリケーションを登録します。

Authorizations:

Bearer

path Parameters

user_id required

string Example: f94bfffc-8be2-11ec-b41a-0242ac120004 ユーザーID

Request Body schema: application/json

access_token required	string (アクセストークン) アクセストークン
verification_code required	string (検証コード) 検証コード

Responses

Production API Server

https://api.saasus.io/v1/auth/users/{user_id}/mfa/software-token

Request samples

• Payload

Content type

application/json

{

• "access_token": "string",
• "verification_code": "string"

}

Response samples

• 500

Content type

application/json

{

• "type": "string",
• "message": "string",
• "data": {

  • "sign_in_page_url": "auth.dev.saasus.io"

  }

}

認証アプリケーション登録用のシークレットコードを作成

認証アプリケーション登録用のシークレットコードを作成します。

Authorizations:

Bearer

path Parameters

user_id required

string Example: f94bfffc-8be2-11ec-b41a-0242ac120004 ユーザーID

Request Body schema: application/json

access_token required

string (アクセストークン) アクセストークン

Responses

Production API Server

https://api.saasus.io/v1/auth/users/{user_id}/mfa/software-token/secret-code

Request samples

• Payload

Content type

application/json

{

• "access_token": "string"

}

Response samples

• 201
• 500

Content type

application/json

{

• "secret_code": "string"

}

ユーザーのMFA設定を取得

ユーザーのMFA設定を取得します。

Authorizations:

Bearer

path Parameters

user_id required

string Example: f94bfffc-8be2-11ec-b41a-0242ac120004 ユーザーID

Responses

Production API Server

https://api.saasus.io/v1/auth/users/{user_id}/mfa/preference

Response samples

• 200
• 500

Content type

application/json

{

• "enabled": true,
• "method": "softwareToken"

}

ユーザーのMFA設定を更新

ユーザーのMFA設定を更新します。

Authorizations:

Bearer

path Parameters

user_id required

string Example: f94bfffc-8be2-11ec-b41a-0242ac120004 ユーザーID

Request Body schema: application/json

enabled required	boolean (MFAを有効にするか否か) MFAを有効にするか否か
method	string (MFAの方法) Value: "softwareToken" MFAの方法(enabledがtrueの場合は必須)

Responses

Production API Server

https://api.saasus.io/v1/auth/users/{user_id}/mfa/preference

Request samples

• Payload

Content type

application/json

{

• "enabled": true,
• "method": "softwareToken"

}

Response samples

• 500

Content type

application/json

{

• "type": "string",
• "message": "string",
• "data": {

  • "sign_in_page_url": "auth.dev.saasus.io"

  }

}

外部IDプロバイダの連携解除

外部IDプロバイダの連携を解除します。

Authorizations:

Bearer

path Parameters

provider_name required	string Example: Google
user_id required	string Example: f94bfffc-8be2-11ec-b41a-0242ac120004 ユーザーID

Responses

Production API Server

https://api.saasus.io/v1/auth/users/{user_id}/providers/{provider_name}

Response samples

• 500

Content type

application/json

{

• "type": "string",
• "message": "string",
• "data": {

  • "sign_in_page_url": "auth.dev.saasus.io"

  }

}

外部アカウントのユーザー連携要求

外部アカウントのユーザー連携を要求します。 アクセストークンから連携するユーザーのメールアドレスを取得し、そのメールアドレスに対して検証コードを送信します。 検証コードの有効期限は24時間です。

Authorizations:

Bearer

Request Body schema: application/json

access_token required

string (アクセストークン)

Responses

Production API Server

https://api.saasus.io/v1/auth/external-users/request

Request samples

• Payload

Content type

application/json

{

• "access_token": "string"

}

Response samples

• 400
• 500

Content type

application/json

{

• "type": "string",
• "message": "string",
• "data": {

  • "sign_in_page_url": "auth.dev.saasus.io"

  }

}

外部アカウントのユーザーの連携確認

外部アカウントのユーザー連携確認のためにコードを検証します。

Authorizations:

Bearer

Request Body schema: application/json

access_token required	string (アクセストークン)
code required	string (検証コード)

Responses

Production API Server

https://api.saasus.io/v1/auth/external-users/confirm

Request samples

• Payload

Content type

application/json

{

• "access_token": "string",
• "code": "123456"

}

Response samples

• 400
• 500

Content type

application/json

{

• "type": "string",
• "message": "string",
• "data": {

  • "sign_in_page_url": "auth.dev.saasus.io"

  }

}

新規登録

ユーザーを新規登録します。登録されたメールアドレスに対して仮パスワードを送信します。

Authorizations:

Bearer

Request Body schema: application/json

email required

string (メールアドレス) メールアドレス

Responses

Production API Server

https://api.saasus.io/v1/auth/sign-up

Request samples

• Payload

Content type

application/json

{

• "email": "string"

}

Response samples

• 201
• 500

Content type

application/json

{

• "id": "69e732d6-8ecc-45c4-c2eb-8438f7ffe775",
• "email": "hoge@example.com"

}

新規登録時の確認メール再送信

新規登録時の仮パスワードを再送信します。

Authorizations:

Bearer

Request Body schema: application/json

email required

string (メールアドレス) メールアドレス

Responses

Production API Server

https://api.saasus.io/v1/auth/sign-up/resend

Request samples

• Payload

Content type

application/json

{

• "email": "string"

}

Response samples

• 500

Content type

application/json

{

• "type": "string",
• "message": "string",
• "data": {

  • "sign_in_page_url": "auth.dev.saasus.io"

  }

}

AWS Marketplaceによるユーザー新規登録

AWS Marketplaceと連携したユーザーを新規登録します。登録されたメールアドレスに対して仮パスワードを送信します。 Registration Tokenが有効でない場合はエラーを返却します。

Authorizations:

Bearer

Request Body schema: application/json

email required	string (メールアドレス) メールアドレス
registration_token required	string (登録トークン) 登録トークン

Responses

Production API Server

https://api.saasus.io/v1/auth/aws-marketplace/sign-up

Request samples

• Payload

Content type

application/json

{

• "email": "string",
• "registration_token": "string"

}

Response samples

• 201
• 500

Content type

application/json

{

• "id": "69e732d6-8ecc-45c4-c2eb-8438f7ffe775",
• "email": "hoge@example.com"

}

AWS Marketplaceによるユーザー新規登録の確定

AWS Marketplaceと連携したユーザー新規登録を確定します。AWS Marketplaceと連携したテナントを新規作成します。 Registration Tokenが有効でない場合はエラーを返却します。

Authorizations:

Bearer

Request Body schema: application/json

tenant_name	string (テナント名) テナント名
access_token required	string (アクセストークン) アクセストークン
registration_token required	string (登録トークン) 登録トークン

Responses

Production API Server

https://api.saasus.io/v1/auth/aws-marketplace/sign-up-confirm

Request samples

• Payload

Content type

application/json

{

• "tenant_name": "string",
• "access_token": "string",
• "registration_token": "string"

}

Response samples

• 201
• 500

Content type

application/json

{

• "id": "69e732d6-8ecc-45c4-c2eb-8438f7ffe775",
• "plan_id": "69e732d6-8ecc-45c4-c2eb-8438f7ffe775",
• "billing_info": {

  • "name": "株式会社テストテナント",
  • "address": {

    • "street": "神宮前1-1-1",
    • "city": "渋谷区",
    • "state": "東京都",
    • "country": "JP",
    • "additional_address_info": "オフィスビル3階",
    • "postal_code": "123-4567"

    },
  • "invoice_language": "ja-JP"

  },
• "name": "Anti-Pattern Inc.",
• "attributes": {

  • "address": "東京都",
  • "employee_number": 100

  },
• "back_office_staff_email": "hoge@example.com",
• "next_plan_id": "69e732d6-8ecc-45c4-c2eb-8438f7ffe775",
• "using_next_plan_from": 1640995200,
• "next_plan_tax_rate_id": "69e732d6-8ecc-45c4-c2eb-8438f7ffe775",
• "proration_behavior": "create_prorations",
• "delete_usage": true,
• "plan_histories": [

  • {

    • "plan_id": "69e732d6-8ecc-45c4-c2eb-8438f7ffe775",
    • "plan_applied_at": 1640995200,
    • "tax_rate_id": "69e732d6-8ecc-45c4-c2eb-8438f7ffe775",
    • "proration_behavior": "create_prorations",
    • "delete_usage": true

    }

  ]

}

AWS Marketplaceと既存のテナントの連携

AWS Marketplaceと既存のテナントを連携します。 Registration Tokenが有効でない場合はエラーを返却します。

Authorizations:

Bearer

Request Body schema: application/json

tenant_id required	string (テナントID) テナントID
access_token required	string (アクセストークン) アクセストークン
registration_token required	string (登録トークン) 登録トークン

Responses

Production API Server

https://api.saasus.io/v1/auth/aws-marketplace/link

Request samples

• Payload

Content type

application/json

{

• "tenant_id": "string",
• "access_token": "string",
• "registration_token": "string"

}

Response samples

• 500

Content type

application/json

{

• "type": "string",
• "message": "string",
• "data": {

  • "sign_in_page_url": "auth.dev.saasus.io"

  }

}

tenantUser

Tenant単位のユーザー

ユーザー一覧を取得

テナントに所属しているユーザー全件を取得します。 複数テナントに所属する同一ユーザーは別のオブジェクトとして返却されます。 idは一意ではありません。

Authorizations:

Bearer

Responses

Production API Server

https://api.saasus.io/v1/auth/tenants/all/users

Response samples

• 200
• 500

Content type

application/json

{

• "users": [

  • {

    • "id": "f94bfffc-8be2-11ec-b41a-0242ac120004",
    • "tenant_id": "69e732d6-8ecc-45c4-c2eb-8438f7ffe775",
    • "tenant_name": "saasus",
    • "email": "hoge@example.com",
    • "attributes": {

      • "address": "東京都",
      • "birthday": 19940925,
      • "sex": "男"

      },
    • "envs": [

      • {

        • "id": 1,
        • "name": "SaaSus dev",
        • "display_name": "SaaSus dev",
        • "roles": [

          • {

            • "role_name": "admin",
            • "display_name": "管理者"

            }

          ]

        }

      ]

    }

  ]

}

ユーザー情報を取得

ユーザーIDからテナントに所属しているユーザー情報を取得します。 複数テナントに所属している場合は別のオブジェクトとして返却されます。

Authorizations:

Bearer

path Parameters

user_id required

string Example: f94bfffc-8be2-11ec-b41a-0242ac120004 ユーザーID

Responses

Production API Server

https://api.saasus.io/v1/auth/tenants/all/users/{user_id}

Response samples

• 200
• 404
• 500

Content type

application/json

{

• "users": [

  • {

    • "id": "f94bfffc-8be2-11ec-b41a-0242ac120004",
    • "tenant_id": "69e732d6-8ecc-45c4-c2eb-8438f7ffe775",
    • "tenant_name": "saasus",
    • "email": "hoge@example.com",
    • "attributes": {

      • "address": "東京都",
      • "birthday": 19940925,
      • "sex": "男"

      },
    • "envs": [

      • {

        • "id": 1,
        • "name": "SaaSus dev",
        • "display_name": "SaaSus dev",
        • "roles": [

          • {

            • "role_name": "admin",
            • "display_name": "管理者"

            }

          ]

        }

      ]

    }

  ]

}

テナントのユーザー一覧を取得

テナントに所属するユーザーを全件取得します。 idは一意です。

Authorizations:

Bearer

path Parameters

tenant_id required

string (Uuid) Example: 69e732d6-8ecc-45c4-c2eb-8438f7ffe775 テナントID

Responses

Production API Server

https://api.saasus.io/v1/auth/tenants/{tenant_id}/users

Response samples

• 200
• 500

Content type

application/json

{

• "users": [

  • {

    • "id": "f94bfffc-8be2-11ec-b41a-0242ac120004",
    • "tenant_id": "69e732d6-8ecc-45c4-c2eb-8438f7ffe775",
    • "tenant_name": "saasus",
    • "email": "hoge@example.com",
    • "attributes": {

      • "address": "東京都",
      • "birthday": 19940925,
      • "sex": "男"

      },
    • "envs": [

      • {

        • "id": 1,
        • "name": "SaaSus dev",
        • "display_name": "SaaSus dev",
        • "roles": [

          • {

            • "role_name": "admin",
            • "display_name": "管理者"

            }

          ]

        }

      ]

    }

  ]

}

テナントにユーザーを作成

テナントにユーザーを作成します。 attributesを空のオブジェクトにした場合、追加属性は空で作成されます。

Authorizations:

Bearer

path Parameters

tenant_id required

string (Uuid) Example: 69e732d6-8ecc-45c4-c2eb-8438f7ffe775 テナントID

Request Body schema: application/json

email required	string メールアドレス
required	object 属性情報（SaaS 開発コンソールでユーザー属性定義を行い設定された情報を取得します）

Responses

Production API Server

https://api.saasus.io/v1/auth/tenants/{tenant_id}/users

Request samples

• Payload

Content type

application/json

{

• "email": "hoge@example.com",
• "attributes": {

  • "address": "東京都",
  • "birthday": 19940925,
  • "sex": "男"

  }

}

Response samples

• 201
• 500

Content type

application/json

{

• "id": "f94bfffc-8be2-11ec-b41a-0242ac120004",
• "tenant_id": "69e732d6-8ecc-45c4-c2eb-8438f7ffe775",
• "tenant_name": "saasus",
• "email": "hoge@example.com",
• "attributes": {

  • "address": "東京都",
  • "birthday": 19940925,
  • "sex": "男"

  },
• "envs": [

  • {

    • "id": 1,
    • "name": "SaaSus dev",
    • "display_name": "SaaSus dev",
    • "roles": [

      • {

        • "role_name": "admin",
        • "display_name": "管理者"

        }

      ]

    }

  ]

}

テナントのユーザー情報を取得

テナントのユーザーをIDから一件取得します。

Authorizations:

Bearer

path Parameters

tenant_id required	string (Uuid) Example: 69e732d6-8ecc-45c4-c2eb-8438f7ffe775 テナントID
user_id required	string Example: f94bfffc-8be2-11ec-b41a-0242ac120004 ユーザーID

Responses

Production API Server

https://api.saasus.io/v1/auth/tenants/{tenant_id}/users/{user_id}

Response samples

• 200
• 404
• 500

Content type

application/json

{

• "id": "f94bfffc-8be2-11ec-b41a-0242ac120004",
• "tenant_id": "69e732d6-8ecc-45c4-c2eb-8438f7ffe775",
• "tenant_name": "saasus",
• "email": "hoge@example.com",
• "attributes": {

  • "address": "東京都",
  • "birthday": 19940925,
  • "sex": "男"

  },
• "envs": [

  • {

    • "id": 1,
    • "name": "SaaSus dev",
    • "display_name": "SaaSus dev",
    • "roles": [

      • {

        • "role_name": "admin",
        • "display_name": "管理者"

        }

      ]

    }

  ]

}

テナントのユーザー属性情報を更新

テナントのユーザー属性情報を更新します。

Authorizations:

Bearer

path Parameters

tenant_id required	string (Uuid) Example: 69e732d6-8ecc-45c4-c2eb-8438f7ffe775 テナントID
user_id required	string Example: f94bfffc-8be2-11ec-b41a-0242ac120004 ユーザーID

Request Body schema: application/json

required	object 属性情報（SaaS 開発コンソールでユーザー属性定義を行い設定された情報を取得します）
property name* additional property any

Responses

Production API Server

https://api.saasus.io/v1/auth/tenants/{tenant_id}/users/{user_id}

Request samples

• Payload

Content type

application/json

{

• "attributes": {

  • "address": "東京都",
  • "birthday": 19940925,
  • "sex": "男"

  }

}

Response samples

• 404
• 500

Content type

application/json

{

• "type": "string",
• "message": "string",
• "data": {

  • "sign_in_page_url": "auth.dev.saasus.io"

  }

}

テナントのユーザー情報を削除

テナントからユーザーを削除します。

Authorizations:

Bearer

path Parameters

tenant_id required	string (Uuid) Example: 69e732d6-8ecc-45c4-c2eb-8438f7ffe775 テナントID
user_id required	string Example: f94bfffc-8be2-11ec-b41a-0242ac120004 ユーザーID

Responses

Production API Server

https://api.saasus.io/v1/auth/tenants/{tenant_id}/users/{user_id}

Response samples

• 404
• 500

Content type

application/json

{

• "type": "string",
• "message": "string",
• "data": {

  • "sign_in_page_url": "auth.dev.saasus.io"

  }

}

テナントのユーザー情報に役割(ロール)を作成

テナントのユーザーに役割(ロール)を作成します。

Authorizations:

Bearer

path Parameters

tenant_id required	string (Uuid) Example: 69e732d6-8ecc-45c4-c2eb-8438f7ffe775 テナントID
user_id required	string Example: f94bfffc-8be2-11ec-b41a-0242ac120004 ユーザーID
env_id required	integer (Id) Example: 1 環境ID

Request Body schema: application/json

role_names required

Array of strings 役割(ロール)情報

Responses

Production API Server

https://api.saasus.io/v1/auth/tenants/{tenant_id}/users/{user_id}/envs/{env_id}/roles

Request samples

• Payload

Content type

application/json

{

• "role_names": [

  • "admin"

  ]

}

Response samples

• 500

Content type

application/json

{

• "type": "string",
• "message": "string",
• "data": {

  • "sign_in_page_url": "auth.dev.saasus.io"

  }

}

テナントのユーザーから役割(ロール)を削除

テナントのユーザーから役割(ロール)を削除します。

Authorizations:

Bearer

path Parameters

tenant_id required	string (Uuid) Example: 69e732d6-8ecc-45c4-c2eb-8438f7ffe775 テナントID
user_id required	string Example: f94bfffc-8be2-11ec-b41a-0242ac120004 ユーザーID
env_id required	integer (Id) Example: 1 環境ID
role_name required	string Example: admin 役割(ロール)名

Responses

Production API Server

https://api.saasus.io/v1/auth/tenants/{tenant_id}/users/{user_id}/envs/{env_id}/roles/{role_name}

Response samples

• 404
• 500

Content type

application/json

{

• "type": "string",
• "message": "string",
• "data": {

  • "sign_in_page_url": "auth.dev.saasus.io"

  }

}

userAttribute

ユーザーの追加属性

ユーザー属性の一覧を取得

SaaSus Platform にて保持するユーザーの追加属性を取得します。 例えば、ユーザー名を持たせる、誕生日を持たせるなど、ユーザーに紐付いた項目の定義を行うことができます。 一方で、個人情報を SaaSus Platform 側に持たせたくない場合は、このユーザー属性定義を行わずに SaaS 側で個人情報を持つことを検討してください。

Authorizations:

Bearer

Responses

Production API Server

https://api.saasus.io/v1/auth/user-attributes

Response samples

• 200
• 500

Content type

application/json

{

• "user_attributes": [

  • {

    • "attribute_name": "birthday",
    • "display_name": "Birthday",
    • "attribute_type": "string"

    }

  ]

}

ユーザー属性の作成

SaaSus Platform にて保持するユーザーの追加属性を登録します。 例えば、ユーザー名を持たせる、誕生日を持たせるなど、ユーザーに紐付いた項目の定義を行うことができます。 一方で、個人情報を SaaSus Platform 側に持たせたくない場合は、このユーザー属性定義を行わずに SaaS 側で個人情報を持つことを検討してください。

Authorizations:

Bearer

Request Body schema: application/json

attribute_name required	string 属性名
display_name required	string 表示名
attribute_type required	string (AttributeType) Enum: "string" "number" "bool" "date" 型（dateはYYYY-MM-DDの形式で使用する事ができます。）

Responses

Production API Server

https://api.saasus.io/v1/auth/user-attributes

Request samples

• Payload

Content type

application/json

{

• "attribute_name": "birthday",
• "display_name": "Birthday",
• "attribute_type": "string"

}

Response samples

• 201
• 500

Content type

application/json

{

• "attribute_name": "birthday",
• "display_name": "Birthday",
• "attribute_type": "string"

}

ユーザー属性の削除

SaaSus Platform にて保持するユーザーの追加属性を削除します。

Authorizations:

Bearer

path Parameters

attribute_name required

string Example: birthday 属性名

Responses

Production API Server

https://api.saasus.io/v1/auth/user-attributes/{attribute_name}

Response samples

• 404
• 500

Content type

application/json

{

• "type": "string",
• "message": "string",
• "data": {

  • "sign_in_page_url": "auth.dev.saasus.io"

  }

}

tenantAttribute

テナントの追加属性

テナント属性の一覧を取得

SaaSus Platform で管理する、テナントの追加属性の定義を取得します。 例えばテナントの呼び名やメモなどをを持たせることができ、SaaSからSaaSus SDK/APIを利用して取得することができます。

Authorizations:

Bearer

Responses

Production API Server

https://api.saasus.io/v1/auth/tenant-attributes

Response samples

• 200
• 500

Content type

application/json

{

• "tenant_attributes": [

  • {

    • "attribute_name": "birthday",
    • "display_name": "Birthday",
    • "attribute_type": "string"

    }

  ]

}

テナント属性の作成

SaaSus Platform で管理する、テナントの追加属性の登録を行います。 例えばテナントの呼び名やメモなどをを持たせることができ、SaaSからSaaSus SDK/APIを利用して取得することができます。

Authorizations:

Bearer

Request Body schema: application/json

attribute_name required	string 属性名
display_name required	string 表示名
attribute_type required	string (AttributeType) Enum: "string" "number" "bool" "date" 型（dateはYYYY-MM-DDの形式で使用する事ができます。）

Responses

Production API Server

https://api.saasus.io/v1/auth/tenant-attributes

Request samples

• Payload

Content type

application/json

{

• "attribute_name": "birthday",
• "display_name": "Birthday",
• "attribute_type": "string"

}

Response samples

• 201
• 500

Content type

application/json

{

• "attribute_name": "birthday",
• "display_name": "Birthday",
• "attribute_type": "string"

}

テナント属性の削除

SaaSus Platform で管理する、テナントの追加属性の削除を行います。

Authorizations:

Bearer

path Parameters

attribute_name required

string Example: birthday 属性名

Responses

Production API Server

https://api.saasus.io/v1/auth/tenant-attributes/{attribute_name}

Response samples

• 404
• 500

Content type

application/json

{

• "type": "string",
• "message": "string",
• "data": {

  • "sign_in_page_url": "auth.dev.saasus.io"

  }

}

role

役割(ロール)

役割(ロール)一覧を取得

登録されている役割(ロール)を一覧として取得します。 ここで定義した役割をユーザーに付与することによって、SaaS側で役割ベースの認可を実装することが用意になります。 また、同じユーザーでも、属するテナント・環境ごとに持っている役割を変えることが可能です。

Authorizations:

Bearer

Responses

Production API Server

https://api.saasus.io/v1/auth/roles

Response samples

• 200
• 500

Content type

application/json

{

• "roles": [

  • {

    • "role_name": "admin",
    • "display_name": "管理者"

    }

  ]

}

役割(ロール)を作成

役割(ロール)を作成します。 ここで作成した役割をユーザーに付与することによって、SaaS側で役割ベースの認可を実装することが用意になります。 また、同じユーザーでも、属するテナント・環境ごとに持っている役割を変えることが可能です。

Authorizations:

Bearer

Request Body schema: application/json

role_name required	string 役割(ロール)名
display_name required	string 役割(ロール)表示名

Responses

Production API Server

https://api.saasus.io/v1/auth/roles

Request samples

• Payload

Content type

application/json

{

• "role_name": "admin",
• "display_name": "管理者"

}

Response samples

• 201
• 500

Content type

application/json

{

• "role_name": "admin",
• "display_name": "管理者"

}

役割(ロール)を削除

役割(ロール)を削除します。

Authorizations:

Bearer

path Parameters

role_name required

string Example: admin 役割(ロール)名

Responses

Production API Server

https://api.saasus.io/v1/auth/roles/{role_name}

Response samples

• 400
• 404
• 500

Content type

application/json

{

• "type": "string",
• "message": "string",
• "data": {

  • "sign_in_page_url": "auth.dev.saasus.io"

  }

}

tenant

テナント

テナント一覧取得

SaaSus Platform で管理する、テナント情報の取得を行います。

Authorizations:

Bearer

Responses

Production API Server

https://api.saasus.io/v1/auth/tenants

Response samples

• 200
• 500

Content type

application/json

{

• "tenants": [

  • {

    • "id": "69e732d6-8ecc-45c4-c2eb-8438f7ffe775",
    • "plan_id": "69e732d6-8ecc-45c4-c2eb-8438f7ffe775",
    • "billing_info": {

      • "name": "株式会社テストテナント",
      • "address": {

        • "street": "神宮前1-1-1",
        • "city": "渋谷区",
        • "state": "東京都",
        • "country": "JP",
        • "additional_address_info": "オフィスビル3階",
        • "postal_code": "123-4567"

        },
      • "invoice_language": "ja-JP"

      },
    • "name": "Anti-Pattern Inc.",
    • "attributes": {

      • "address": "東京都",
      • "employee_number": 100

      },
    • "back_office_staff_email": "hoge@example.com",
    • "next_plan_id": "69e732d6-8ecc-45c4-c2eb-8438f7ffe775",
    • "using_next_plan_from": 1640995200,
    • "next_plan_tax_rate_id": "69e732d6-8ecc-45c4-c2eb-8438f7ffe775",
    • "proration_behavior": "create_prorations",
    • "delete_usage": true,
    • "plan_histories": [

      • {

        • "plan_id": "69e732d6-8ecc-45c4-c2eb-8438f7ffe775",
        • "plan_applied_at": 1640995200,
        • "tax_rate_id": "69e732d6-8ecc-45c4-c2eb-8438f7ffe775",
        • "proration_behavior": "create_prorations",
        • "delete_usage": true

        }

      ]

    }

  ]

}

テナントを作成

SaaSus Platform で管理する、テナント情報を作成します。

Authorizations:

Bearer

Request Body schema: application/json

name required	string テナント名
required	object 属性情報
back_office_staff_email required	string 事務管理部門スタッフメールアドレス

Responses

Production API Server

https://api.saasus.io/v1/auth/tenants

Request samples

• Payload

Content type

application/json

{

• "name": "Anti-Pattern Inc.",
• "attributes": {

  • "address": "東京都",
  • "employee_number": 100

  },
• "back_office_staff_email": "hoge@example.com"

}

Response samples

• 201
• 500

Content type

application/json

{

• "id": "69e732d6-8ecc-45c4-c2eb-8438f7ffe775",
• "plan_id": "69e732d6-8ecc-45c4-c2eb-8438f7ffe775",
• "billing_info": {

  • "name": "株式会社テストテナント",
  • "address": {

    • "street": "神宮前1-1-1",
    • "city": "渋谷区",
    • "state": "東京都",
    • "country": "JP",
    • "additional_address_info": "オフィスビル3階",
    • "postal_code": "123-4567"

    },
  • "invoice_language": "ja-JP"

  },
• "name": "Anti-Pattern Inc.",
• "attributes": {

  • "address": "東京都",
  • "employee_number": 100

  },
• "back_office_staff_email": "hoge@example.com",
• "next_plan_id": "69e732d6-8ecc-45c4-c2eb-8438f7ffe775",
• "using_next_plan_from": 1640995200,
• "next_plan_tax_rate_id": "69e732d6-8ecc-45c4-c2eb-8438f7ffe775",
• "proration_behavior": "create_prorations",
• "delete_usage": true,
• "plan_histories": [

  • {

    • "plan_id": "69e732d6-8ecc-45c4-c2eb-8438f7ffe775",
    • "plan_applied_at": 1640995200,
    • "tax_rate_id": "69e732d6-8ecc-45c4-c2eb-8438f7ffe775",
    • "proration_behavior": "create_prorations",
    • "delete_usage": true

    }

  ]

}

テナント情報を取得

SaaSus Platform で管理する、テナントの詳細情報を取得します。

Authorizations:

Bearer

path Parameters

tenant_id required

string (Uuid) Example: 69e732d6-8ecc-45c4-c2eb-8438f7ffe775 テナントID

Responses

Production API Server

https://api.saasus.io/v1/auth/tenants/{tenant_id}

Response samples

• 200
• 404
• 500

Content type

application/json

{

• "current_plan_period_start": 1672531200,
• "current_plan_period_end": 1675209600,
• "id": "69e732d6-8ecc-45c4-c2eb-8438f7ffe775",
• "plan_id": "69e732d6-8ecc-45c4-c2eb-8438f7ffe775",
• "billing_info": {

  • "name": "株式会社テストテナント",
  • "address": {

    • "street": "神宮前1-1-1",
    • "city": "渋谷区",
    • "state": "東京都",
    • "country": "JP",
    • "additional_address_info": "オフィスビル3階",
    • "postal_code": "123-4567"

    },
  • "invoice_language": "ja-JP"

  },
• "name": "Anti-Pattern Inc.",
• "attributes": {

  • "address": "東京都",
  • "employee_number": 100

  },
• "back_office_staff_email": "hoge@example.com",
• "next_plan_id": "69e732d6-8ecc-45c4-c2eb-8438f7ffe775",
• "using_next_plan_from": 1640995200,
• "next_plan_tax_rate_id": "69e732d6-8ecc-45c4-c2eb-8438f7ffe775",
• "proration_behavior": "create_prorations",
• "delete_usage": true,
• "plan_histories": [

  • {

    • "plan_id": "69e732d6-8ecc-45c4-c2eb-8438f7ffe775",
    • "plan_applied_at": 1640995200,
    • "tax_rate_id": "69e732d6-8ecc-45c4-c2eb-8438f7ffe775",
    • "proration_behavior": "create_prorations",
    • "delete_usage": true

    }

  ]

}

テナント情報を更新

SaaSus Platform で管理する、テナントの詳細情報を更新します。

Authorizations:

Bearer

path Parameters

tenant_id required

string (Uuid) Example: 69e732d6-8ecc-45c4-c2eb-8438f7ffe775 テナントID

Request Body schema: application/json

name required	string テナント名
required	object 属性情報
back_office_staff_email required	string 事務管理部門スタッフメールアドレス

Responses

Production API Server

https://api.saasus.io/v1/auth/tenants/{tenant_id}

Request samples

• Payload

Content type

application/json

{

• "name": "Anti-Pattern Inc.",
• "attributes": {

  • "address": "東京都",
  • "employee_number": 100

  },
• "back_office_staff_email": "hoge@example.com"

}

Response samples

• 404
• 500

Content type

application/json

{

• "type": "string",
• "message": "string",
• "data": {

  • "sign_in_page_url": "auth.dev.saasus.io"

  }

}

テナント情報を削除

SaaSus Platform で管理する、テナントの詳細情報を削除します。

Authorizations:

Bearer

path Parameters

tenant_id required

string (Uuid) Example: 69e732d6-8ecc-45c4-c2eb-8438f7ffe775 テナントID

Responses

Production API Server

https://api.saasus.io/v1/auth/tenants/{tenant_id}

Response samples

• 500

Content type

application/json

{

• "type": "string",
• "message": "string",
• "data": {

  • "sign_in_page_url": "auth.dev.saasus.io"

  }

}

テナントのプラン情報を更新

SaaSus Platform で管理しているテナントのプラン情報を更新します。

Authorizations:

Bearer

path Parameters

tenant_id required

string (Uuid) Example: 69e732d6-8ecc-45c4-c2eb-8438f7ffe775 テナントID

Request Body schema: application/json

next_plan_id	string (Uuid)
using_next_plan_from	integer 次回料金プラン開始日時（stripe連携時、当月月初の0時（UTC）を指定すると当月月初開始のサブスクリプションを作成できます。ex. 2023年1月の場合は、1672531200 ）
next_plan_tax_rate_id	string (Uuid)
proration_behavior	string (プラン変更時の比例配分の挙動) Enum: "create_prorations" "none" "always_invoice" stripe連携している場合で、プラン変更時の比例配分の挙動を設定できます。 プラン変更した場合に、請求金額を日割り計算し次回請求書に反映させるか、日割り計算した請求を即時に発行する、日割り計算をしないを設定できます。
delete_usage	boolean (プラン変更時の従量課金アイテムの削除) stripe連携している場合で、プラン変更時に従量課金アイテムを削除するか設定できます。 プラン変更した場合に、現在のサブスクリプションに含まれる従量課金アイテムを全て削除して、従量課金アイテムに基づく請求の発生を止めることができます。 即時に記録している使用量がクリアされます。それらは復元できないため、delete_usageをtrueにしたプラン変更予約は取り消しできません。

Responses

Production API Server

https://api.saasus.io/v1/auth/tenants/{tenant_id}/plans

Request samples

• Payload

Content type

application/json

{

• "next_plan_id": "69e732d6-8ecc-45c4-c2eb-8438f7ffe775",
• "using_next_plan_from": 1640995200,
• "next_plan_tax_rate_id": "69e732d6-8ecc-45c4-c2eb-8438f7ffe775",
• "proration_behavior": "create_prorations",
• "delete_usage": true

}

Response samples

• 400
• 404
• 500

Content type

application/json

{

• "type": "string",
• "message": "string",
• "data": {

  • "sign_in_page_url": "auth.dev.saasus.io"

  }

}

テナントの請求先情報を更新

SaaSus Platform で管理しているテナントの請求先情報を更新します。

Authorizations:

Bearer

path Parameters

tenant_id required

string (Uuid) Example: 69e732d6-8ecc-45c4-c2eb-8438f7ffe775 テナントID

Request Body schema: application/json

name required	string 請求用のテナント名
required	object (テナントの請求先住所)
invoice_language required	string (InvoiceLanguage) Enum: "ja-JP" "en-US" 請求書の言語

Responses

Production API Server

https://api.saasus.io/v1/auth/tenants/{tenant_id}/billing-info

Request samples

• Payload

Content type

application/json

{

• "name": "株式会社テストテナント",
• "address": {

  • "street": "神宮前1-1-1",
  • "city": "渋谷区",
  • "state": "東京都",
  • "country": "JP",
  • "additional_address_info": "オフィスビル3階",
  • "postal_code": "123-4567"

  },
• "invoice_language": "ja-JP"

}

Response samples

• 400
• 404
• 500

Content type

application/json

{

• "type": "string",
• "message": "string",
• "data": {

  • "sign_in_page_url": "auth.dev.saasus.io"

  }

}

テナント毎の外部IDプロバイダ取得

テナント毎の外部IDプロバイダ経由のサインイン情報を取得します。

Authorizations:

Bearer

path Parameters

tenant_id required

string (Uuid) Example: 69e732d6-8ecc-45c4-c2eb-8438f7ffe775 テナントID

Responses

Production API Server

https://api.saasus.io/v1/auth/tenants/{tenant_id}/identity-providers

Response samples

• 200
• 500

Content type

application/json

{

• "saml": {

  • "sign_in_url": "https://example.com/sign-in/saml/1234567890123456",
  • "metadata_url": "https://example.com/saml/metadata",
  • "email_attribute": "email"

  }

}

テナント毎の外部IDプロバイダ更新

テナント毎の外部IDプロバイダ経由のサインイン情報を更新します。

Authorizations:

Bearer

path Parameters

tenant_id required

string (Uuid) Example: 69e732d6-8ecc-45c4-c2eb-8438f7ffe775 テナントID

Request Body schema: application/json

provider_type required	string (ProviderType) Value: "SAML"
	SAML外部IDプロバイダ (object) (テナント毎の外部IDプロバイダ)

Responses

Production API Server

https://api.saasus.io/v1/auth/tenants/{tenant_id}/identity-providers

Request samples

• Payload

Content type

application/json

{

• "provider_type": "SAML",
• "identity_provider_props": {

  • "metadata_url": "https://example.com/saml/metadata",
  • "email_attribute": "email"

  }

}

Response samples

• 500

Content type

application/json

{

• "type": "string",
• "message": "string",
• "data": {

  • "sign_in_page_url": "auth.dev.saasus.io"

  }

}

stripe初期設定

billing経由でstripeへ初期情報を設定

Authorizations:

Bearer

Responses

Production API Server

https://api.saasus.io/v1/auth/stripe/init

Response samples

• 500

Content type

application/json

{

• "type": "string",
• "message": "string",
• "data": {

  • "sign_in_page_url": "auth.dev.saasus.io"

  }

}

stripe上の顧客情報・商品情報の削除

stripe上の顧客情報・商品情報を削除します

Authorizations:

Bearer

Responses

Production API Server

https://api.saasus.io/v1/auth/stripe

Response samples

• 500

Content type

application/json

{

• "type": "string",
• "message": "string",
• "data": {

  • "sign_in_page_url": "auth.dev.saasus.io"

  }

}

プランに関わる情報を全削除

料金プランに関わる情報を全削除します。 テナントに連携されたプランとプラン定義を削除します。 Stripe連携している場合、連携が解除されます。

Authorizations:

Bearer

Responses

Production API Server

https://api.saasus.io/v1/auth/plans/reset

Response samples

• 500

Content type

application/json

{

• "type": "string",
• "message": "string",
• "data": {

  • "sign_in_page_url": "auth.dev.saasus.io"

  }

}

saasusTenant

SaaSusテナント

env

環境情報

環境情報一覧を取得

登録されている環境情報を取得します。 連携のテストや開発用環境や実際の運用で利用する環境など複数の環境を定義することができます。

Authorizations:

Bearer

Responses

Production API Server

https://api.saasus.io/v1/auth/envs

Response samples

• 200
• 500

Content type

application/json

{

• "envs": [

  • {

    • "id": 1,
    • "name": "saasus_dev",
    • "display_name": "SaaSus dev"

    }

  ]

}

環境情報を作成

環境情報を作成します。 連携のテストや開発用環境や実際の運用で利用する環境など複数の環境を定義することができます。

Authorizations:

Bearer

Request Body schema: application/json

id required	integer (Id)
name required	string 環境名
display_name	string 環境表示名

Responses

Production API Server

https://api.saasus.io/v1/auth/envs

Request samples

• Payload

Content type

application/json

{

• "id": 1,
• "name": "saasus_dev",
• "display_name": "SaaSus dev"

}

Response samples

• 201
• 500

Content type

application/json

{

• "id": 1,
• "name": "saasus_dev",
• "display_name": "SaaSus dev"

}

環境情報を取得

環境情報の詳細を取得します。

Authorizations:

Bearer

path Parameters

env_id required

integer (Id) Example: 1 環境ID

Responses

Production API Server

https://api.saasus.io/v1/auth/envs/{env_id}

Response samples

• 200
• 404
• 500

Content type

application/json

{

• "id": 1,
• "name": "saasus_dev",
• "display_name": "SaaSus dev"

}

環境情報を更新

環境情報を更新します。

Authorizations:

Bearer

path Parameters

env_id required

integer (Id) Example: 1 環境ID

Request Body schema: application/json

name required	string 環境名
display_name	string 環境表示名

Responses

Production API Server

https://api.saasus.io/v1/auth/envs/{env_id}

Request samples

• Payload

Content type

application/json

{

• "name": "saasus_dev",
• "display_name": "SaaSus dev"

}

Response samples

• 404
• 500

Content type

application/json

{

• "type": "string",
• "message": "string",
• "data": {

  • "sign_in_page_url": "auth.dev.saasus.io"

  }

}

環境情報を削除

環境情報を削除します。idが3の環境は削除できません。

Authorizations:

Bearer

path Parameters

env_id required

integer (Id) Example: 1 環境ID

Responses

Production API Server

https://api.saasus.io/v1/auth/envs/{env_id}

Response samples

• 404
• 500

Content type

application/json

{

• "type": "string",
• "message": "string",
• "data": {

  • "sign_in_page_url": "auth.dev.saasus.io"

  }

}

credential

認証・認可情報

認証・認可情報の取得

一時コードまたはリフレッシュトークンを利用してIDトークン・アクセストークン・リフレッシュトークンを取得する。

Authorizations:

Bearer

query Parameters

code	string (Uuid) Example: code=69e732d6-8ecc-45c4-c2eb-8438f7ffe775 一時コード
auth-flow	string Enum: "tempCodeAuth" "refreshTokenAuth" 認証フロー tempCodeAuth: 一時コードを利用した認証情報の取得 refreshTokenAuth: リフレッシュトークンを利用した認証情報の取得 指定されていない場合は tempCodeAuth になります
refresh-token	string リフレッシュトークン

Responses

Production API Server

https://api.saasus.io/v1/auth/credentials

Response samples

• 200
• 404
• 500

Content type

application/json

{

• "id_token": "string",
• "access_token": "string",
• "refresh_token": "string"

}

認証・認可情報の保存

引数のIDトークン・アクセストークン・リフレッシュトークンを一時保存し取得用の一時コードを返却する。 一時コードの有効期間は発行から10秒です。

Authorizations:

Bearer

Request Body schema: application/json

id_token required	string (IDトークン) IDトークン
access_token required	string (アクセストークン) アクセストークン
refresh_token	string (リフレッシュトークン) リフレッシュトークン

Responses

Production API Server

https://api.saasus.io/v1/auth/credentials

Request samples

• Payload

Content type

application/json

{

• "id_token": "string",
• "access_token": "string",
• "refresh_token": "string"

}

Response samples

• 201
• 400
• 401
• 500

Content type

application/json

{

• "code": "69e732d6-8ecc-45c4-c2eb-8438f7ffe775"

}

invitation

招待

テナントの招待一覧を取得

テナントへの招待一覧を取得します。

Authorizations:

Bearer

path Parameters

tenant_id required

string (Uuid) Example: 69e732d6-8ecc-45c4-c2eb-8438f7ffe775 テナントID

Responses

Production API Server

https://api.saasus.io/v1/auth/tenants/{tenant_id}/invitations

Response samples

• 200
• 500

Content type

application/json

{

• "invitations": [

  • {

    • "id": "69e732d6-8ecc-45c4-c2eb-8438f7ffe775",
    • "email": "test@example.com",
    • "invitation_url": "https://auth.dev.saasus.io/invite?id=69e732d6-8ecc-45c4-c2eb-8438f7ffe775",
    • "envs": [

      • {

        • "id": 1,
        • "name": "SaaSus dev",
        • "display_name": "SaaSus dev",
        • "roles": [

          • {

            • "role_name": "admin",
            • "display_name": "管理者"

            }

          ]

        }

      ],
    • "expired_at": 1640995200,
    • "status": "pending"

    }

  ]

}

テナントへの招待を作成

テナントへの招待を作成します。

Authorizations:

Bearer

path Parameters

tenant_id required

string (Uuid) Example: 69e732d6-8ecc-45c4-c2eb-8438f7ffe775 テナントID

Request Body schema: application/json

email required	string (メールアドレス) 招待するユーザーのメールアドレス
access_token required	string (アクセストークン) 招待を作成するユーザーのアクセストークン
required	Array of objects (招待するユーザーの環境情報)

Responses

Production API Server

https://api.saasus.io/v1/auth/tenants/{tenant_id}/invitations

Request samples

• Payload

Content type

application/json

{

• "email": "test@example.com",
• "access_token": "string",
• "envs": [

  • {

    • "id": 1,
    • "role_names": [

      • "admin"

      ]

    }

  ]

}

Response samples

• 201
• 400
• 500

Content type

application/json

{

• "id": "69e732d6-8ecc-45c4-c2eb-8438f7ffe775",
• "email": "test@example.com",
• "invitation_url": "https://auth.dev.saasus.io/invite?id=69e732d6-8ecc-45c4-c2eb-8438f7ffe775",
• "envs": [

  • {

    • "id": 1,
    • "name": "SaaSus dev",
    • "display_name": "SaaSus dev",
    • "roles": [

      • {

        • "role_name": "admin",
        • "display_name": "管理者"

        }

      ]

    }

  ],
• "expired_at": 1640995200,
• "status": "pending"

}

テナントの招待情報を取得

テナントへの招待情報を取得します。

Authorizations:

Bearer

path Parameters

tenant_id required	string (Uuid) Example: 69e732d6-8ecc-45c4-c2eb-8438f7ffe775 テナントID
invitation_id required	string (Uuid) Example: 69e732d6-8ecc-45c4-c2eb-8438f7ffe775 招待ID

Responses

Production API Server

https://api.saasus.io/v1/auth/tenants/{tenant_id}/invitations/{invitation_id}

Response samples

• 200
• 404
• 500

Content type

application/json

{

• "id": "69e732d6-8ecc-45c4-c2eb-8438f7ffe775",
• "email": "test@example.com",
• "invitation_url": "https://auth.dev.saasus.io/invite?id=69e732d6-8ecc-45c4-c2eb-8438f7ffe775",
• "envs": [

  • {

    • "id": 1,
    • "name": "SaaSus dev",
    • "display_name": "SaaSus dev",
    • "roles": [

      • {

        • "role_name": "admin",
        • "display_name": "管理者"

        }

      ]

    }

  ],
• "expired_at": 1640995200,
• "status": "pending"

}

テナントへの招待を削除

テナントへの招待を削除します。

Authorizations:

Bearer

path Parameters

tenant_id required	string (Uuid) Example: 69e732d6-8ecc-45c4-c2eb-8438f7ffe775 テナントID
invitation_id required	string (Uuid) Example: 69e732d6-8ecc-45c4-c2eb-8438f7ffe775 招待ID

Responses

Production API Server

https://api.saasus.io/v1/auth/tenants/{tenant_id}/invitations/{invitation_id}

Response samples

• 404
• 500

Content type

application/json

{

• "type": "string",
• "message": "string",
• "data": {

  • "sign_in_page_url": "auth.dev.saasus.io"

  }

}

テナントへの招待の有効性を取得

テナントへの招待の有効性を取得します。

Authorizations:

Bearer

path Parameters

invitation_id required

string (Uuid) Example: 69e732d6-8ecc-45c4-c2eb-8438f7ffe775 招待ID

Responses

Production API Server

https://api.saasus.io/v1/auth/invitations/{invitation_id}/validity

Response samples

• 200
• 404
• 500

Content type

application/json

{

• "is_valid": true

}

テナントへの招待を検証

テナントへの招待を検証します。

Authorizations:

Bearer

path Parameters

invitation_id required

string (Uuid) Example: 69e732d6-8ecc-45c4-c2eb-8438f7ffe775 招待ID

Request Body schema: application/json

access_token	string (アクセストークン) 招待されたユーザーのアクセストークン
email	string (メールアドレス) 招待されたユーザーのメールアドレス
password	string (パスワード) 招待されたユーザーのパスワード

Responses

Production API Server

https://api.saasus.io/v1/auth/invitations/{invitation_id}/validate

Request samples

• Payload

Content type

application/json

{

• "access_token": "string",
• "email": "test@example.com",
• "password": "string"

}

Response samples

• 400
• 404
• 500

Content type

application/json

{

• "type": "string",
• "message": "string",
• "data": {

  • "sign_in_page_url": "auth.dev.saasus.io"

  }

}

error

テスト用途のエラー

ステータスコード500でサーバーエラーを返却

テスト用途で使用するエンドポイントです。ステータスコード500でサーバーエラーを返却します。

Authorizations:

Bearer

Responses

Production API Server

https://api.saasus.io/v1/auth/errors/internal-server-error

Response samples

• 500

Content type

application/json

{

• "type": "string",
• "message": "string",
• "data": {

  • "sign_in_page_url": "auth.dev.saasus.io"

  }

}

userInfo

ユーザー情報取得

SaaS利用ユーザ(登録ユーザ)のIDトークンを元に、ユーザ情報を取得します。 IDトークンは、SaaSus Platform生成のログイン画面からログイン時にCallback URLに渡されます。 サーバ側でそのURLからIDトークンを取得し、このAPIを呼ぶことにより、該当ユーザの情報が取得できます。 取得した上には、所属テナントや役割(ロール)、料金プランなどが含まれているため、それを元に認可の実装を行うことが可能です。

Authorizations:

Bearer

query Parameters

token required

string IDトークン

Responses

Production API Server

https://api.saasus.io/v1/auth/userinfo

Response samples

• 200
• 401
• 500

Content type

application/json

{

• "id": "69e732d6-8ecc-45c4-c2eb-8438f7ffe775",
• "email": "hoge@example.com",
• "tenants": [

  • {

    • "id": "69e732d6-8ecc-45c4-c2eb-8438f7ffe775",
    • "name": "Anti-Pattern Inc.",
    • "completed_sign_up": true,
    • "envs": [

      • {

        • "id": 1,
        • "name": "SaaSus dev",
        • "display_name": "SaaSus dev",
        • "roles": [

          • {

            • "role_name": "admin",
            • "display_name": "管理者"

            }

          ]

        }

      ],
    • "user_attribute": {

      • "address": "東京都",
      • "employee_number": 100

      },
    • "back_office_staff_email": "hoge@example.com",
    • "plan_id": "69e732d6-8ecc-45c4-c2eb-8438f7ffe775",
    • "is_paid": true

    }

  ]

}