このページはAIにより自動翻訳されており、不正確な内容が含まれている可能性があります。翻訳の誤りを報告するには、ページ右側の目次の下にあるフィードバックをご利用ください。
ダッシュボードユーザーアカウントの更新
put
/scim/v2/Users/{id}
このエンドポイントを使用して、SCIM
POSTメソッドによって返されるリソースidを指定し、既存のダッシュボードユーザーアカウントを更新します。
姓名、権限（会社、ワークスペース、チームレベルでの権限設定）、および部門を更新できます。
セキュリティ上の理由から、userName（メールアドレス）はこのエンドポイントでは更新できません。ユーザーのuserName（メールアドレス）を変更する場合は、サポートにお問い合わせください。
重要
このエンドポイントにはカスタムSCIM連携が必要です。IDプロバイダー（IdP）連携（OktaまたはEntra ID）を設定している場合、このエンドポイントは使用できません。SCIMブリッジは1社につき1つのみ設定できます。
前提条件
このエンドポイントを使用するには、SCIMトークンが必要です。X-Request-OriginヘッダーとしてサービスOriginを使用します。詳細については、自動ユーザープロビジョニングを参照してください。
レート制限
このエンドポイントには、1日あたり1会社あたり20,000リクエストのレート制限があります。このレート制限は、APIレート制限に記載されているように、/scim/v2/Users/ GET、DELETE、およびPOSTエンドポイントと共有されます。
パスパラメーター
| パラメーター | 必須 | データタイプ | 説明 |
|---|---|---|---|
id |
必須 | 文字列 | ユーザーのリソースID。このパラメーターは、POST /scim/v2/Users/またはGET /scim/v2/Users?filter=userName eq "[email protected]"メソッドによって返されます。 |
リクエスト本文
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": {
"givenName": "Test",
"familyName": "User"
},
"department": "finance",
"permissions": {
"companyPermissions": ["manage_company_settings"],
"roles": [
{
"roleName": "Test Role"
},
{
"roleId": "1f16c016-8e44-48f3-9fd7-2b8d5d70d9bd"
}
],
"appGroup": [
{
"appGroupName": "Test Workspace",
"appGroupPermissions": ["view_campaigns","view_canvases"],
"team": [
{
"teamName": "Test Team",
"teamPermissions": ["edit_campaigns","launch_campaigns","edit_canvases","launch_canvases"]
}
]
},
{
"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": "1f16c016-8e44-48f3-9fd7-2b8d5d70d9bd"
}
],
"appGroup": [
{
"appGroupName": "Test Workspace",
"appGroupPermissions": ["view_campaigns","view_canvases"],
"team": [
{
"teamName": "Test Team",
"teamPermissions": ["edit_campaigns","launch_campaigns","edit_canvases","launch_canvases"]
}
]
}
]
}
}
レスポンス
{
"schemas": ["urn:ietf:params:scim:schemas:core:2.0:User"],
"id": "dfa245b7-24195aec-887bb3ad-602b3340",
"userName": "[email protected]",
"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": "7c9e6679-7425-40de-944b-e07fc1f90ae7",
"appGroup": [
{
"appGroupId": "a1b2c3d4-e5f6-4a1b-8c2d-3e4f5a6b7c8d",
"appGroupName": "Some Workspace",
"appGroupPermissions": ["view_campaigns","view_canvases"],
"team": [
{
"teamId": "1f16c016-8e44-48f3-9fd7-2b8d5d70d9bd",
"teamName": "Some Team",
"teamPermissions": ["edit_campaigns","launch_campaigns","edit_canvases","launch_canvases"]
}
]
}
]
},
{
"roleName": "Another Test Role",
"roleId": "b2c3d4e5-f6a7-4b1c-9d2e-4f5a6b7c8d9e",
"appGroup": [
{
"appGroupId": "c3d4e5f6-a7b8-4c1d-8e2f-5a6b7c8d9e0f",
"appGroupName": "Production Workspace",
"appGroupPermissionSets": [
{
"appGroupPermissionSetName": "A Permission Set",
"appGroupPermissionSetId": "d4e5f6a7-b8c9-4d1e-9f2a-6b7c8d9e0f1a",
"permissions": ["view_campaigns","edit_campaigns","view_content_blocks"]
}
]
}
]
}
],
"appGroup": [
{
"appGroupId": "a1b2c3d4-e5f6-4a1b-8c2d-3e4f5a6b7c8d",
"appGroupName": "Test Workspace",
"appGroupPermissions": ["view_campaigns","view_canvases"],
"team": [
{
"teamId": "1f16c016-8e44-48f3-9fd7-2b8d5d70d9bd",
"teamName": "Test Team",
"teamPermissions": ["edit_campaigns","launch_campaigns","edit_canvases","launch_canvases"]
}
]
}
]
}
}
エラーステータス
この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
}
New Stuff!