利用者管理API#

リクエストヘッダ情報#

各APIの共通ヘッダー

項番 ヘッダー名 必須 ヘッダー値
1 Token ○ アクセストークン取得APIで取得したトークン
2 Content-Type ○ application/json

エラー情報#

API実行エラーの際、エラー情報はレスポンスのボディーに返却されます。

項番 項目名 型 多重度 説明
1 errorLevel string 1..1 エラーレベル
2 framework object 1..1 フレームワークオブジェクト
3 ┗systemErrorCode string 1..1 システムエラーコード
4 business object 1..1 業務オブジェクト
5 ┗businessErrorInfo string 1..1 業務エラー情報
6 ┣responseErrorCode string 1..1 応答エラーコード
7 ┗embeddedString string array 1..1 エラーメッセージ 
{
  "errorLevel": "888",
  "framework": {
    "systemErrorCode": ""
  },
  "business": {
    "businessErrorInfo": "BECSA000113",
    "responseErrorCode": "RCS100001",
    "embeddedString": [
      "Internal Server Error"
    ]
  }
}

返却されるエラー情報

項番 HTTP ステータス エラー内容 エラーメッセージ エラーの原因
1 400 入力パラメータエラー ※XXXはエラーとなったパラメータ名。 ・Parameter is insufficient. Required parameter: XXX
・Parameter is required.		 入力パラメータ不足
Character count of parameter is invalid. Specified parameter: XXX 入力パラメータチェックエラー（桁数不備）
The format of parameter is invalid. Specified parameter: XXX 入力パラメータ形式エラー（桁数以外のエラー）
2 400 契約者削除不可 Could not delete user because the target user is a contractor. 削除対象ユーザーが契約者の場合
3 400 パスワードチェックエラー Password is of invalid format or does not satisfy password policy. Please try again. パスワードポリシー違反
Password can not be changed again within 24 hours since the last change. Please try again after 24 hours. ・24時間以内にパスワード連続変更
Failed to change password. The old password was invalid. 変更前のパスワードチェックエラー
4 400 ユーザー状態不正 Cannot change user information because user status of the target user is invalid. 更新対象ユーザーのユーザー状態が無効のため更新不可
5 401 無効トークン The specified access token is not valid. 指定されたアクセストークンが無効
6 403 権限なし Authorization Error. 権限チェックエラー
7 403 更新ユーザー不正 Unauthorized to change information of the specified user. 契約者のユーザー状態を変更しようとした場合
8 404 対象なし The target information does not exist. 操作しようとした情報がみつからない場合
9 409 排他エラー Operation conflicts with another one. 操作しようとした情報は別のプロセスによって処理された場合
10 500 業務不整合 Internal Server Error. 整合性チェックエラー、またはその他のサーバー側のエラー

API詳細#

ユーザーの追加を行う#

  1. リクエスト

    パラメータ定義

    項番 項目名(英) 項目名(和) 必須 多重度 最小桁数 最大桁数 設定値の 条件 説明
    1 login_id ユーザー名 ○ 1..1 4 246 半角文字列 追加対象ユーザーのユーザー名
    2 user_description ユーザー説明 × 0..1 1 255 半角・全角文字列 追加対象ユーザーのユーザー説明
    3 mailaddress メールアドレス ○ 1..1 1 256 メールアドレスの形式であること 追加対象ユーザーのメールアドレス
    4 user_status ユーザー状態 ○ 1..1 1 1 無効（0）/有効（1） 追加対象ユーザーのユーザー状態
    5 password パスワード ○ 1..1 16 64 半角文字列 追加対象ユーザーのパスワード
    6 language_code 言語コード ○ 1..1 2 2 日本語（ja）、英語（en） 追加対象ユーザーの言語コード
    7 role_code ロールコード ○ 1..1 2 2 管理者(00)、開発者(01) 追加対象ユーザーのロールコード
    8 user_last_name 氏名（姓） ○ 1..1 1 64 半角・全角文字列 追加対象ユーザーの氏名（姓）
    9 user_first_name 氏名（名） ○ 1..1 1 64 半角・全角文字列 追加対象ユーザーの氏名（名） 
    {
  "login_id": "fujitsu123",
  "user_description": "ユーザー説明です。",
  "mailaddress": "abc@xyz.com",
  "user_status": "1",
  "password": "Abcdefgh12345678",
  "language_code": "ja",
  "role_code": "00",
  "user_last_name": "富士通",
  "user_first_name": "太郎"
}

    $ LOGIN_ID=<ユーザー名　（必須）>
$ USER_DESCRIPTION=<ユーザー説明　（任意）>
$ MAILADDRESS=<メールアドレス　（必須）>
$ USER_STATUS=<ユーザー状態　（必須）>
$ PASSWORD=<パスワード　（必須）>
$ LANGUAGE_CODE=<言語コード　（必須）>
$ ROLE_CODE=<ロールコード　（必須）>
$ USER_LAST_NAME=<氏名（姓）　（必須）>
$ USER_FIRST_NAME=<氏名（名）　（必須）>

