Skip to content

リソースIDで既存のダッシュボードユーザーアカウントを検索する

get

/scim/v2/Users/{id}

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

See me in Postman

前提条件

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

レート制限

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

パスパラメーター

パラメーター 必須 データタイプ 説明
id 必須 文字列 ユーザーのリソースID。このパラメーターは、POST /scim/v2/Users/またはGET /scim/v2/Users?filter=userName eq "[email protected]"メソッドによって返されます。

リクエストパラメーター

1
2
3

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

リクエスト例

1
2
3
4

curl --location --request GET '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' \

レスポンス

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
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48

{
    "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": "2024 Nov 11, 4:20 PM",
    "createdAt": "2024 Nov 11, 4:20 PM",
    "permissions": {
        "companyPermissions": ["manage_company_settings"],
        "roles": [
            {
                "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": "241adcd25789fabcded",
                         "teamName": "Test Team",
                         "teamPermissions": ["admin"]
                    }
                ]
            }
        ]
    }
}

レスポンスパラメーター

パラメーター データタイプ 説明
schemas 文字列の配列 SCIMユーザースキーマ。
id 文字列 ユーザーのリソースID。
userName 文字列 ユーザーのメールアドレス。
name オブジェクト givenNameとfamilyNameを含みます。
department 文字列 ユーザーの部署（設定されている場合）。
createdAt 文字列 ユーザーアカウントが作成された日時。未設定の場合はN/Aを返します。それ以外の場合はYYYY Mon DD, H:MM AM/PMの形式で返されます。
lastSignInAt 文字列 ユーザーが最後にサインインした日時。ユーザーがサインインしたことがない場合はN/Aを返します。それ以外の場合はYYYY Mon DD, H:MM AM/PMの形式で返されます。
permissions オブジェクト ユーザーの会社、ワークスペース、チーム、およびロールの権限。権限オブジェクトを参照してください。

エラーステート

指定されたリソースidに該当するユーザーが存在しない場合、エンドポイントは以下を返します:

1
2
3
4
5
6
7
8

HTTP/1.1 404 Not Found
Content-Type: application/json

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