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

post

/scim/v2/Users

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

前提条件

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

レート制限

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

リクエスト本文

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`	必須項目	文字列	ユーザーのメールアドレス。
`name`	必須項目	JSON オブジェクト	このオブジェクトには、ユーザーの名と姓が含まれています。
`department`	必須項目	文字列	部門文字列のドキュメントからの有効な部門文字列。
`permissions`	必須項目	JSON オブジェクト	permissions オブジェクトのドキュメントで説明されている permissions オブジェクト。

要求の例

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"]
                    }
                ]
            } 
        ]
    }
}

応答

{
    "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`	文字列	ユーザーのメールアドレス。
`name`	JSON オブジェクト	このオブジェクトには、ユーザーの名と姓が含まれています。
`department`	文字列	部門文字列のドキュメントからの有効な部門文字列。
`permissions`	JSON オブジェクト	permissions オブジェクトのドキュメントで説明されている permissions オブジェクト。
`id`	文字列	Brazeが生成するIDで、ユーザーアカウントの検索と管理に使用されます。
`lastSignInAt`	文字列	最後に成功したサインオンの日付 (UTC 時間)。