Skip to content

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

put

/scim/v2/Users/{id}

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

氏名や氏名、権限 (会社、ワークスペース、チームレベルでの権限設定用)、部署を更新できます。

セキュリティ上の理由から、このエンドポイントでは userName (メールアドレス) を更新することはできません。ユーザーの userName (メールアドレス) を変更したい場合は、サポートにお問い合わせください。

See me in Postman

前提条件

このエンドポイントを使用するには、SCIM トークンが必要です。詳しくは、「自動ユーザープロビジョニング」を参照してください。

レート制限

This endpoint has a rate limit of 5000 requests per day, per company. This rate limit is shared with the /scim/v2/Users/ GET, DELETE, and POST endpoints as documented in API rate limits.

パスパラメーター

パラメーター 必須 データ型 説明
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-REST-API-KEY

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31

{
    "schemas": ["urn:ietf:params:scim:schemas:core:2.0:User"],
    "name": {"name": {
        "givenName": "Test",
        "familyName": "User"
    },
    "department": "finance",
    "permissions": {
        "companyPermissions": ["manage_company_settings"],
        "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 オブジェクト 権限オブジェクトのドキュメントに記載されている権限オブジェクト。

リクエスト例

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27

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-API-KEY-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"],
        "appGroup": [
            {
                "appGroupName": "Test Workspace",
                "appGroupPermissions": ["basic_access","send_campaign_canvases"],
                "team": [
                    {
                         "teamName": "Test Team",                  
                         "teamPermissions": ["admin"]
                    }
                ]
            } 
        ]
    }
}

応答

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28

{
    "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"],
        "appGroup": [
            {
                "appGroupId": "241adcd25789fabcded",
                "appGroupName": "Test Workspace",
                "appGroupPermissions": ["basic_access","send_campaigns_canvases"],
                "team": [
                    {
                         "teamId": "2519dafcdba238ae7",
                         "teamName": "Test Team",                  
                         "teamPermissions": ["admin"]
                    }
                ]
            } 
        ]
    }
}

エラー状態

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

```json 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 でこのページを編集
「このページはどの程度役に立ちましたか?」
New Stuff!