コンテンツにスキップ

このページはAIにより自動翻訳されており、不正確な内容が含まれている可能性があります。翻訳の誤りを報告するには、ページ右側の目次の下にあるフィードバックをご利用ください。

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

get

/scim/v2/Users/{id}

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

See me in Postman

重要

このエンドポイントにはカスタムSCIM連携が必要です。IDプロバイダー（IdP）連携（OktaまたはEntra ID）を設定している場合、このエンドポイントは使用できません。SCIMブリッジは1社につき1つのみ設定できます。

前提条件

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

レート制限

このエンドポイントには、1日あたり1会社あたり20,000リクエストのレート制限があります。このレート制限は、APIレート制限に記載されているように、/scim/v2/Users/ PUT、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-HERE

注

401レスポンスを受け取った場合は、SCIMトークン（REST APIキーではない）を使用していること、X-Request-OriginがサービスOriginと一致していること、およびIPアドレスがSCIM許可リストに含まれていることを確認してください。詳細については、自動ユーザープロビジョニングを参照してください。

リクエスト例

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' \

レスポンス

{
    "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": "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": "a1b2c3d4-e5f6-4a1b-8c2d-3e4f5a6b7c8d",
                         "teamName": "Test Team",
                         "teamPermissions": ["edit_campaigns","launch_campaigns","edit_canvases","launch_canvases"]
                    }
                ]
            }
        ]
    }
}

レスポンスパラメーター

パラメーター	データタイプ	説明
`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に該当するユーザーが存在しない場合、エンドポイントは以下を返します:

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!