$ curl -si -X POST https://k5-apiportal.paas.cloud.global.fujitsu.com/API/v1/api/users -H "Content-Type:application/json" -H "Token:<Token値>" -d '{ "login_id": "'$LOGIN_ID'", "user_description": "'$USER_DESCRIPTION'", "mailaddress": "'$MAILADDRESS'", "user_status": "'$USER_STATUS'", "password": "'$PASSWORD'", "language_code": "'$LANGUAGE_CODE'", "role_code": "'$ROLE_CODE'", "user_last_name": "'$USER_LAST_NAME'", "user_first_name": "'$USER_FIRST_NAME'"}'

  2. レスポンス

    APIが正常に実行された時以下のレスポンスが返却されます。

    HTTPステータス：200

    ボディー部：

    項番 項目名（英） 項目名（和） 多重度 説明
    1 login_id ユーザー名 1..1 追加したユーザーのユーザー名
    2 user_description ユーザー説明 1..1 追加したユーザーのユーザー説明
    3 mailaddress メールアドレス 1..1 追加したユーザーのメールアドレス
    4 user_status ユーザー状態 1..1 追加したユーザーのユーザー状態。 無効（0）/有効（1）
    5 language_code 言語コード 1..1 追加したユーザーの言語コード 日本語（ja）、英語（en）
    6 authentication_method 認証方式 1..1 追加したユーザーの認証方式 　※当ＡＰＩはパスワード認証（0）固定で返却します
    7 user_last_name 氏名（姓） 1..1 追加したユーザーの氏名（姓）
    8 user_first_name 氏名（名） 1..1 追加したユーザーの氏名（名）

    コンソールに以下のような結果が表示されます。

    {
  "login_id": "fujitsu123",
  "user_description": "ユーザー説明です。",
  "mailaddress": "abc@xyz.com",
  "user_status": "1",
  "language_code": "ja",
  "authentication_method ": "0",
  "user_last_name": "富士通",
  "user_first_name": "太郎"
}

    {
  "login_id": "<ユーザー名>",
  "user_description": "<ユーザー説明>",
  "mailaddress": "<メールアドレス>",
  "user_status": "<ユーザー状態>",
  "language_code": "<言語コード>",
  "authentication_method ": "<認証方式>",
  "user_last_name": "<氏名（姓）>",
  "user_first_name": "<氏名（名）>"
}

※追加したユーザーが全リージョンに反映されるまで最大10分程度要します。

ユーザーの変更を行う#

  1. リクエスト

    パラメータ定義

    項番 項目名(英) 項目名(和) 必須 多重度 最小桁数 最大桁数 設定値の 条件 説明
    1 login_id ユーザー名 ○ 1..1 4 246 半角文字列 変更対象ユーザーのユーザー名
    2 mailaddress メールアドレス ×　※1 0..1 1 256 メールアドレスの形式であること 変更対象ユーザーの新メールアドレス
    3 user_description ユーザー説明 ×　※1 0..1 1 255 半角・全角文字列 変更対象ユーザーの新ユーザー説明
    4 language_code 言語コード ×　※1 0..1 2 2 日本語（ja）、英語（en） 変更対象ユーザーの新言語コード
    5 user_status ユーザー状態 ×　※1 0..1 1 1 無効（0）/有効（1）　　 ※変更対象ユーザーが契約者の場合ユーザー状態の変更が不可 変更対象ユーザーの新ユーザー状態
    6 password パスワード ×　※1 0..1 16 64 半角文字列 変更対象ユーザーの新パスワード
    7 user_last_name 氏名（姓） ×　※1 0..1 1 64 半角・全角文字列 変更対象ユーザーの氏名（姓）
    8 user_first_name 氏名（名） ×　※1 0..1 1 64 半角・全角文字列 変更対象ユーザーの氏名（名）

    ※1：いずれか１つ以上のパラメータを指定しない場合エラーとなります。

    {
  "login_id": "fujitsu123",
  "mailaddress": "abc@xyz.com",
  "user_description": "ユーザー説明です。",
  "language_code": "ja",
  "user_status": "1",
  "password": "Abcdefgh12345678",
  "user_last_name": "富士通",
  "user_first_name": "太郎"
}

    $ LOGIN_ID=<ユーザー名　（必須）>
$ MAILADDRESS=<メールアドレス　（任意 ※1）>
$ USER_DESCRIPTION=<ユーザー説明　（任意 ※1）>
$ LANGUAGE_CODE=<言語コード　（任意 ※1）>
$ USER_STATUS=<ユーザー状態　（任意 ※1）>
$ PASSWORD=<パスワード　（任意 ※1）>
$ USER_LAST_NAME=<氏名（姓）　（任意 ※1）>
$ USER_FIRST_NAME=<氏名（名）　（任意 ※1）>
# ※1：いずれか1つ以上指定しない場合エラーとなります。

