メインコンテンツまでスキップ

GetUserCodeSettings

指定したワークスペースのユーザーコード設定を取得する

Description​

  • 指定したワークスペースに設定されたユーザーコード設定を取得します。
  • ワークスペースにアクセスできないユーザは利用できません（403:Forbidden）
  • ユーザーコード設定については、開発ガイドのユーザーとグループを参照ください。
  • ユーザーコード設定は、管理画面の「ワークスペースの設定」>「ユーザーコード設定」で指定できます。

Method​

GET

Request URL Format​

/api/v0/workspaces/:workspace-id/usercode-settings

URL Params​

workspace-id　取得したいワークスペースIDを指定

Query Params​

なし

Request URL Sample​

GET https://api.xxx.com/api/v0/workspaces/58ca3597cce5fe3ea0a42fa8/usercode-settings

Response Sample​

{
    "min_length": 6, // ユーザーコードの最小文字数
    "max_length": 10, // ユーザーコードの最小文字数
    "pattern_check_type": 2, // ユーザーコードの複雑性チェックの利用可否
    "use_min_length": false, // ユーザーコード最小文字数の利用可否
    "use_max_length": false, // ユーザーコード最小文字数の利用可否
    "use_pattern_check": false // ユーザーコードの複雑性チェックの利用可否
}

ユーザーコードチェックパターン​

- 0: "ユーザーコードにスペースを使用できません"
- 1: "英・数字両方を含める必要があります"
- 2: "英・数字、および特殊文字（!#$%-_=+<>のいずれか）を含める必要があります"
- 3: "英・数字、または記号のいずれかを含む"

Errors​

  • ログインユーザーが、指定したワークスペースを利用できない場合は403エラーとなります