Skip to content

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

post

/scim/v2/Users

このエンドポイントを使用して、メール、姓名、権限 (会社、ワークスペース、チームレベルでの権限設定) を指定して、新しいダッシュボードのユーザーアカウントを作成します。

See me in Postman

前提条件

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

レート制限

要求本文:

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
32

{
    "schemas": ["urn:ietf:params:scim:schemas:core:2.0:User"],
    "userName": "[email protected]",
    "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": ["basic_access","export_user_data"]
                    }
                ]
            },
            {
                "appGroupName": "Other Test Workspace",
                "appGroupPermissionSets": [
                    {
                        "appGroupPermissionSetName":  "Test Permission Set"
                    }
                ]
            }
        ]
    }
}

リクエストパラメーター

パラメータ 必須 データタイプ 説明
schemas 必須 文字列の配列 ユーザーオブジェクトに期待される SCIM 2.0 スキーマ名。
userName 必須 文字列 ユーザーのEメールアドレス。
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
28

curl --location --request POST 'https://rest.iad-01.braze.com/scim/v2/Users' \
--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"],
    "userName": "[email protected]",
    "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": ["basic_access","export_user_data"]
                    }
                ]
            } 
        ]
    }
}

応答

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": "[email protected]",
    "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": ["basic_access","export_user_data"]
                    }
                ]
            } 
        ]
    }
}

応答パラメーター

パラメータ データタイプ 説明
schemas 文字列の配列 ユーザーオブジェクトに期待される SCIM 2.0 スキーマ名。
userName 文字列 ユーザーのEメールアドレス。
name JSONオブジェクト このオブジェクトには、ユーザーの姓と名が含まれます。
department 文字列 部門文字列のドキュメントにある有効な部門文字列。
permissions JSONオブジェクト 権限オブジェクトのドキュメントで説明されている権限オブジェクト。
id 文字列 Brazeが生成するIDで、ユーザーアカウントの検索や管理に使用される。
lastSignInAt 文字列 最後にサインオンに成功した日付 (UTC 時間)。

エラー状態

このメールアドレスを持つユーザーがすでにBrazeに存在する場合、エンドポイントは次のように応答する：

1
2
3
4
5
6
7
8
9

HTTP/1.1 409 Conflict
Date: Tue, 10 Sep 2019 02:22:30 GMT
Content-Type: text/json;charset=UTF-8

{
  "schemas": ["urn:ietf:params:scim:api:messages:2.0:Error"],
  "detail": "User already exists in the database.",
  "status": 409
}
Github   GitHub でこのページを編集
「このページはどの程度役に立ちましたか?」
New Stuff!