$ curl -si -X PUT https://k5-apiportal.paas.cloud.global.fujitsu.com/API/v1/api/users -H "Content-Type:application/json" -H "Token:<Token値>" -d '{ "login_id": "'$LOGIN_ID'", "mailaddress": "'$MAILADDRESS'", "user_description": "'$USER_DESCRIPTION'", "language_code": "'$LANGUAGE_CODE'",  "user_status": "'$USER_STATUS'", "password": "'$PASSWORD'", "user_last_name": "'$USER_LAST_NAME'", "user_first_name": "'$USER_FIRST_NAME'"}'

  2. レスポンス

    APIが正常に実行された時以下のレスポンスが返却されます。

    HTTPステータス：200

    ボディー部：

    項番 項目名（英） 項目名（和） 多重度 説明
    1 login_id ユーザー名 1..1 変更対象ユーザーのユーザー名
    2 language_code 言語コード 1..1 変更対象ユーザーの新言語コード
    3 user_status ユーザー状態 1..1 変更対象ユーザーの新ユーザー状態
    4 mailaddress メールアドレス 1..1 変更対象ユーザーの新メールアドレス
    5 user_description ユーザー説明 1..1 変更対象ユーザーの新ユーザー説明
    6 user_last_name 氏名（姓） 1..1 変更対象ユーザーの氏名（姓）
    7 user_first_name 氏名（名） 1..1 変更対象ユーザーの氏名（名）
    8 accesstoken_destruction_information_list アクセストークン 破棄情報リスト 1.1 アクセストークン破棄対象のユーザーの情報リスト
    9 ┣customer_group_id カスタマグループID 1.1 トークンが破棄されたユーザーが属するグループのID
    10 ┗login_id ユーザー名 1.1 トークンが破棄されたユーザーのログインID

    コンソールに以下のような結果が表示されます。

    {
  "login_id": "fujitsu123",
  "language_code": "ja",
  "user_status": "1",
  "mailaddress": "abc@xyz.com",
  "user_description": "ユーザー説明です。",
  "user_last_name": "富士通",
  "user_first_name": "太郎",
  "accesstoken_destruction_information_list": [
    {
      "customer_group_id": "HvlgXxym",
      "login_id": " fujitsu123"
    }
  ]
}

    {
  "login_id": "<ユーザー名>",
  "language_code": "<言語コード>",
  "user_status": "<ユーザー状態>",
  "mailaddress": "<メールアドレス>",
  "user_description": "<ユーザー説明>",
  "user_last_name": "<氏名（姓）>",
  "user_first_name": [
    {
      "customer_group_id": "<契約番号>",
      "login_id": "<ユーザー名>"
    }
  ]
}

※変更したユーザー情報が全リージョンに反映されるまで最大10分程度要します。

ユーザーのパスワード変更を行う#

  1. リクエスト

    パラメータ定義

    項番 項目名(英) 項目名(和) 必須 多重度 最小桁数 最大桁数 設定値の 条件 説明
    1 login_id ユーザー名 ○ 1..1 4 246 半角文字列 パスワード変更対象ユーザーのユーザー名
    2 after_password 変更後パスワード ○ 1..1 16 64 半角文字列 新パスワード
    3 before_password 変更前パスワード ○ 1..1 16 64 半角文字列 旧パスワード 
    {
  "login_id": "fujitsu123",
  "after_password": "Newpassword12345678",
  "before_password": "Abcdefgh12345678"
}

    $ LOGIN_ID=<ユーザー名　（必須）>
$ AFTER_PASSWORD=<新パスワード　（必須）>
$ BEFORE_PASSWORD=<旧パスワード　（必須）>

$ curl -si -X PUT https://k5-apiportal.paas.cloud.global.fujitsu.com/API/v1/api/userspassword -H "Content-Type:application/json" -H "Token:<Token値>" -d '{ "login_id": "'$LOGIN_ID'", "after_password": "'$AFTER_PASSWORD'", "before_password": "'$BEFORE_PASSWORD'"}'

  2. レスポンス

    APIが正常に実行された時以下のレスポンスが返却されます。

    HTTPステータス：200

    ボディー部：

    項番 項目名（英） 項目名（和） 多重度 説明
    1 accesstoken_destruction_information_list アクセストークン 破棄情報リスト 1.1 アクセストークン破棄対象のユーザーの情報リスト
    2 ┣customer_group_id カスタマグループID 1.1 トークンが破棄されたユーザーが属するグループのID
    3 ┗login_id ユーザー名 1.1 トークンが破棄されたユーザーのログインID

    コンソールには以下のような結果が表示されます。

    {
  "accesstoken_destruction_information_list": [
    {
      "customer_group_id": "HvlgXxym",
      "login_id": "AUTH001a"
    }
  ]
}

    {
  "accesstoken_destruction_information_list": [
    {
      "customer_group_id": "<契約番号>",
      "login_id": "<ユーザー名>"
    }
  ]
}

    ※ユーザーアカウントのパスワードを更新すると、更新前に取得していたトークンが無効化されます。ユーザーパスワード変更後は改めてトークンを取得してください。

    ※更新したユーザーアカウントのパスワードが全リージョンに反映されるまで最大10分程度要します。

    Note

    HTTP ステータス500：Internal Server Error.が応答された場合は、本APIのリトライをお願いします。

