ダッシュボードのユーザーアカウントを更新する

put

/scim/v2/Users/{id}

このエンドポイントを使用して、SCIM POST メソッドによって返されるリソース id を指定して、既存のダッシュボードユーザーアカウントを更新します。

これにより、姓名、権限 (会社、ワークスペース、チームレベルでの権限設定)、および部門を更新できます。

セキュリティ上の理由から、userName （電子メールアドレス）はこのエンドポイントを通じて更新できない。ユーザーのuserName （電子メールアドレス）を変更したい場合は、サポートに連絡する。

See me in Postman

前提条件

このエンドポイントを使うには、SCIMトークンが必要だ。X-Request-Origin ヘッダーとしてサービス Origin を使用します。詳細については、「自動ユーザープロビジョニング」を参照してください。

レート制限

このエンドポイントには、1日あたり1社あたり5000リクエストのレート制限があります。このレート制限は、API レート制限に記載されているように、/scim/v2/Users/ GET、DELETE、および POST エンドポイントと共有されます。

パスパラメーター

パラメータ	required	データ型	説明
`id`	必須	文字列	ユーザーのリソースID。このパラメータは、`POST` `/scim/v2/Users/` または`GET` `/scim/v2/Users?filter=userName eq "user@test.com"` メソッドによって返される。

要求本文:

1
2
3
Content-Type: application/json
X-Request-Origin: YOUR-REQUEST-ORIGIN-HERE
Authorization: Bearer YOUR-SCIM-TOKEN-KEY

{
    "schemas": ["urn:ietf:params:scim:schemas:core:2.0:User"],
    "name": {"name": {
        "givenName": "Test",
        "familyName": "User"
    },
    "department": "finance",
    "permissions": {
        "companyPermissions": ["manage_company_settings"],
        "roles": [
            {
                "roleName": "Test Role"
            },
            {
                "roleId": "2519dafcdba238ae7"
            }
        ],
        "appGroup": [
            {
                "appGroupName": "Test Workspace",
                "appGroupPermissions": ["basic_access","send_campaigns_canvases"],
                "team": [
                    {
                         "teamName": "Test Team",
                         "teamPermissions": ["admin"]
                    } 
                ]
            },
            {
                "appGroupName": "Other Test Workspace",
                "appGroupPermissionSets": [
                    {
                        "appGroupPermissionSetName":  "Test Permission Set"
                    }
                ]
            } 
        ]
   }
}

リクエストパラメーター

パラメーター	必須	データタイプ	説明
`schemas`	必須	文字列の配列	ユーザーオブジェクトに期待される SCIM 2.0 スキーマ名。
`name`	必須	JSONオブジェクト	このオブジェクトには、ユーザーの姓と名が含まれます。
`department`	必須	文字列	部門文字列のドキュメントにある有効な部門文字列。
`permissions`	必須	JSONオブジェクト	権限オブジェクトのドキュメントで説明されている権限オブジェクト。

例のリクエスト

curl --location --request PUT 'https://rest.iad-01.braze.com/scim/v2/Users/dfa245b7-24195aec-887bb3ad-602b3340' \
--header 'Content-Type: application/json' \
--header 'X-Request-Origin: YOUR-REQUEST-ORIGIN-HERE' \
--header 'Authorization: Bearer YOUR-SCIM-TOKEN-HERE' \
--data raw '{
    "schemas": ["urn:ietf:params:scim:schemas:core:2.0:User"],
    "name": {
        "givenName": "Test",
        "familyName": "User"
    },
    "department": "finance",
    "permissions": {
        "companyPermissions": ["manage_company_settings"],
        "roles": [
            {
                "roleName": "Test Role"
            },
            {
                "roleId": "2519dafcdba238ae7"
            }
        ],
        "appGroup": [
            {
                "appGroupName": "Test Workspace",
                "appGroupPermissions": ["basic_access","send_campaign_canvases"],
                "team": [
                    {
                         "teamName": "Test Team",                  
                         "teamPermissions": ["admin"]
                    }
                ]
            } 
        ]
    }
}

応答

{
    "schemas": ["urn:ietf:params:scim:schemas:core:2.0:User"],
    "id": "dfa245b7-24195aec-887bb3ad-602b3340",
    "userName": "user@test.com",
    "name": {
        "givenName": "Test",
        "familyName": "User"
    },
    "department": "finance",
    "lastSignInAt": "Thursday, January 1, 1970 12:00:00 AM",
    "permissions": {
        "companyPermissions": ["manage_company_settings"],
        "roles": [
            {
                "roleName": "Test Role",
                "roleId": "519dafcdba23dfaae7,
                "appGroup": [
                    {
                        "appGroupId": "241adcd25789fabcded",
                        "appGroupName": "Some Workspace",
                        "appGroupPermissions": ["basic_access", "publish_cards"],
                        "team": [
                            {
                                "teamId": "2519dafcdba238ae7",
                                "teamName": "Some Team",                  
                                "teamPermissions": ["export_user_data"]
                            }
                        ]
                    } 
                ]
            },
            {
                "roleName": "Another Test Role",
                "roleId": "23125dad23dfaae7,
                "appGroup": [
                    {
                        "appGroupId": "241adcd25adfabcded",
                        "appGroupName": "Production Workspace",
                        "appGroupPermissionSets": [
                            {
                                "appGroupPermissionSetName": "A Permission Set",
                                "appGroupPermissionSetId": "dfa385109bc38",
                                "permissions": ["basic_access","publish_cards"]
                            }
                        ]
                    } 
                ]
            }
        ],
        "appGroup": [
            {
                "appGroupId": "241adcd25789fabcded",
                "appGroupName": "Test Workspace",
                "appGroupPermissions": ["basic_access","send_campaigns_canvases"],
                "team": [
                    {
                         "teamId": "2519dafcdba238ae7",
                         "teamName": "Test Team",                  
                         "teamPermissions": ["admin"]
                    }
                ]
            } 
        ]
    }
}

エラー状態

このIDを持つユーザーがBrazeに存在しない場合、エンドポイントは次のように応答する：

HTTP/1.1 404 Not Found
Content-Type: text/html; charset=UTF-8

{
    "schemas": ["urn:ietf:params:scim:api:messages:2.0:Error"],
    "detail": "User not found",
    "status": 404
}

GitHub でこのページを編集

「このページはどの程度役に立ちましたか?」

POST:新しいダッシュボード・ユーザー・アカウントを作成する

SMS

GitHub でこのページを編集

New Stuff!