Change User Information#

指定したテナントの指定ユーザー情報(ユーザー名、所属グループ)を変更します。

📒注: rootユーザーの情報は変更できません。

APIエンドポイント#

リージョン APIエンドポイント
西日本リージョン3の場合 https://objectstorage-s.jp-west-3.cloud.global.fujitsu.com
東日本リージョン3の場合 https://objectstorage-s.jp-east-3.cloud.global.fujitsu.com

HTTPメソッドとURI#

PATCH

/v2/admin/{tenantID}/users/{userID}

HTTPステータスコード#

正常時:200

エラー時:400, 403, 404, 405, 409, 411, 412, 416, 422, 500, 501, 503

リクエストパラメータの説明#

名前 In Type デフォルト値
/必須指定
Description
tenantID path string 必須 テナント識別子
userID path string 必須 ユーザー識別子
X-Auth-Token header string 必須 認証のトークン
fullName body string 必須(どちらか一方または両方を指定してください) 変更後のユーザー名
- 指定しない場合、ユーザー名は変更されません。
- 指定した場合、fullNameのみ変更されます(レスポンスボディ部参照)。
制限値は以下です。
長さ:128Byte以下
使用可能な文字種:
- 半角英数字
- .(ドット)
- @(アットマーク)
- -(ハイフン)
- _(アンダースコア)
memberOf body array ユーザーを所属させるグループID(複数指定可)
📒注: リクエストボディはJSON形式で指定してください。

レスポンスヘッダーの説明#

名前 Type Description
Date string トランザクションが実行された日時
Content-Type string MIME仕様で定義されているコンテントの形式
Content-Length string レスポンスボディのバイト数
X-Fcx-Endpoint-Request string このリクエストに付与されるID
トラブルについて問い合わせる際に利用されます。

レスポンスボディ(正常系)の説明#

名前 Type Description
apiVersion string APIの内部のバージョン番号
data object accountIdからuserURNまでを含むユーザーデータの情報
accountId string テナント識別子
fullName string ユーザー名(表示用)
id string ユーザー識別子
オブジェクトストレージ内で一意の識別子です。この識別子を利用してユーザーの操作を実施します。
memberOf array ユーザを所属させるグループID(複数指定可)
uniqueName string ユーザー名
userURN string テナント識別子+ユーザー名
例:urn:sgws:identity::accountId:user/ユーザ名
responseTime string 応答が生成された日時
status object 要求の結果
「success」または「error」が表示されます。

リクエスト例#

リクエストヘッダー

PATCH /v2/admin/46799197538990820493/users/1f067f79-cf97-4f74-9a90-aa492485b8b6 HTTP/1.1
User-Agent: curl/7.29.0
Host: objectstorage-s.jp-east-3.cloud.global.fujitsu.com
Accept: */*
X-Auth-Token:gAAAAABc73ty3DLIUBv1xMh5bdHfkb4Ps6CTLEPD8LWb-N3148aveeZNZ_gtKZL7w-viwibYNo1J1D8MFF93RQ4cPd4tJAEMZAnXwF5i57COalRq7py-ugiZTFVKLKHX6A9ta9huSPtSFFugSybu8zGoWgYLC90-SkJQUr8bn-bCik1_YWlyfOA
Content-Length: 80
Content-Type: application/x-www-form-urlencoded

リクエストボディ

{
  "fullName": "testuser4-01",
  "memberOf": [
    "25aefd91-1d71-4e34-a3f8-55b54639cc2f"
  ]
}

レスポンス例#

レスポンスヘッダー

HTTP/1.1 200 OK
Date: Thu, 30 May 2019 06:43:00 GMT
Content-Type: application/json
Content-Length: 346
Connection: keep-alive
Api-Version: 2
Cache-Control: private, no-cache, max-age=0
Content-Security-Policy: frame-ancestors 'self'; block-all-mixed-content
Expires: Thu, 30 May 2019 06:42:59 GMT
Strict-Transport-Security: max-age=31536000; includeSubDomains
Vary: Api-Version
X-Content-Security-Policy: frame-ancestors: 'self'; block-all-mixed-content
X-Content-Type-Options: nosniff
X-Frame-Options: SAMEORIGIN
X-Fcx-Endpoint-Request: EXECUTED_api3-rmp2.management.jp-east-3.local-28852-127234-1_200

レスポンスボディ

{
    "apiVersion": "2.2",
    "data": {
        "accountId": "46799197538990820493",
        "fullName": "testuser4-01",
        "id": "1f067f79-cf97-4f74-9a90-aa492485b8b6",
        "memberOf": [
            "25aefd91-1d71-4e34-a3f8-55b54639cc2f"
        ],
        "uniqueName": "user/testuser04",
        "userURN": "urn:sgws:identity::46799197538990820493:user/testuser04"
    },
    "responseTime": "2019-05-30T06:43:00.297Z",
    "status": "success"
}