アカウントの更新（PATCH）

組織に所属する指定した管理対象アカウントを更新します。

メソッド

PATCH

URL

/Users/:id

例）/Users/6BV58gRox664F5QKPC9oUWHB23BtJqWVoSmTCzzjpCiKcoCYu

URL パラメーター

名前	型	説明
id	文字列	アカウントのID ※アカウントを一意に識別する文字列（ヌーラボプロダクトの画面上には表示されないアカウント一覧の取得のレスポンスに含まれる Resources.id のこと）

リクエスト例

リクエストボディ

{
    "schemas": [
        "urn:ietf:params:scim:api:messages:2.0:PatchOp"
    ],
    "Operations": [
            {
                "op": "Replace",
                "path": "userName",
                "value": "example@nulab.com"
            },
            {
                "op": "Replace",
                "path": "displayName",
                "value": "Example Nulab"
            },
            {
                "op": "Replace",
                "path": "preferredLanguage",
                "value": "en"
            },
            {
                "op": "Replace",
                "path": "locale",
                "value": "en"
            },
            {
                "op": "Replace",
                "path": "timezone",
                "value": "Asia/Tokyo"
            },
            {
                "op": "Replace",
                "path": "active",
                "value": false
            },
            {
                "op": "Replace",
                "path": "roles",
                "value": [{ "value" : "ADMIN" }]
            }
   ]
}

リクエスト説明

名前	型	内容
schemas（必須）	文字列	「urn:ietf:params:scim:api:messages:2.0:PatchOp」固定
Operations
op（必須）	文字列	「Replace」固定
path（必須）	文字列	変更する属性名
value（必須）	文字列	値

path に指定する属性

名前	型	内容
userName	文字列	認証済みドメインのメールアドレス ※アカウントを一意に識別するもの
displayName	文字列	ユーザー名
preferredLanguage	文字列	言語
locale	文字列	言語（preferredLanguage が優先される）
timezone	文字列	タイムゾーン
active	真偽値	アカウントのアクティブ/停止中 true: アクティブ false: 停止中
roles	文字列	例）[{ “value” : “ADMIN” }] ADMIN: 管理者 USER: 一般ユーザー GUEST: ゲスト ※複数指定した場合、primary が true のロールの値が登録されます

※上記以外の値は更新時に無視されます。

レスポンス例

ステータスライン / レスポンスヘッダ

HTTP/1.1	200 OK
Content-Type: application/scim+json;charset=UTF-8

レスポンスボディ

{
    "schemas": [
        "urn:ietf:params:scim:schemas:core:2.0:User"
    ],
    "id": "6BV58gRox664F5QKPC9oUWHB23BtJqWVoSmTCzzjpCiKcoCYu",
    "meta": {
        "resourceType": "User",
        "created": "2024-03-22T04:42:01Z",
        "lastModified": "2024-03-22T05:58:30Z",
        "location": "https://api.apps.nulab.com/spaces/aeDWiLzQw/scim/v2/Users/6BV58gRox664F5QKPC9oUWHB23BtJqWVoSmTCzzjpCiKcoCYu"
    },
    "userName": "example@nulab.com",
    "displayName": "Example Nulab",
    "preferredLanguage": "en",
    "locale": "en",
    "timezone": "Asia/Tokyo",
    "active": false,
    "roles": [
        {
            "value": "ADMIN",
            "primary": true
        }
    ]
}

レスポンス説明

名前	型	内容
id	文字列	アカウントのID ※アカウントを一意に識別する文字列
userName	文字列	メールアドレス ※アカウントを一意に識別するもの
displayName	文字列	ユーザー名
preferredLanguage	文字列	言語（locale と同じ値）
locale	文字列	言語（preferredLanguage と同じ値）
timezone	文字列	タイムゾーン
active	真偽値	アカウントのアクティブ/停止中 true: アクティブ false: 停止中
roles.[0].value	文字列	ADMIN: 管理者 USER: 一般ユーザー GUEST: ゲスト