ユーザーの削除を行う#

  1. リクエスト

    パラメータ定義

    項番 項目名(英) 項目名(和) 必須 多重度 最小桁数 最大桁数 設定値の 条件 説明
    1 login_id ユーザー名 ○ 1..1 4 246 半角文字列 削除対象ユーザーのユーザー名 
    /API/v1/api/users/?login_id=fujitsu123

    $ LOGIN_ID=<ユーザー名　（必須）>

$ curl -si -X DELETE https://k5-apiportal.paas.cloud.global.fujitsu.com/API/v1/api/users/?login_id=$LOGIN_ID -H "Content-Type:application/json" -H "Token:<Token値>"

  2. レスポンス

    APIが正常に実行された時以下のレスポンスが返却されます。

    HTTPステータス：200

    ボディー部：

    項番 項目名（英） 項目名（和） 多重度 説明
    1 accesstoken_destruction_information_list アクセストークン 破棄情報リスト 1.1 アクセストークン破棄対象のユーザーの情報リスト
    2 ┣customer_group_id カスタマグループID 1.1 トークンが破棄されたユーザーが属するグループのID
    3 ┗login_id ユーザー名 1.1 トークンが破棄されたユーザーのログインID

    コンソールには以下のような結果が表示されます。

    {
  "accesstoken_destruction_information_list": [
    {
      "customer_group_id": "HvlgXxym",
      "login_id": " fujitsu123"
    }
  ]
}

    {
  "accesstoken_destruction_information_list": [
    {
      "customer_group_id": "<契約番号>",
      "login_id": "<ユーザー名>"
    }
  ]
}

※ユーザーの削除が全リージョンに反映されるまで最大10分程度要します。

ユーザー認証方式の情報を更新する#

  1. リクエスト

    パラメータ定義

    項番 項目名(英) 項目名(和) 必須 多重度 最小桁数 最大桁数 設定値の 条件 説明
    1 login_id ユーザー名 ○ 1..1 4 246 半角文字列 対象のユーザー名
    2 authentication_method 認証方式 ○ 1..1 1 1 半角数値 対象ユーザーの認証方式 0:パスワード認証 1:証明書＋パスワード認証 2:ワンタイムパスワード＋パスワード認証 
    {
  "login_id": "fujitsu123",
  "authentication_method ": "1"
}

    $ LOGIN_ID=<ユーザー名　（必須）>
$ AUTHENTICATION_METHOD=<認証方式※（必須） >

$ curl -si -X PUT https://k5-apiportal.paas.cloud.global.fujitsu.com/API/v1/api/usersauthenticationmethod -H "Content-Type:application/json" -H "Token:<Token値>" -d '{ "login_id": "'$LOGIN_ID'", " authentication_method ": "'$ AUTHENTICATION_METHOD '"}'

  2. レスポンス

    APIが正常に実行された時以下のレスポンスが返却されます。

    HTTPステータス：200

    ボディー部：

    項番 項目名（英） 項目名（和） 多重度 説明
    1 authentication_method 認証方式 1..1 対象ユーザーの認証方式 0:パスワード認証 1:証明書＋パスワード認証 2:ワンタイムパスワード＋パスワード認証
    2 accesstoken_destruction_information_list アクセストークン 破棄情報リスト 1..1 アクセストークン破棄対象のユーザーの情報リスト
    3 ┣customer_group_id カスタマグループID 1..1 トークンが破棄されたユーザーが属するグループのID
    4 ┗login_id ユーザー名 1..1 トークンが破棄されたユーザーのログインID

    コンソールに以下のような結果が表示されます。

    {
  "authentication_method": "1",
  "accesstoken_destruction_information_list": [
    {
      "customer_group_id": "HvlgXxym",
      "login_id": " fujitsu123"
    }
  ]
}

    {
  "accesstoken_destruction_information_list": [
    {
      "customer_group_id": "<契約番号>",
      "login_id": "<ユーザー名>"
    }
  ]
}

※更新した情報が全リージョンに反映されるまで最大10分程度要します。